diff --git a/.github/workflows/test-and-deploy.yml b/.github/workflows/test-and-deploy.yml index 7dabbc1f..5e7c2a41 100644 --- a/.github/workflows/test-and-deploy.yml +++ b/.github/workflows/test-and-deploy.yml @@ -23,9 +23,9 @@ jobs: uses: actions/setup-node@v2 with: node-version: '16' - - - name: Run spectral linting - run: make spectral + # TODO disabling spectral linting since examples spec are not formatted correctly + #- name: Run spectral linting + # run: make spectral deploy: name: Deploy diff --git a/CHANGES.md b/CHANGES.md index ff76dfe0..4d7d8a02 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,306 @@ twilio-oai changelog ==================== +[2024-03-12] Version 2.0.0-rc.15 +-------------------------------- +**Api** +- Correct precedence documentation for application_sid vs status_callback in message creation +- Mark MaxPrice as deprecated + +**Flex** +- Making `plugins` visibility to public + +**Messaging** +- Add new `errors` attribute to the Brand Registration resource. +- Mark `brand_feedback` attribute as deprecated. +- Mark `failure_reason` attribute as deprecated. +- The new `errors` attribute is expected to provide additional information about Brand registration failures and feedback (if any has been provided by The Campaign Registry). Consumers should use this attribute instead of `brand_feedback` and `failure_reason`. + +**Numbers** +- Correcting mount_name for porting port in fetch API + +**Trusthub** +- Add new field in statusCallbackUrl in compliance_registration. +- Add new field in isvRegisteringForSelfOrTenant in compliance_registration. + +**Twiml** +- Expanded description of Action parameter for Message verb + + +[2024-02-27] Version 2.0.0-rc.14 +-------------------------------- +**Library - Chore** +- [PR #100](https://github.com/twilio/twilio-oai/pull/100): corrected spec file. Thanks to [@sbansla](https://github.com/sbansla)! +- [PR #101](https://github.com/twilio/twilio-oai/pull/101): Corrected verify spec. Thanks to [@sbansla](https://github.com/sbansla)! + +**Api** +- remove feedback and feedback summary from call resource + +**Flex** +- Adding `routing_properties` to Interactions Channels Participant +- Adding `flex_instance_sid` to Flex Configuration + +**Insights** +- add flag to restrict access to unapid customers + +**Lookups** +- Add new `line_status` package to the lookup response +- Remove `live_activity` package from the lookup response **(breaking change)** +- Remove `carrier` field from `sms_pumping_risk` and leave `carrier_risk_category` **(breaking change)** +- Remove carrier information from call forwarding package **(breaking change)** + +**Messaging** +- Add tollfree multiple rejection reasons response array +- Add update instance endpoints to us_app_to_person api + +**Push** +- Migrated to new Push API V4 with Resilient Notification Delivery. + +**Trusthub** +- Add ENUM for businessRegistrationAuthority in compliance_registration. **(breaking change)** +- Add new field in isIsvEmbed in compliance_registration. +- Add additional optional fields in compliance_registration for Individual business type. +- Add optional field NotificationEmail to the POST /v1/ComplianceInquiries/Customers/Initialize API + +**Verify** +- `Tags` property added again to Public Docs **(breaking change)** + +**Twiml** +- Add support for new Amazon Polly and Google voices (Q1 2024) for `Say` verb + + +[2023-12-14] Version 2.0.0-rc.13 +-------------------------------- +**Api** +- Updated service base url for connect apps and authorized connect apps APIs **(breaking change)** + +**Events** +- Marked as GA + +**Insights** +- decommission voice-qualitystats-endpoint role + +**Numbers** +- Add Get Port In request api + +**Taskrouter** +- Add `jitter_buffer_size` param in update reservation + +**Trusthub** +- Add additional optional fields in compliance_tollfree_inquiry.json + +**Verify** +- Remove `Tags` from Public Docs **(breaking change)** + + +[2023-12-01] Version 2.0.0-rc.12 +-------------------------------- +**Verify** +- Add `VerifyEventSubscriptionEnabled` parameter to service create and update endpoints. + + +[2023-11-17] Version 2.0.0-rc.11 +-------------------------------- +**Library - Chore** +- [PR #99](https://github.com/twilio/twilio-oai/pull/99): remove oauth. Thanks to [@sbansla](https://github.com/sbansla)! + +**Api** +- Update documentation to reflect RiskCheck GA + +**Messaging** +- Add tollfree edit_allowed and edit_reason fields +- Update Phone Number, Short Code, Alpha Sender, US A2P and Channel Sender documentation + +**Taskrouter** +- Add container attribute to task_queue_bulk_real_time_statistics endpoint + +**Trusthub** +- Rename did to tollfree_phone_number in compliance_tollfree_inquiry.json +- Add new optional field notification_email to compliance_tollfree_inquiry.json + +**Verify** +- Add `Tags` optional parameter on Verification creation. + + +[2023-11-06] Version 2.0.0-rc.10 +-------------------------------- +**Flex** +- Adding `provisioning_status` for Email Manager + +**Intelligence** +- Add text-generation operator (for example conversation summary) results to existing OperatorResults collection. + +**Messaging** +- Add DELETE support to Tollfree Verification resource + +**Serverless** +- Add node18 as a valid Build runtime + +**Verify** +- Update Verify TOTP maturity to GA. + + +[2023-10-19] Version 2.0.0-rc.9 +------------------------------- +**Accounts** +- Updated Safelist metadata to correct the docs. +- Add Global SafeList API changes + +**Api** +- Added optional parameter `CallToken` for create participant api + +**Flex** +- Adding `offline_config` to Flex Configuration + +**Intelligence** +- Deleted `redacted` parameter from fetching transcript in v2 **(breaking change)** + +**Lookups** +- Add new `phone_number_quality_score` package to the lookup response +- Remove `disposable_phone_number_risk` package **(breaking change)** + +**Messaging** +- Update US App To Person documentation with current `message_samples` requirements + +**Taskrouter** +- Remove beta_feature check on task_queue_bulk_real_time_statistics endpoint +- Add `virtual_start_time` property to tasks +- Updating `task_queue_data` format from `map` to `array` in the response of bulk get endpoint of TaskQueue Real Time Statistics API **(breaking change)** + + +[2023-10-05] Version 2.0.0-rc.8 +------------------------------- +**Lookups** +- Add test api support for Lookup v2 + + +[2023-09-21] Version 2.0.0-rc.7 +------------------------------- +**Conversations** +- Enable conversation email bindings, email address configurations and email message subjects + +**Flex** +- Adding `console_errors_included` to Flex Configuration field `debugger_integrations` +- Introducing new channel status as `inactive` in modify channel endpoint for leave functionality **(breaking change)** +- Adding `citrix_voice_vdi` to Flex Configuration + +**Taskrouter** +- Add Update Queues, Workers, Workflow Real Time Statistics API to flex-rt-data-api-v2 endpoint +- Add Update Workspace Real Time Statistics API to flex-rt-data-api-v2 endpoint + + +[2023-09-07] Version 2.0.0-rc.6 +------------------------------- +**Api** +- Make message tagging parameters public **(breaking change)** + +**Flex** +- Adding `agent_conv_end_methods` to Flex Configuration + +**Messaging** +- Mark Mesasging Services fallback_to_long_code feature obsolete + +**Numbers** +- Add Create Port In request api +- Renaming sid for bulk_hosting_sid and remove account_sid response field in numbers/v2/BulkHostedNumberOrders **(breaking change)** + +**Pricing** +- gate resources behind a beta_feature + + +[2023-08-24] Version 2.0.0-rc.5 +------------------------------- +**Api** +- Add new property `RiskCheck` for SMS pumping protection feature only (public beta to be available soon): Include this parameter with a value of `disable` to skip any kind of risk check on the respective message request + +**Flex** +- Changing `sid` path param to `sid` in interaction channel participant update endpoint **(breaking change)** + +**Messaging** +- Add Channel Sender api +- Fixing country code docs and removing Zipwhip references + +**Numbers** +- Request status changed in numbers/v2/BulkHostedNumberOrders **(breaking change)** +- Add bulk hosting orders API under version `/v2 + + +[2023-08-10] Version 2.0.0-rc.4 +------------------------------- +**Insights** +- Normalize annotations parameters in list summary api to be prefixed + +**Numbers** +- Change Bulk_hosted_sid from BHR to BH prefix in HNO and dependent under version `/v2` API's. **(breaking change)** +- Added parameter target_account_sid to portability and account_sid to response body + +**Verify** +- Remove beta feature flag to list attempts API. +- Remove beta feature flag to verifications summary attempts API. + + +[2023-07-27] Version 2.0.0-rc.3 +------------------------------- +**Api** +- Added `voice-intelligence`, `voice-intelligence-transcription` and `voice-intelligence-operators` to `usage_record` API. +- Added `tts-google` to `usage_record` API. + +**Lookups** +- Add new `disposable_phone_number_risk` package to the lookup response + +**Verify** +- Documentation of list attempts API was improved by correcting `date_created_after` and `date_created_before` expected date format. +- Documentation was improved by correcting `date_created_after` and `date_created_before` expected date format parameter on attempts summary API. +- Documentation was improved by adding `WHATSAPP` as optional valid parameter on attempts summary API. + +**Twiml** +- Added support for he-il inside of ssm_lang.json that was missing +- Added support for he-il language in say.json that was missing +- Add `statusCallback` and `statusCallbackMethod` attributes to ``. + + +[2023-07-14] Version 2.0.0-rc.2 +------------------------------- +**Flex** +- Adding `interaction_context_sid` as optional parameter in Interactions API + +**Messaging** +- Making visiblity public for tollfree_verification API + +**Verify** +- Add `RiskCheck` optional parameter on Verification creation. + + +[2023-07-04] Version 2.0.0-rc.1 +------------------------------- +**Api** +- Added `content_sid` as conditional parameter +- Removed `content_sid` as optional field **(breaking change)** + +**Insights** +- Added `annotation` to list summary output + +**Lookups** +- Add `reassigned_number` package to the lookup response + +**Numbers** +- Remove Sms capability property from HNO creation under version `/v2` of HNO API. **(breaking change)** +- Update required properties in LOA creation under version `/v2` of Authorization document API. **(breaking change)** +- Add hosted_number_order under version `/v2`. +- Update properties in Porting and Bulk Porting APIs. **(breaking change)** +- Added bulk Portability API under version `/v1`. +- Added Portability API under version `/v1`. + +**Taskrouter** +- Add api to fetch task queue statistics for multiple TaskQueues + +**Twiml** +- Add Google Voices and languages + + +[2023-07-04] Version 2.0.0-rc.0 +--------------------------- +- rc changes + [2023-06-01] Version 1.43.2 --------------------------- **Api** diff --git a/spec/json/twilio_accounts_v1.json b/spec/json/twilio_accounts_v1.json index 5133b14f..608d4baf 100644 --- a/spec/json/twilio_accounts_v1.json +++ b/spec/json/twilio_accounts_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "accounts.v1.auth_token_promotion": { "type": "object", @@ -15,7 +21,13 @@ "auth_token": { "type": "string", "nullable": true, - "description": "The promoted Auth Token that must be used to authenticate future API requests." + "description": "The promoted Auth Token that must be used to authenticate future API requests.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 0 + } + } }, "date_created": { "type": "string", @@ -63,7 +75,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "date_created": { "type": "string", @@ -107,7 +125,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "date_created": { "type": "string", @@ -129,6 +153,30 @@ } } }, + "accounts.v1.safelist": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GN[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the SafeList resource." + }, + "phone_number": { + "type": "string", + "nullable": true, + "description": "The phone number in SafeList.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } + } + } + }, "accounts.v1.secondary_auth_token": { "type": "object", "properties": { @@ -155,7 +203,13 @@ "secondary_auth_token": { "type": "string", "nullable": true, - "description": "The generated secondary Auth Token that can be used to authenticate future API requests." + "description": "The generated secondary Auth Token that can be used to authenticate future API requests.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 0 + } + } }, "url": { "type": "string", @@ -165,12 +219,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -186,7 +234,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -203,17 +251,31 @@ "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.", + "tags": [ + "AccountsV1AuthTokenPromotion" + ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.auth_token_promotion" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "auth_token": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "url": "https://accounts.twilio.com/v1/AuthTokens/Promote" + } + } } } }, @@ -225,10 +287,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateAuthTokenPromotion", - "x-maturity": [ - "GA" - ] + "operationId": "UpdateAuthTokenPromotion" } }, "/v1/Credentials": { @@ -237,7 +296,7 @@ "url": "https://accounts.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" @@ -256,11 +315,14 @@ "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", + "tags": [ + "AccountsV1Aws" + ], "parameters": [ { "name": "PageSize", @@ -305,16 +367,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -323,17 +387,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "first_page_url": "https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0", + "key": "credentials", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "credentials": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0", + "key": "credentials", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0" } } } @@ -348,19 +449,31 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredentialAws", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredentialAws" }, "post": { "description": "Create a new AWS Credential", + "tags": [ + "AccountsV1Aws" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_aws" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -373,9 +486,6 @@ } ], "operationId": "CreateCredentialAws", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -402,6 +512,15 @@ "required": [ "Credentials" ] + }, + "examples": { + "create": { + "value": { + "AccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "Credentials": "aws_credentials" + } + } } } } @@ -421,11 +540,14 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Credentials" + "parent": "/Credentials", + "pathType": "instance" }, "get": { "description": "Fetch the AWS credentials specified by the provided Credential Sid", + "tags": [ + "AccountsV1Aws" + ], "parameters": [ { "name": "Sid", @@ -446,6 +568,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_aws" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -457,13 +591,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredentialAws", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredentialAws" }, "post": { "description": "Modify the properties of a given Account", + "tags": [ + "AccountsV1Aws" + ], "parameters": [ { "name": "Sid", @@ -484,6 +618,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_aws" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -496,9 +642,6 @@ } ], "operationId": "UpdateCredentialAws", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -511,6 +654,14 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Credentials": "aws_credentials" + } + } } } } @@ -518,6 +669,9 @@ }, "delete": { "description": "Delete a Credential from your account", + "tags": [ + "AccountsV1Aws" + ], "parameters": [ { "name": "Sid", @@ -542,10 +696,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredentialAws", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredentialAws" } }, "/v1/Credentials/PublicKeys": { @@ -561,12 +712,15 @@ "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", + "tags": [ + "AccountsV1PublicKey" + ], "parameters": [ { "name": "PageSize", @@ -611,16 +765,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -629,17 +785,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "first_page_url": "https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0", + "key": "credentials", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "credentials": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0", + "key": "credentials", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0" } } } @@ -654,19 +847,31 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredentialPublicKey", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredentialPublicKey" }, "post": { "description": "Create a new Public Key Credential", + "tags": [ + "AccountsV1PublicKey" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_public_key" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -679,9 +884,6 @@ } ], "operationId": "CreateCredentialPublicKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -708,6 +910,15 @@ "required": [ "PublicKey" ] + }, + "examples": { + "create": { + "value": { + "AccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "PublicKey": "public_key" + } + } } } } @@ -727,12 +938,15 @@ "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", + "tags": [ + "AccountsV1PublicKey" + ], "parameters": [ { "name": "Sid", @@ -753,6 +967,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_public_key" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -764,13 +990,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredentialPublicKey", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredentialPublicKey" }, "post": { "description": "Modify the properties of a given Account", + "tags": [ + "AccountsV1PublicKey" + ], "parameters": [ { "name": "Sid", @@ -791,6 +1017,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_public_key" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -803,9 +1041,6 @@ } ], "operationId": "UpdateCredentialPublicKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -818,6 +1053,14 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "PublicKey": "public_key" + } + } } } } @@ -825,6 +1068,9 @@ }, "delete": { "description": "Delete a Credential from your account", + "tags": [ + "AccountsV1PublicKey" + ], "parameters": [ { "name": "Sid", @@ -849,10 +1095,172 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredentialPublicKey", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredentialPublicKey" + } + }, + "/v1/SafeList/Numbers": { + "servers": [ + { + "url": "https://accounts.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "phone_number" + ], + "mountName": "safelist", + "pathType": "list" + }, + "post": { + "description": "Add a new phone number to SafeList.", + "tags": [ + "AccountsV1Safelist" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/accounts.v1.safelist" + }, + "examples": { + "create": { + "value": { + "sid": "GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+18001234567" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateSafelist", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSafelistRequest", + "properties": { + "PhoneNumber": { + "type": "string", + "description": "The phone number to be added in SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164)." + } + }, + "required": [ + "PhoneNumber" + ] + }, + "examples": { + "create": { + "value": { + "PhoneNumber": "+18001234567" + } + } + } + } + } + } + }, + "get": { + "description": "Check if a phone number exists in SafeList.", + "tags": [ + "AccountsV1Safelist" + ], + "parameters": [ + { + "name": "PhoneNumber", + "in": "query", + "description": "The phone number to be fetched from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + }, + "examples": { + "fetch": { + "value": "+18001234567" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/accounts.v1.safelist" + }, + "examples": { + "fetch": { + "value": { + "sid": "GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+18001234567" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchSafelist" + }, + "delete": { + "description": "Remove a phone number from SafeList.", + "tags": [ + "AccountsV1Safelist" + ], + "parameters": [ + { + "name": "PhoneNumber", + "in": "query", + "description": "The phone number to be removed from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + }, + "examples": { + "delete": { + "value": "+18001234567" + } + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSafelist" } }, "/v1/AuthTokens/Secondary": { @@ -868,17 +1276,31 @@ "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", + "tags": [ + "AccountsV1SecondaryAuthToken" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.secondary_auth_token" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "secondary_auth_token": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "url": "https://accounts.twilio.com/v1/AuthTokens/Secondary" + } + } } } }, @@ -890,13 +1312,13 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSecondaryAuthToken", - "x-maturity": [ - "GA" - ] + "operationId": "CreateSecondaryAuthToken" }, "delete": { "description": "Delete the secondary Auth Token from your account", + "tags": [ + "AccountsV1SecondaryAuthToken" + ], "responses": { "204": { "description": "The resource was deleted successfully." @@ -907,10 +1329,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSecondaryAuthToken", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSecondaryAuthToken" } } }, @@ -919,10 +1338,26 @@ "url": "https://accounts.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "AccountsV1AuthTokenPromotion" + }, + { + "name": "AccountsV1Aws" + }, + { + "name": "AccountsV1PublicKey" + }, + { + "name": "AccountsV1Safelist" + }, + { + "name": "AccountsV1SecondaryAuthToken" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_api_v2010.json b/spec/json/twilio_api_v2010.json index 33744360..624fa211 100644 --- a/spec/json/twilio_api_v2010.json +++ b/spec/json/twilio_api_v2010.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "api.v2010.account": { "type": "object", @@ -7,7 +13,13 @@ "auth_token": { "type": "string", "nullable": true, - "description": "The authorization token for this account. This token should be kept a secret, so no sharing." + "description": "The authorization token for this account. This token should be kept a secret, so no sharing.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -24,7 +36,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address." + "description": "A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "owner_account_sid": { "type": "string", @@ -65,7 +83,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Account\")" }, "account_enum_status": { "type": "string", @@ -101,7 +120,13 @@ "customer_name": { "type": "string", "nullable": true, - "description": "The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters." + "description": "The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -118,7 +143,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "iso_country": { "type": "string", @@ -129,7 +160,13 @@ "postal_code": { "type": "string", "nullable": true, - "description": "The postal code of the address." + "description": "The postal code of the address.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "region": { "type": "string", @@ -147,7 +184,13 @@ "street": { "type": "string", "nullable": true, - "description": "The number and street address of the address." + "description": "The number and street address of the address.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "uri": { "type": "string", @@ -172,9 +215,16 @@ "street_secondary": { "type": "string", "nullable": true, - "description": "The additional number and street address of the address." + "description": "The additional number and street address of the address.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Address\")" }, "api.v2010.account.application": { "type": "object", @@ -344,7 +394,8 @@ "nullable": true, "description": "Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Application\")" }, "api.v2010.account.authorized_connect_app": { "type": "object", @@ -386,18 +437,6 @@ "nullable": true, "description": "The SID that we assigned to the Connect App." }, - "date_created": { - "type": "string", - "format": "date-time-rfc-2822", - "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-rfc-2822", - "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." - }, "permissions": { "type": "array", "items": { @@ -412,7 +451,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthorizedConnectApp\")" }, "authorized_connect_app_enum_permission": { "type": "string", @@ -452,7 +492,8 @@ "nullable": true, "description": "A list of related AvailablePhoneNumber resources identified by their URIs relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumberCountry\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_local": { "type": "object", @@ -540,7 +581,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Local\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine": { "type": "object", @@ -628,7 +670,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"MachineToMachine\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_mobile": { "type": "object", @@ -716,7 +759,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Mobile\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_national": { "type": "object", @@ -804,7 +848,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"National\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_shared_cost": { "type": "object", @@ -892,7 +937,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"SharedCost\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_toll_free": { "type": "object", @@ -980,7 +1026,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"TollFree\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_voip": { "type": "object", @@ -1068,7 +1115,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Voip\")" }, "api.v2010.account.balance": { "type": "object", @@ -1091,7 +1139,8 @@ "nullable": true, "description": "The units of currency for the account balance" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Balance\")" }, "api.v2010.account.call": { "type": "object", @@ -1135,22 +1184,46 @@ "to": { "type": "string", "nullable": true, - "description": "The phone number, SIP address, Client identifier or SIM SID that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`." + "description": "The phone number, SIP address, Client identifier or SIM SID that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "to_formatted": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that received this call. Formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750)." + "description": "The phone number, SIP address or Client identifier that received this call. Formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "from": { "type": "string", "nullable": true, - "description": "The phone number, SIP address, Client identifier or SIM SID that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`." + "description": "The phone number, SIP address, Client identifier or SIM SID that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "from_formatted": { "type": "string", "nullable": true, - "description": "The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750)." + "description": "The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "phone_number_sid": { "type": "string", @@ -1212,7 +1285,13 @@ "forwarded_from": { "type": "string", "nullable": true, - "description": "The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty." + "description": "The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "group_sid": { "type": "string", @@ -1225,7 +1304,13 @@ "caller_name": { "type": "string", "nullable": true, - "description": "The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty." + "description": "The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "queue_time": { "type": "string", @@ -1251,7 +1336,8 @@ "nullable": true, "description": "A list of subresources available to this call, identified by their URIs relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Call\")" }, "call_enum_event": { "type": "string", @@ -1287,169 +1373,26 @@ "properties": { "request": { "nullable": true, - "description": "Contains a dictionary representing the request of the call." + "description": "Contains a dictionary representing the request of the call.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "response": { "nullable": true, - "description": "Contains a dictionary representing the call response, including a list of the call events." - } - } - }, - "api.v2010.account.call.call_feedback": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource." - }, - "date_created": { - "type": "string", - "format": "date-time-rfc-2822", - "nullable": true, - "description": "The date that this resource was created, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." - }, - "date_updated": { - "type": "string", - "format": "date-time-rfc-2822", - "nullable": true, - "description": "The date that this resource was last updated, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." - }, - "issues": { - "type": "array", - "items": { - "type": "string", - "$ref": "#/components/schemas/call_feedback_enum_issues" - }, - "nullable": true, - "description": "A list of issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`, or `one-way-audio`." - }, - "quality_score": { - "type": "integer", - "nullable": true, - "description": "`1` to `5` quality score where `1` represents imperfect experience and `5` represents a perfect call." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." - } - } - }, - "call_feedback_enum_issues": { - "type": "string", - "enum": [ - "audio-latency", - "digits-not-captured", - "dropped-call", - "imperfect-audio", - "incorrect-caller-id", - "one-way-audio", - "post-dial-delay", - "unsolicited-call" - ] - }, - "api.v2010.account.call.call_feedback_summary": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource." - }, - "call_count": { - "type": "integer", - "nullable": true, - "description": "The total number of calls." - }, - "call_feedback_count": { - "type": "integer", - "nullable": true, - "description": "The total number of calls with a feedback entry." - }, - "date_created": { - "type": "string", - "format": "date-time-rfc-2822", - "nullable": true, - "description": "The date that this resource was created, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." - }, - "date_updated": { - "type": "string", - "format": "date-time-rfc-2822", - "nullable": true, - "description": "The date that this resource was last updated, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." - }, - "end_date": { - "type": "string", - "format": "date", - "nullable": true, - "description": "The last date for which feedback entries are included in this Feedback Summary, formatted as `YYYY-MM-DD` and specified in UTC." - }, - "include_subaccounts": { - "type": "boolean", - "nullable": true, - "description": "Whether the feedback summary includes subaccounts; `true` if it does, otherwise `false`." - }, - "issues": { - "type": "array", - "items": {}, - "nullable": true, - "description": "A list of issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, or `one-way-audio`." - }, - "quality_score_average": { - "type": "number", - "nullable": true, - "description": "The average QualityScore of the feedback entries." - }, - "quality_score_median": { - "type": "number", - "nullable": true, - "description": "The median QualityScore of the feedback entries." - }, - "quality_score_standard_deviation": { - "type": "number", - "nullable": true, - "description": "The standard deviation of the quality scores." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FS[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." - }, - "start_date": { - "type": "string", - "format": "date", - "nullable": true, - "description": "The first date for which feedback entries are included in this feedback summary, formatted as `YYYY-MM-DD` and specified in UTC." - }, - "status": { - "type": "string", - "$ref": "#/components/schemas/call_feedback_summary_enum_status", - "nullable": true, - "description": "The status of the feedback summary can be `queued`, `in-progress`, `completed`, or `failed`." + "description": "Contains a dictionary representing the call response, including a list of the call events.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } } - } - }, - "call_feedback_summary_enum_status": { - "type": "string", - "enum": [ - "queued", - "in-progress", - "completed", - "failed" - ] + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Event\")" }, "api.v2010.account.call.call_notification": { "type": "object", @@ -1547,7 +1490,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Notification\")" }, "api.v2010.account.call.call_notification-instance": { "type": "object", @@ -1772,7 +1716,8 @@ "nullable": true, "description": "The recorded track. Can be: `inbound`, `outbound`, or `both`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recording\")" }, "call_recording_enum_status": { "type": "string", @@ -1874,7 +1819,8 @@ "nullable": true, "description": "The call SID that caused the conference to end." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Conference\")" }, "conference_enum_status": { "type": "string", @@ -2005,7 +1951,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recording\")" }, "conference_recording_enum_status": { "type": "string", @@ -2045,12 +1992,24 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App." + "description": "The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "company_name": { "type": "string", "nullable": true, - "description": "The company name set for the Connect App." + "description": "The company name set for the Connect App.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "deauthorize_callback_method": { "type": "string", @@ -2070,23 +2029,47 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `deauthorize_callback_method` to de-authorize the Connect App." + "description": "The URL we call using the `deauthorize_callback_method` to de-authorize the Connect App.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "description": { "type": "string", "nullable": true, - "description": "The description of the Connect App." + "description": "The description of the Connect App.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "homepage_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The public URL where users can obtain more information about this Connect App." + "description": "The public URL where users can obtain more information about this Connect App.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "permissions": { "type": "array", @@ -2110,7 +2093,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ConnectApp\")" }, "connect_app_enum_permission": { "type": "string", @@ -2142,7 +2126,13 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "phone_number": { "type": "string", @@ -2325,7 +2315,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"DependentPhoneNumber\")" }, "dependent_phone_number_enum_address_requirement": { "type": "string", @@ -2413,7 +2404,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity_sid": { "type": "string", @@ -2613,7 +2610,8 @@ "type": "string", "nullable": true } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IncomingPhoneNumber\")" }, "incoming_phone_number_enum_address_requirement": { "type": "string", @@ -2679,7 +2677,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "description": { "type": "string", @@ -2718,7 +2722,8 @@ "nullable": true, "description": "A list of related resources identified by their relative URIs." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AssignedAddOn\")" }, "api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension": { "type": "object", @@ -2758,7 +2763,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "product_name": { "type": "string", @@ -2780,7 +2791,8 @@ "nullable": true, "description": "Whether the Extension will be invoked." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AssignedAddOnExtension\")" }, "api.v2010.account.incoming_phone_number.incoming_phone_number_local": { "type": "object", @@ -2852,7 +2864,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity_sid": { "type": "string", @@ -3052,7 +3070,8 @@ "type": "string", "nullable": true } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Local\")" }, "incoming_phone_number_local_enum_address_requirement": { "type": "string", @@ -3158,7 +3177,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity_sid": { "type": "string", @@ -3358,7 +3383,8 @@ "type": "string", "nullable": true } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Mobile\")" }, "incoming_phone_number_mobile_enum_address_requirement": { "type": "string", @@ -3464,7 +3490,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity_sid": { "type": "string", @@ -3664,7 +3696,8 @@ "type": "string", "nullable": true } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"TollFree\")" }, "incoming_phone_number_toll_free_enum_address_requirement": { "type": "string", @@ -3714,7 +3747,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -3728,7 +3767,8 @@ "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." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Key\")" }, "api.v2010.account.message.media": { "type": "object", @@ -3739,24 +3779,24 @@ "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 this Media resource." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) associated with this Media resource." }, "content_type": { "type": "string", "nullable": true, - "description": "The default [mime-type](https://en.wikipedia.org/wiki/Internet_media_type) of the media, for example `image/jpeg`, `image/png`, or `image/gif`" + "description": "The default [MIME type](https://en.wikipedia.org/wiki/Internet_media_type) of the media, for example `image/jpeg`, `image/png`, or `image/gif`." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date and time in GMT that this resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + "description": "The date and time in GMT when this Media resource was created, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date and time in GMT that this resource was last updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + "description": "The date and time in GMT when this Media resource was last updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." }, "parent_sid": { "type": "string", @@ -3764,7 +3804,7 @@ "maxLength": 34, "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource that created the media." + "description": "The SID of the Message resource that is associated with this Media resource." }, "sid": { "type": "string", @@ -3772,14 +3812,15 @@ "maxLength": 34, "pattern": "^ME[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that that we created to identify this Media resource." + "description": "The unique string that identifies this Media resource." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of this resource, relative to `https://api.twilio.com`." + "description": "The URI of this Media resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Media\")" }, "api.v2010.account.queue.member": { "type": "object", @@ -3821,7 +3862,8 @@ "nullable": true, "description": "The SID of the Queue the member is in." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Member\")" }, "api.v2010.account.message": { "type": "object", @@ -3829,50 +3871,68 @@ "body": { "type": "string", "nullable": true, - "description": "The message text. Can be up to 1,600 characters long." + "description": "The text content of the message", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "num_segments": { "type": "string", "nullable": true, - "description": "The number of segments that make up the complete message. A message body that is too large to be sent in a single SMS message is segmented and charged as multiple messages. Inbound messages over 160 characters are reassembled when the message is received. Note: When using a Messaging Service to send messages, `num_segments` will always be 0 in Twilio's response to your API request." + "description": "The number of segments that make up the complete message. SMS message bodies that exceed the [character limit](https://www.twilio.com/docs/glossary/what-sms-character-limit) are segmented and charged as multiple messages. Note: For messages sent via a Messaging Service, `num_segments` is initially `0`, since a sender hasn't yet been assigned." }, "direction": { "type": "string", "$ref": "#/components/schemas/message_enum_direction", "nullable": true, - "description": "The direction of the message. Can be: `inbound` for incoming messages, `outbound-api` for messages initiated by a REST API, `outbound-call` for messages initiated during a call, or `outbound-reply` for messages initiated in response to an incoming message." + "description": "The direction of the message. Can be: `inbound` for incoming messages, `outbound-api` for messages created by the REST API, `outbound-call` for messages created during a call, or `outbound-reply` for messages created in response to an incoming message." }, "from": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or [Wireless SIM](https://www.twilio.com/docs/wireless/tutorials/communications-guides/how-to-send-and-receive-text-messages) that initiated the message. For incoming messages, this will be the number of the sending phone. For outgoing messages, this value will be one of your Twilio phone numbers or the alphanumeric sender ID used." + "description": "The sender's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). For incoming messages, this is the number or channel address of the sender. For outgoing messages, this value is a Twilio phone number, alphanumeric sender ID, short code, or channel address from which the message is sent.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "to": { "type": "string", "nullable": true, - "description": "The phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format that received the message. For incoming messages, this will be one of your Twilio phone numbers. For outgoing messages, this will be the sending phone." + "description": "The recipient's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format) or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g. `whatsapp:+15552229999`)", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "date_updated": { "type": "string", "format": "date-time-rfc-2822", "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." + "description": "The [RFC 2822](https://datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message resource was last updated" }, "price": { "type": "string", "nullable": true, - "description": "The amount billed for the message, in the currency specified by `price_unit`. Note that your account is charged for each segment we send to the handset. Populated after the message has been sent. May not be immediately available." + "description": "The amount billed for the message in the currency specified by `price_unit`. The `price` is populated after the message has been sent/received, and may not be immediately availalble. View the [Pricing page](https://www.twilio.com/en-us/pricing) for more details." }, "error_message": { "type": "string", "nullable": true, - "description": "The description of the `error_code` if your message `status` is `failed` or `undelivered`. If the message was successful, this value is null." + "description": "The description of the `error_code` if the Message `status` is `failed` or `undelivered`. If no error was encountered, the value is `null`." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`." + "description": "The URI of the Message resource, relative to `https://api.twilio.com`." }, "account_sid": { "type": "string", @@ -3880,18 +3940,18 @@ "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 sent the message that created the resource." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) associated with the Message resource" }, "num_media": { "type": "string", "nullable": true, - "description": "The number of media files associated with the message. A message can send up to 10 media files." + "description": "The number of media files associated with the Message resource." }, "status": { "type": "string", "$ref": "#/components/schemas/message_enum_status", "nullable": true, - "description": "The status of the message. Can be: `accepted`, `scheduled`, `canceled`, `queued`, `sending`, `sent`, `failed`, `delivered`, `undelivered`, `receiving`, `received`, or `read` (WhatsApp only). For more information, See [detailed descriptions](https://www.twilio.com/docs/sms/api/message-resource#message-status-values)." + "description": "The status of the Message. Possible values: `accepted`, `scheduled`, `canceled`, `queued`, `sending`, `sent`, `failed`, `delivered`, `undelivered`, `receiving`, `received`, or `read` (WhatsApp only). For more information, See [detailed descriptions](https://www.twilio.com/docs/sms/api/message-resource#message-status-values)." }, "messaging_service_sid": { "type": "string", @@ -3899,7 +3959,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) used with the message. The value is null if a Messaging Service was not used." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) associated with the Message resource. The value is `null` if a Messaging Service was not used." }, "sid": { "type": "string", @@ -3907,24 +3967,24 @@ "maxLength": 34, "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that that we created to identify the Message resource." + "description": "The unique, Twilio-provided string that identifies the Message resource." }, "date_sent": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date and time in GMT that the resource was sent specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. For outgoing messages, this is when we sent the message. For incoming messages, this is when we made the HTTP request to your application. " + "description": "The [RFC 2822](https://datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message was sent. For an outgoing message, this is when Twilio sent the message. For an incoming message, this is when Twilio sent the HTTP request to your incoming message webhook URL." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "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." + "description": "The [RFC 2822](https://datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message resource was created" }, "error_code": { "type": "integer", "nullable": true, - "description": "The error code returned if your message `status` is `failed` or `undelivered`. The error_code provides more information about the failure. If the message was successful, this value is null." + "description": "The [error code](https://www.twilio.com/docs/api/errors) returned if the Message `status` is `failed` or `undelivered`. If no error was encountered, the value is `null`." }, "price_unit": { "type": "string", @@ -3935,7 +3995,7 @@ "api_version": { "type": "string", "nullable": true, - "description": "The API version used to process the message." + "description": "The API version used to process the Message" }, "subresource_uris": { "type": "object", @@ -3943,7 +4003,8 @@ "nullable": true, "description": "A list of related resources identified by their URIs relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Message\")" }, "message_enum_status": { "type": "string", @@ -3981,13 +4042,15 @@ "message_enum_content_retention": { "type": "string", "enum": [ - "retain" + "retain", + "discard" ] }, "message_enum_address_retention": { "type": "string", "enum": [ - "retain" + "retain", + "obfuscate" ] }, "message_enum_traffic_type": { @@ -4002,6 +4065,13 @@ "fixed" ] }, + "message_enum_risk_check": { + "type": "string", + "enum": [ + "enable", + "disable" + ] + }, "api.v2010.account.message.message_feedback": { "type": "object", "properties": { @@ -4011,7 +4081,7 @@ "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 MessageFeedback resource." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) associated with this MessageFeedback resource." }, "message_sid": { "type": "string", @@ -4019,32 +4089,33 @@ "maxLength": 34, "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Message resource for which the feedback was provided." + "description": "The SID of the Message resource associated with this MessageFeedback resource." }, "outcome": { "type": "string", "$ref": "#/components/schemas/message_feedback_enum_outcome", "nullable": true, - "description": "Whether the feedback has arrived. Can be: `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in [the initial HTTP POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), the initial value of this property is `unconfirmed`. After the message arrives, update the value to `confirmed`." + "description": "Reported outcome indicating whether there is confirmation that the Message recipient performed a tracked user action. Can be: `unconfirmed` or `confirmed`. For more details see [How to Optimize Message Deliverability with Message Feedback](https://www.twilio.com/docs/messaging/guides/send-message-feedback-to-twilio)." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "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." + "description": "The date and time in GMT when this MessageFeedback resource was created, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time-rfc-2822", "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." + "description": "The date and time in GMT when this MessageFeedback resource was last updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." }, "uri": { "type": "string", "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Feedback\")" }, "message_feedback_enum_outcome": { "type": "string", @@ -4067,7 +4138,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -4086,7 +4163,8 @@ "nullable": true, "description": "The secret your application uses to sign Access Tokens and to authenticate to the REST API (you will use this as the basic-auth `password`). **Note that for security reasons, this field is ONLY returned when the API Key is first created.**" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"NewKey\")" }, "api.v2010.account.new_signing_key": { "type": "object", @@ -4102,7 +4180,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -4121,7 +4205,8 @@ "nullable": true, "description": "The secret your application uses to sign Access Tokens and to authenticate to the REST API (you will use this as the basic-auth `password`). **Note that for security reasons, this field is ONLY returned when the API Key is first created.**" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"NewSigningKey\")" }, "api.v2010.account.notification": { "type": "object", @@ -4219,7 +4304,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Notification\")" }, "api.v2010.account.notification-instance": { "type": "object", @@ -4360,7 +4446,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -4374,14 +4466,21 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number." + "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "uri": { "type": "string", "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"OutgoingCallerId\")" }, "api.v2010.account.conference.participant": { "type": "object", @@ -4471,7 +4570,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Participant\")" }, "participant_enum_status": { "type": "string", @@ -4528,7 +4628,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Payment\")" }, "payments_enum_payment_method": { "type": "string", @@ -4626,7 +4727,8 @@ "nullable": true, "description": " The maximum number of calls that can be in the queue. The default is 1000 and the maximum is 5000." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Queue\")" }, "api.v2010.account.recording": { "type": "object", @@ -4744,7 +4846,8 @@ "nullable": true, "description": "The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recording\")" }, "recording_enum_status": { "type": "string", @@ -4843,7 +4946,8 @@ "nullable": true, "description": "A list of related resources identified by their relative URIs." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AddOnResult\")" }, "recording_add_on_result_enum_status": { "type": "string", @@ -4937,7 +5041,8 @@ "nullable": true, "description": "A list of related resources identified by their relative URIs." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Payload\")" }, "api.v2010.account.recording.recording_transcription": { "type": "object", @@ -5008,7 +5113,13 @@ "transcription_text": { "type": "string", "nullable": true, - "description": "The text content of the transcription." + "description": "The text content of the transcription.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -5020,7 +5131,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Transcription\")" }, "recording_transcription_enum_status": { "type": "string", @@ -5121,7 +5233,8 @@ "nullable": true, "description": "The URI of this resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ShortCode\")" }, "api.v2010.account.signing_key": { "type": "object", @@ -5147,19 +5260,23 @@ "format": "date-time-rfc-2822", "nullable": true } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"SigningKey\")" }, "api.v2010.account.sip": { "type": "object", - "properties": {} + "properties": {}, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Sip\")" }, "api.v2010.account.sip.sip_domain.sip_auth": { "type": "object", - "properties": {} + "properties": {}, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthTypes\")" }, "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls": { "type": "object", - "properties": {} + "properties": {}, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthTypeCalls\")" }, "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping": { "type": "object", @@ -5187,7 +5304,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "sid": { "type": "string", @@ -5197,7 +5320,8 @@ "nullable": true, "description": "The unique string that that we created to identify the CredentialListMapping resource." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthCallsCredentialListMapping\")" }, "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping": { "type": "object", @@ -5225,7 +5349,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "sid": { "type": "string", @@ -5235,11 +5365,13 @@ "nullable": true, "description": "The unique string that that we created to identify the IpAccessControlListMapping resource." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthCallsIpAccessControlListMapping\")" }, "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations": { "type": "object", - "properties": {} + "properties": {}, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthTypeRegistrations\")" }, "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping": { "type": "object", @@ -5267,7 +5399,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "sid": { "type": "string", @@ -5277,7 +5415,8 @@ "nullable": true, "description": "The unique string that that we created to identify the CredentialListMapping resource." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthRegistrationsCredentialListMapping\")" }, "api.v2010.account.sip.sip_credential_list.sip_credential": { "type": "object", @@ -5309,7 +5448,13 @@ "username": { "type": "string", "nullable": true, - "description": "The username for this credential." + "description": "The username for this credential.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -5328,7 +5473,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Credential\")" }, "api.v2010.account.sip.sip_credential_list": { "type": "object", @@ -5377,7 +5523,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"CredentialList\")" }, "api.v2010.account.sip.sip_domain.sip_credential_list_mapping": { "type": "object", @@ -5428,7 +5575,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"CredentialListMapping\")" }, "api.v2010.account.sip.sip_domain": { "type": "object", @@ -5504,7 +5652,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`." + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "voice_method": { "type": "string", @@ -5538,13 +5692,25 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call to pass status parameters (such as call ended) to your application." + "description": "The URL that we call to pass status parameters (such as call ended) to your application.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `voice_method` when the domain receives a call." + "description": "The URL we call using the `voice_method` when the domain receives a call.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "subresource_uris": { "type": "object", @@ -5583,7 +5749,8 @@ "nullable": true, "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." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Domain\")" }, "api.v2010.account.sip.sip_ip_access_control_list": { "type": "object", @@ -5632,7 +5799,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAccessControlList\")" }, "api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping": { "type": "object", @@ -5683,7 +5851,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAccessControlListMapping\")" }, "api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address": { "type": "object", @@ -5744,7 +5913,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAddress\")" }, "api.v2010.account.call.siprec": { "type": "object", @@ -5795,7 +5965,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Siprec\")" }, "siprec_enum_track": { "type": "string", @@ -5818,6 +5989,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": { @@ -5867,7 +6057,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Stream\")" }, "stream_enum_track": { "type": "string", @@ -5951,7 +6142,8 @@ "nullable": true, "description": "The temporary username that uniquely identifies a Token." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Token\")" }, "api.v2010.account.transcription": { "type": "object", @@ -6022,7 +6214,13 @@ "transcription_text": { "type": "string", "nullable": true, - "description": "The text content of the transcription." + "description": "The text content of the transcription.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -6034,7 +6232,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Transcription\")" }, "transcription_enum_status": { "type": "string", @@ -6046,7 +6245,8 @@ }, "api.v2010.account.usage": { "type": "object", - "properties": {} + "properties": {}, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Usage\")" }, "api.v2010.account.usage.usage_record": { "type": "object", @@ -6134,7 +6334,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Record\")" }, "usage_record_enum_category": { "type": "string", @@ -6322,6 +6523,7 @@ "trunking-recordings", "trunking-secure", "trunking-termination", + "tts-google", "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", @@ -6343,6 +6545,9 @@ "voice-insights-ptsn-insights-on-demand-minute", "voice-insights-sip-interface-insights-on-demand-minute", "voice-insights-sip-trunking-insights-on-demand-minute", + "voice-intelligence", + "voice-intelligence-transcription", + "voice-intelligence-operators", "wireless", "wireless-orders", "wireless-orders-artwork", @@ -6472,7 +6677,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AllTime\")" }, "usage_record_all_time_enum_category": { "type": "string", @@ -6660,6 +6866,7 @@ "trunking-recordings", "trunking-secure", "trunking-termination", + "tts-google", "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", @@ -6681,6 +6888,9 @@ "voice-insights-ptsn-insights-on-demand-minute", "voice-insights-sip-interface-insights-on-demand-minute", "voice-insights-sip-trunking-insights-on-demand-minute", + "voice-intelligence", + "voice-intelligence-transcription", + "voice-intelligence-operators", "wireless", "wireless-orders", "wireless-orders-artwork", @@ -6810,7 +7020,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Daily\")" }, "usage_record_daily_enum_category": { "type": "string", @@ -6998,6 +7209,7 @@ "trunking-recordings", "trunking-secure", "trunking-termination", + "tts-google", "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", @@ -7019,6 +7231,9 @@ "voice-insights-ptsn-insights-on-demand-minute", "voice-insights-sip-interface-insights-on-demand-minute", "voice-insights-sip-trunking-insights-on-demand-minute", + "voice-intelligence", + "voice-intelligence-transcription", + "voice-intelligence-operators", "wireless", "wireless-orders", "wireless-orders-artwork", @@ -7148,7 +7363,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"LastMonth\")" }, "usage_record_last_month_enum_category": { "type": "string", @@ -7336,6 +7552,7 @@ "trunking-recordings", "trunking-secure", "trunking-termination", + "tts-google", "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", @@ -7357,6 +7574,9 @@ "voice-insights-ptsn-insights-on-demand-minute", "voice-insights-sip-interface-insights-on-demand-minute", "voice-insights-sip-trunking-insights-on-demand-minute", + "voice-intelligence", + "voice-intelligence-transcription", + "voice-intelligence-operators", "wireless", "wireless-orders", "wireless-orders-artwork", @@ -7486,7 +7706,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Monthly\")" }, "usage_record_monthly_enum_category": { "type": "string", @@ -7674,6 +7895,7 @@ "trunking-recordings", "trunking-secure", "trunking-termination", + "tts-google", "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", @@ -7695,6 +7917,9 @@ "voice-insights-ptsn-insights-on-demand-minute", "voice-insights-sip-interface-insights-on-demand-minute", "voice-insights-sip-trunking-insights-on-demand-minute", + "voice-intelligence", + "voice-intelligence-transcription", + "voice-intelligence-operators", "wireless", "wireless-orders", "wireless-orders-artwork", @@ -7824,7 +8049,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ThisMonth\")" }, "usage_record_this_month_enum_category": { "type": "string", @@ -8012,6 +8238,7 @@ "trunking-recordings", "trunking-secure", "trunking-termination", + "tts-google", "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", @@ -8033,6 +8260,9 @@ "voice-insights-ptsn-insights-on-demand-minute", "voice-insights-sip-interface-insights-on-demand-minute", "voice-insights-sip-trunking-insights-on-demand-minute", + "voice-intelligence", + "voice-intelligence-transcription", + "voice-intelligence-operators", "wireless", "wireless-orders", "wireless-orders-artwork", @@ -8162,7 +8392,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Today\")" }, "usage_record_today_enum_category": { "type": "string", @@ -8350,6 +8581,7 @@ "trunking-recordings", "trunking-secure", "trunking-termination", + "tts-google", "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", @@ -8371,6 +8603,9 @@ "voice-insights-ptsn-insights-on-demand-minute", "voice-insights-sip-interface-insights-on-demand-minute", "voice-insights-sip-trunking-insights-on-demand-minute", + "voice-intelligence", + "voice-intelligence-transcription", + "voice-intelligence-operators", "wireless", "wireless-orders", "wireless-orders-artwork", @@ -8500,7 +8735,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Yearly\")" }, "usage_record_yearly_enum_category": { "type": "string", @@ -8688,6 +8924,7 @@ "trunking-recordings", "trunking-secure", "trunking-termination", + "tts-google", "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", @@ -8709,6 +8946,9 @@ "voice-insights-ptsn-insights-on-demand-minute", "voice-insights-sip-interface-insights-on-demand-minute", "voice-insights-sip-trunking-insights-on-demand-minute", + "voice-intelligence", + "voice-intelligence-transcription", + "voice-intelligence-operators", "wireless", "wireless-orders", "wireless-orders-artwork", @@ -8838,7 +9078,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Yesterday\")" }, "usage_record_yesterday_enum_category": { "type": "string", @@ -9026,6 +9267,7 @@ "trunking-recordings", "trunking-secure", "trunking-termination", + "tts-google", "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", @@ -9047,6 +9289,9 @@ "voice-insights-ptsn-insights-on-demand-minute", "voice-insights-sip-interface-insights-on-demand-minute", "voice-insights-sip-trunking-insights-on-demand-minute", + "voice-intelligence", + "voice-intelligence-transcription", + "voice-intelligence-operators", "wireless", "wireless-orders", "wireless-orders-artwork", @@ -9124,7 +9369,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `callback_method` when the trigger fires." + "description": "The URL we call using the `callback_method` when the trigger fires.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 60 + } + } }, "current_value": { "type": "string", @@ -9195,7 +9446,8 @@ "nullable": true, "description": "The URI of the [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource this trigger watches, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Trigger\")" }, "usage_trigger_enum_usage_category": { "type": "string", @@ -9383,6 +9635,7 @@ "trunking-recordings", "trunking-secure", "trunking-termination", + "tts-google", "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", @@ -9404,6 +9657,9 @@ "voice-insights-ptsn-insights-on-demand-minute", "voice-insights-sip-interface-insights-on-demand-minute", "voice-insights-sip-trunking-insights-on-demand-minute", + "voice-intelligence", + "voice-intelligence-transcription", + "voice-intelligence-operators", "wireless", "wireless-orders", "wireless-orders-artwork", @@ -9497,7 +9753,8 @@ "nullable": true, "description": "The date that this User Defined Message was created, given in RFC 2822 format." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UserDefinedMessage\")" }, "api.v2010.account.call.user_defined_message_subscription": { "type": "object", @@ -9537,7 +9794,8 @@ "nullable": true, "description": "The URI of the User Defined Message Subscription Resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UserDefinedMessageSubscription\")" }, "api.v2010.account.validation_request": { "type": "object", @@ -9561,26 +9819,33 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number." + "description": "The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "validation_code": { "type": "string", "nullable": true, "description": "The 6 digit validation code that someone must enter to validate the Caller ID when `phone_number` is called." } - } - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ValidationRequest\")" } } }, @@ -9597,7 +9862,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -9614,44 +9879,208 @@ "friendly_name", "status" ], - "pathType": "list", "dependentProperties": { - "address": "{account_sid: sid}", - "application": "{account_sid: sid}", - "authorized_connect_app": "{account_sid: sid}", - "available_phone_number_country": "{account_sid: sid}", - "balance": "{account_sid: sid}", - "call": "{account_sid: sid}", - "conference": "{account_sid: sid}", - "connect_app": "{account_sid: sid}", - "incoming_phone_number": "{account_sid: sid}", - "key": "{account_sid: sid}", - "message": "{account_sid: sid}", - "api/v2010/message_real_resource": "{account_sid: sid}", - "new_key": "{account_sid: sid}", - "new_signing_key": "{account_sid: sid}", - "notification": "{account_sid: sid}", - "outgoing_caller_id": "{account_sid: sid}", - "queue": "{account_sid: sid}", - "recording": "{account_sid: sid}", - "signing_key": "{account_sid: sid}", - "sip": "{account_sid: sid}", - "api/v2010/sms": "{account_sid: sid}", - "short_code": "{account_sid: sid}", - "token": "{account_sid: sid}", - "transcription": "{account_sid: sid}", - "usage": "{account_sid: sid}", - "validation_request": "{account_sid: sid}" - } + "addresses": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Addresses.json" + }, + "applications": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Applications.json" + }, + "authorized_connect_apps": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AuthorizedConnectApps.json" + }, + "available_phone_numbers": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers.json" + }, + "balance": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Balance.json" + }, + "calls": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls.json" + }, + "conferences": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Conferences.json" + }, + "connect_apps": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/ConnectApps.json" + }, + "incoming_phone_numbers": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers.json" + }, + "keys": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Keys.json" + }, + "messages": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Messages.json" + }, + "new_keys": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Keys.json" + }, + "new_signing_keys": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SigningKeys.json" + }, + "notifications": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Notifications.json" + }, + "outgoing_caller_ids": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/OutgoingCallerIds.json" + }, + "queues": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Queues.json" + }, + "recordings": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings.json" + }, + "signing_keys": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SigningKeys.json" + }, + "sip": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP.json" + }, + "sms": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SMS.json" + }, + "short_codes": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SMS/ShortCodes.json" + }, + "tokens": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Tokens.json" + }, + "transcriptions": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Transcriptions.json" + }, + "usage": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Usage.json" + }, + "validation_requests": { + "mapping": { + "account_sid": "sid" + }, + "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", + "tags": [ + "Api20100401Account" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account" + }, + "examples": { + "create": { + "value": { + "auth_token": "auth_token", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "owner_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "subresource_uris": { + "available_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json", + "calls": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json", + "conferences": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json", + "incoming_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "outgoing_caller_ids": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json", + "addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json", + "signing_keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json", + "connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json", + "sip": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json", + "authorized_connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json", + "usage": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json", + "keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json", + "applications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json", + "short_codes": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json", + "queues": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json", + "messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json", + "balance": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json" + }, + "type": "Full", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -9664,9 +10093,6 @@ } ], "operationId": "CreateAccount", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9679,6 +10105,13 @@ "description": "A human readable description of the account to create, defaults to `SubAccount Created at {YYYY-MM-DD HH:MM meridian}`" } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -9686,6 +10119,9 @@ }, "get": { "description": "Retrieves a collection of Accounts belonging to the account used to make the request", + "tags": [ + "Api20100401Account" + ], "parameters": [ { "name": "FriendlyName", @@ -9693,6 +10129,20 @@ "description": "Only return the Account resources with friendly names that exactly match this name.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "friendly_name" + }, + "readFull": { + "value": "friendly_name" + } } }, { @@ -9702,6 +10152,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/account_enum_status" + }, + "examples": { + "readEmpty": { + "value": "active" + }, + "readFull": { + "value": "active" + } } }, { @@ -9737,44 +10195,134 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAccountResponse", - "properties": { - "accounts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAccountResponse", + "properties": { + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Account\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Account\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Accounts\")" + }, + "examples": { + "readEmpty": { + "value": { + "first_page_uri": "/2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "accounts": [], + "uri": "/2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readFull": { + "value": { + "first_page_uri": "/2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "accounts": [ + { + "auth_token": "auth_token", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "owner_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "subresource_uris": { + "available_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json", + "calls": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json", + "conferences": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json", + "incoming_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "outgoing_caller_ids": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json", + "addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json", + "signing_keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json", + "connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json", + "sip": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json", + "authorized_connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json", + "usage": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json", + "keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json", + "applications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json", + "short_codes": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json", + "queues": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json", + "messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json", + "balance": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json" + }, + "type": "Full", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "uri": "/2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -9788,10 +10336,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccount", - "x-maturity": [ - "GA" - ] + "operationId": "ListAccount" } }, "/2010-04-01/Accounts/{Sid}.json": { @@ -9807,38 +10352,165 @@ "friendly_name", "status" ], - "pathType": "instance", "dependentProperties": { - "address": "{account_sid: sid}", - "application": "{account_sid: sid}", - "authorized_connect_app": "{account_sid: sid}", - "available_phone_number_country": "{account_sid: sid}", - "balance": "{account_sid: sid}", - "call": "{account_sid: sid}", - "conference": "{account_sid: sid}", - "connect_app": "{account_sid: sid}", - "incoming_phone_number": "{account_sid: sid}", - "key": "{account_sid: sid}", - "message": "{account_sid: sid}", - "api/v2010/message_real_resource": "{account_sid: sid}", - "new_key": "{account_sid: sid}", - "new_signing_key": "{account_sid: sid}", - "notification": "{account_sid: sid}", - "outgoing_caller_id": "{account_sid: sid}", - "queue": "{account_sid: sid}", - "recording": "{account_sid: sid}", - "signing_key": "{account_sid: sid}", - "sip": "{account_sid: sid}", - "api/v2010/sms": "{account_sid: sid}", - "short_code": "{account_sid: sid}", - "token": "{account_sid: sid}", - "transcription": "{account_sid: sid}", - "usage": "{account_sid: sid}", - "validation_request": "{account_sid: sid}" - } - }, + "addresses": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Addresses.json" + }, + "applications": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Applications.json" + }, + "authorized_connect_apps": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AuthorizedConnectApps.json" + }, + "available_phone_numbers": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers.json" + }, + "balance": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Balance.json" + }, + "calls": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls.json" + }, + "conferences": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Conferences.json" + }, + "connect_apps": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/ConnectApps.json" + }, + "incoming_phone_numbers": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers.json" + }, + "keys": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Keys.json" + }, + "messages": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Messages.json" + }, + "new_keys": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Keys.json" + }, + "new_signing_keys": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SigningKeys.json" + }, + "notifications": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Notifications.json" + }, + "outgoing_caller_ids": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/OutgoingCallerIds.json" + }, + "queues": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Queues.json" + }, + "recordings": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings.json" + }, + "signing_keys": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SigningKeys.json" + }, + "sip": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP.json" + }, + "sms": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SMS.json" + }, + "short_codes": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SMS/ShortCodes.json" + }, + "tokens": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Tokens.json" + }, + "transcriptions": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Transcriptions.json" + }, + "usage": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Usage.json" + }, + "validation_requests": { + "mapping": { + "account_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/OutgoingCallerIds.json" + } + }, + "pathType": "instance" + }, "get": { "description": "Fetch the account specified by the provided Account Sid", + "tags": [ + "Api20100401Account" + ], "parameters": [ { "name": "Sid", @@ -9859,6 +10531,43 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account" + }, + "examples": { + "fetch": { + "value": { + "auth_token": "auth_token", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "owner_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "subresource_uris": { + "available_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json", + "calls": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json", + "conferences": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json", + "incoming_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "outgoing_caller_ids": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json", + "addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json", + "signing_keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json", + "connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json", + "sip": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json", + "authorized_connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json", + "usage": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json", + "keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json", + "applications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json", + "short_codes": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json", + "queues": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json", + "messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json", + "balance": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json" + }, + "type": "Full", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -9870,13 +10579,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccount", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAccount" }, "post": { "description": "Modify the properties of a given Account", + "tags": [ + "Api20100401Account" + ], "parameters": [ { "name": "Sid", @@ -9897,6 +10606,78 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account" + }, + "examples": { + "update": { + "value": { + "auth_token": "auth_token", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "owner_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "subresource_uris": { + "available_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json", + "calls": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json", + "conferences": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json", + "incoming_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "outgoing_caller_ids": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json", + "addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json", + "signing_keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json", + "connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json", + "sip": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json", + "authorized_connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json", + "usage": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json", + "keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json", + "applications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json", + "short_codes": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json", + "queues": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json", + "messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json", + "balance": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json" + }, + "type": "Full", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "updateWithNumericStatus": { + "value": { + "auth_token": "auth_token", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "owner_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "subresource_uris": { + "available_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json", + "calls": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json", + "conferences": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json", + "incoming_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "outgoing_caller_ids": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json", + "addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json", + "signing_keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json", + "connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json", + "sip": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json", + "authorized_connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json", + "usage": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json", + "keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json", + "applications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json", + "short_codes": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json", + "queues": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json", + "messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json", + "balance": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json" + }, + "type": "Full", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -9909,9 +10690,6 @@ } ], "operationId": "UpdateAccount", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9929,6 +10707,19 @@ "description": "Alter the status of this account: use `closed` to irreversibly close this account, `suspended` to temporarily suspend it, or `active` to reactivate it." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Status": "active" + } + }, + "updateWithNumericStatus": { + "value": { + "Status": "1" + } + } } } } @@ -9949,14 +10740,23 @@ "validated", "verified" ], - "pathType": "list", "dependentProperties": { - "dependent_phone_number": "{account_sid: account_sid, address_sid: sid}" + "dependent_phone_numbers": { + "mapping": { + "account_sid": "account_sid", + "address_sid": "sid" + }, + "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": "", + "tags": [ + "Api20100401Address" + ], "parameters": [ { "name": "AccountSid", @@ -9977,6 +10777,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.address" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "city": "SF", + "customer_name": "name", + "date_created": "Tue, 18 Aug 2015 17:07:30 +0000", + "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000", + "emergency_enabled": false, + "friendly_name": null, + "iso_country": "US", + "postal_code": "94019", + "region": "CA", + "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "street": "4th", + "street_secondary": null, + "validated": false, + "verified": false, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -9989,9 +10811,6 @@ } ], "operationId": "CreateAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10049,6 +10868,19 @@ "PostalCode", "IsoCountry" ] + }, + "examples": { + "create": { + "value": { + "City": "city", + "CustomerName": "customer_name", + "FriendlyName": "friendly_name", + "IsoCountry": "US", + "PostalCode": "postal_code", + "Region": "region", + "Street": "street" + } + } } } } @@ -10056,6 +10888,9 @@ }, "get": { "description": "", + "tags": [ + "Api20100401Address" + ], "parameters": [ { "name": "AccountSid", @@ -10075,6 +10910,20 @@ "description": "The `customer_name` of the Address resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readFull": { + "value": "customer_name" + }, + "readEmpty": { + "value": "customer_name" + } } }, { @@ -10083,6 +10932,20 @@ "description": "The string that identifies the Address resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -10092,6 +10955,14 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "readFull": { + "value": "US" + }, + "readEmpty": { + "value": "US" + } } }, { @@ -10127,44 +10998,125 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAddressResponse", - "properties": { - "addresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.address" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAddressResponse", + "properties": { + "addresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.address" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Address\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Address\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Addresses\")" + }, + "examples": { + "readFull": { + "value": { + "addresses": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "city": "SF", + "customer_name": "name", + "date_created": "Tue, 18 Aug 2015 17:07:30 +0000", + "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000", + "emergency_enabled": false, + "friendly_name": null, + "iso_country": "US", + "postal_code": "94019", + "region": "CA", + "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "street": "4th", + "street_secondary": null, + "validated": false, + "verified": false, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "addresses": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0" } } } @@ -10178,10 +11130,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAddress", - "x-maturity": [ - "GA" - ] + "operationId": "ListAddress" } }, "/2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json": { @@ -10198,14 +11147,23 @@ "validated", "verified" ], - "pathType": "instance", "dependentProperties": { - "dependent_phone_number": "{account_sid: account_sid, address_sid: sid}" + "dependent_phone_numbers": { + "mapping": { + "account_sid": "account_sid", + "address_sid": "sid" + }, + "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": "", + "tags": [ + "Api20100401Address" + ], "parameters": [ { "name": "AccountSid", @@ -10242,13 +11200,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAddress", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteAddress" }, "get": { "description": "", + "tags": [ + "Api20100401Address" + ], "parameters": [ { "name": "AccountSid", @@ -10281,6 +11239,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.address" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "city": "SF", + "customer_name": "name", + "date_created": "Tue, 18 Aug 2015 17:07:30 +0000", + "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000", + "emergency_enabled": false, + "friendly_name": null, + "iso_country": "US", + "postal_code": "94019", + "region": "CA", + "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "street": "4th", + "street_secondary": null, + "validated": false, + "verified": false, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -10292,13 +11272,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAddress", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAddress" }, "post": { "description": "", + "tags": [ + "Api20100401Address" + ], "parameters": [ { "name": "AccountSid", @@ -10331,6 +11311,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.address" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "city": "SF", + "customer_name": "name", + "date_created": "Tue, 18 Aug 2015 17:07:30 +0000", + "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000", + "emergency_enabled": false, + "friendly_name": null, + "iso_country": "US", + "postal_code": "94019", + "region": "CA", + "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "street": "4th", + "street_secondary": null, + "validated": false, + "verified": false, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -10343,9 +11345,6 @@ } ], "operationId": "UpdateAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10390,6 +11389,18 @@ "description": "The additional number and street address of the address." } } + }, + "examples": { + "update": { + "value": { + "City": "city", + "CustomerName": "customer_name", + "FriendlyName": "friendly_name", + "PostalCode": "postal_code", + "Region": "region", + "Street": "street" + } + } } } } @@ -10409,11 +11420,14 @@ "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", + "tags": [ + "Api20100401Application" + ], "parameters": [ { "name": "AccountSid", @@ -10434,6 +11448,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.application" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Mon, 22 Aug 2011 20:59:45 +0000", + "date_updated": "Tue, 18 Aug 2015 16:48:57 +0000", + "friendly_name": "Application Friendly Name", + "message_status_callback": "http://www.example.com/sms-status-callback", + "sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "http://www.example.com/sms-fallback", + "sms_method": "GET", + "sms_status_callback": "http://www.example.com/sms-status-callback", + "sms_url": "http://example.com", + "status_callback": "http://example.com", + "status_callback_method": "GET", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_caller_id_lookup": false, + "voice_fallback_method": "GET", + "voice_fallback_url": "http://www.example.com/voice-callback", + "voice_method": "GET", + "voice_url": "http://example.com", + "public_application_connect_enabled": true + } + } } } }, @@ -10446,9 +11487,6 @@ } ], "operationId": "CreateApplication", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10573,6 +11611,27 @@ "description": "Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "MessageStatusCallback": "https://example.com", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsStatusCallback": "https://example.com", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceCallerIdLookup": true, + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "PublicApplicationConnectEnabled": true + } + } } } } @@ -10580,6 +11639,9 @@ }, "get": { "description": "Retrieve a list of applications representing an application within the requesting account", + "tags": [ + "Api20100401Application" + ], "parameters": [ { "name": "AccountSid", @@ -10599,6 +11661,14 @@ "description": "The string that identifies the Application resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -10634,44 +11704,124 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListApplicationResponse", - "properties": { - "applications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.application" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListApplicationResponse", + "properties": { + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.application" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Application\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Application\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Applications\")" + }, + "examples": { + "readFull": { + "value": { + "applications": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Fri, 21 Aug 2015 00:07:25 +0000", + "date_updated": "Fri, 21 Aug 2015 00:07:25 +0000", + "friendly_name": "d8821fb7-4d01-48b2-bdc5-34e46252b90b", + "message_status_callback": null, + "sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "POST", + "sms_fallback_url": null, + "sms_method": "POST", + "sms_status_callback": null, + "sms_url": null, + "status_callback": null, + "status_callback_method": "POST", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "public_application_connect_enabled": false + } + ], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0", + "next_page_uri": null, + "previous_page_uri": null, + "page_size": 1, + "page": 0, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0" + } + }, + "readEmpty": { + "value": { + "applications": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0", + "previous_page_uri": null, + "page_size": 1, + "start": 0, + "next_page_uri": null, + "page": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0" } } } @@ -10685,10 +11835,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListApplication", - "x-maturity": [ - "GA" - ] + "operationId": "ListApplication" } }, "/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json": { @@ -10704,11 +11851,14 @@ "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", + "tags": [ + "Api20100401Application" + ], "parameters": [ { "name": "AccountSid", @@ -10745,13 +11895,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteApplication", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteApplication" }, "get": { "description": "Fetch the application specified by the provided sid", + "tags": [ + "Api20100401Application" + ], "parameters": [ { "name": "AccountSid", @@ -10784,6 +11934,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.application" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Mon, 22 Aug 2011 20:59:45 +0000", + "date_updated": "Tue, 18 Aug 2015 16:48:57 +0000", + "friendly_name": "Application Friendly Name", + "message_status_callback": "http://www.example.com/sms-status-callback", + "sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "http://www.example.com/sms-fallback", + "sms_method": "GET", + "sms_status_callback": "http://www.example.com/sms-status-callback", + "sms_url": "http://example.com", + "status_callback": "http://example.com", + "status_callback_method": "GET", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_caller_id_lookup": false, + "voice_fallback_method": "GET", + "voice_fallback_url": "http://www.example.com/voice-callback", + "voice_method": "GET", + "voice_url": "http://example.com", + "public_application_connect_enabled": false + } + } } } }, @@ -10795,13 +11972,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchApplication", - "x-maturity": [ - "GA" - ] + "operationId": "FetchApplication" }, "post": { "description": "Updates the application's properties", + "tags": [ + "Api20100401Application" + ], "parameters": [ { "name": "AccountSid", @@ -10834,6 +12011,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.application" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Mon, 22 Aug 2011 20:59:45 +0000", + "date_updated": "Tue, 18 Aug 2015 16:48:57 +0000", + "friendly_name": "Application Friendly Name", + "message_status_callback": "http://www.example.com/sms-status-callback", + "sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "http://www.example.com/sms-fallback", + "sms_method": "GET", + "sms_status_callback": "http://www.example.com/sms-status-callback", + "sms_url": "http://example.com", + "status_callback": "http://example.com", + "status_callback_method": "GET", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_caller_id_lookup": false, + "voice_fallback_method": "GET", + "voice_fallback_url": "http://www.example.com/voice-callback", + "voice_method": "GET", + "voice_url": "http://example.com", + "public_application_connect_enabled": true + } + } } } }, @@ -10846,9 +12050,6 @@ } ], "operationId": "UpdateApplication", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10973,6 +12174,27 @@ "description": "Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "MessageStatusCallback": "https://example.com", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsStatusCallback": "https://example.com", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceCallerIdLookup": true, + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "PublicApplicationConnectEnabled": true + } + } } } } @@ -10991,11 +12213,14 @@ "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", + "tags": [ + "Api20100401AuthorizedConnectApp" + ], "parameters": [ { "name": "AccountSid", @@ -11028,6 +12253,22 @@ "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" + } + } } } }, @@ -11039,10 +12280,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAuthorizedConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAuthorizedConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps.json": { @@ -11057,11 +12295,14 @@ "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", + "tags": [ + "Api20100401AuthorizedConnectApp" + ], "parameters": [ { "name": "AccountSid", @@ -11108,44 +12349,113 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAuthorizedConnectAppResponse", - "properties": { - "authorized_connect_apps": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAuthorizedConnectAppResponse", + "properties": { + "authorized_connect_apps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AuthorizedConnectApp\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AuthorizedConnectApp\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthorizedConnectApps\")" + }, + "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" + } + }, + "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" } } } @@ -11159,10 +12469,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAuthorizedConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "ListAuthorizedConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json": { @@ -11178,21 +12485,66 @@ "country", "beta" ], - "pathType": "list", "dependentProperties": { - "local": "{account_sid: account_sid, country_code: country_code}", - "toll_free": "{account_sid: account_sid, country_code: country_code}", - "mobile": "{account_sid: account_sid, country_code: country_code}", - "national": "{account_sid: account_sid, country_code: country_code}", - "voip": "{account_sid: account_sid, country_code: country_code}", - "shared_cost": "{account_sid: account_sid, country_code: country_code}", - "machine_to_machine": "{account_sid: account_sid, country_code: country_code}" + "local": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Local.json" + }, + "toll_free": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/TollFree.json" + }, + "mobile": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Mobile.json" + }, + "national": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/National.json" + }, + "voip": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Voip.json" + }, + "shared_cost": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/SharedCost.json" + }, + "machine_to_machine": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/MachineToMachine.json" + } }, "parent": "/Accounts/{Sid}.json", - "className": "available_phone_number_country" + "className": "available_phone_number_country", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401AvailablePhoneNumberCountry" + ], "parameters": [ { "name": "AccountSid", @@ -11239,44 +12591,97 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberCountryResponse", - "properties": { - "countries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberCountryResponse", + "properties": { + "countries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AvailablePhoneNumberCountry\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AvailablePhoneNumberCountry\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Countries\")" + }, + "examples": { + "readFull": { + "value": { + "countries": [ + { + "beta": false, + "country": "Denmark", + "country_code": "DK", + "subresource_uris": { + "local": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/DK/Local.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/DK.json" + } + ], + "end": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json" + } + }, + "readEmpty": { + "value": { + "countries": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json" } } } @@ -11290,10 +12695,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberCountry" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json": { @@ -11309,21 +12711,66 @@ "country", "beta" ], - "pathType": "instance", "dependentProperties": { - "local": "{account_sid: account_sid, country_code: country_code}", - "toll_free": "{account_sid: account_sid, country_code: country_code}", - "mobile": "{account_sid: account_sid, country_code: country_code}", - "national": "{account_sid: account_sid, country_code: country_code}", - "voip": "{account_sid: account_sid, country_code: country_code}", - "shared_cost": "{account_sid: account_sid, country_code: country_code}", - "machine_to_machine": "{account_sid: account_sid, country_code: country_code}" + "local": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Local.json" + }, + "toll_free": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/TollFree.json" + }, + "mobile": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Mobile.json" + }, + "national": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/National.json" + }, + "voip": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Voip.json" + }, + "shared_cost": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/SharedCost.json" + }, + "machine_to_machine": { + "mapping": { + "account_sid": "account_sid", + "country_code": "country_code" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/MachineToMachine.json" + } }, "parent": "/Accounts/{Sid}.json", - "className": "available_phone_number_country" + "className": "available_phone_number_country", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "Api20100401AvailablePhoneNumberCountry" + ], "parameters": [ { "name": "AccountSid", @@ -11354,6 +12801,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" + }, + "examples": { + "fetch": { + "value": { + "beta": null, + "country": "United States", + "country_code": "US", + "subresource_uris": { + "local": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json", + "toll_free": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US.json" + } + } } } }, @@ -11365,10 +12826,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAvailablePhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAvailablePhoneNumberCountry" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json": { @@ -11384,11 +12842,14 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Local" + ], "parameters": [ { "name": "AccountSid", @@ -11482,6 +12943,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -11590,44 +13059,106 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberLocalResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberLocalResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Local\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Local\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": true, + "sms": false, + "voice": true + }, + "friendly_name": "(808) 925-1571", + "iso_country": "US", + "lata": "834", + "latitude": "19.720000", + "locality": "Hilo", + "longitude": "-155.090000", + "phone_number": "+18089251571", + "postal_code": "96720", + "rate_center": "HILO", + "region": "HI" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json" } } } @@ -11641,10 +13172,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberLocal", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberLocal" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/MachineToMachine.json": { @@ -11660,11 +13188,14 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401MachineToMachine" + ], "parameters": [ { "name": "AccountSid", @@ -11758,6 +13289,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -11866,44 +13405,106 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberMachineToMachineResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberMachineToMachineResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"MachineToMachine\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"MachineToMachine\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": false, + "sms": true, + "voice": false + }, + "friendly_name": "+4759440374", + "iso_country": "NO", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+4759440374", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/MachineToMachine.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/MachineToMachine.json" } } } @@ -11917,10 +13518,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberMachineToMachine", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberMachineToMachine" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Mobile.json": { @@ -11936,11 +13534,14 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Mobile" + ], "parameters": [ { "name": "AccountSid", @@ -12034,6 +13635,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -12142,44 +13751,106 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberMobileResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberMobileResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Mobile\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Mobile\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": false, + "sms": true, + "voice": false + }, + "friendly_name": "+4759440374", + "iso_country": "NO", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+4759440374", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Mobile.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Mobile.json" } } } @@ -12193,10 +13864,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberMobile", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberMobile" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/National.json": { @@ -12212,11 +13880,14 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401National" + ], "parameters": [ { "name": "AccountSid", @@ -12310,6 +13981,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -12418,44 +14097,106 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberNationalResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberNationalResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"National\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"National\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": false, + "sms": true, + "voice": false + }, + "friendly_name": "+4759440374", + "iso_country": "NO", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+4759440374", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/National.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/National.json" } } } @@ -12469,10 +14210,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberNational", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberNational" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/SharedCost.json": { @@ -12488,11 +14226,14 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401SharedCost" + ], "parameters": [ { "name": "AccountSid", @@ -12586,6 +14327,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -12694,44 +14443,106 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberSharedCostResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberSharedCostResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"SharedCost\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"SharedCost\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": false, + "sms": true, + "voice": false + }, + "friendly_name": "+4759440374", + "iso_country": "NO", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+4759440374", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/SharedCost.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/SharedCost.json" } } } @@ -12745,10 +14556,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberSharedCost", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberSharedCost" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/TollFree.json": { @@ -12764,11 +14572,14 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401TollFree" + ], "parameters": [ { "name": "AccountSid", @@ -12862,6 +14673,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -12970,44 +14789,106 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberTollFreeResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberTollFreeResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"TollFree\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"TollFree\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": true, + "sms": true, + "voice": true + }, + "friendly_name": "(800) 100-0052", + "iso_country": "US", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+18001000052", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json" } } } @@ -13021,10 +14902,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberTollFree", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberTollFree" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Voip.json": { @@ -13040,11 +14918,14 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Voip" + ], "parameters": [ { "name": "AccountSid", @@ -13138,6 +15019,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -13246,44 +15135,106 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberVoipResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberVoipResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Voip\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Voip\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": false, + "sms": true, + "voice": false + }, + "friendly_name": "+4759440374", + "iso_country": "NO", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+4759440374", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Voip.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Voip.json" } } } @@ -13297,10 +15248,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberVoip", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberVoip" } }, "/2010-04-01/Accounts/{AccountSid}/Balance.json": { @@ -13316,11 +15264,14 @@ "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", + "tags": [ + "Api20100401Balance" + ], "parameters": [ { "name": "AccountSid", @@ -13341,6 +15292,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.balance" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "balance": "0.05", + "currency": "USD" + } + } } } }, @@ -13352,10 +15312,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBalance", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBalance" } }, "/2010-04-01/Accounts/{AccountSid}/Calls.json": { @@ -13373,22 +15330,72 @@ "status", "start_time" ], - "pathType": "list", "dependentProperties": { - "recording": "{account_sid: account_sid, call_sid: sid}", - "notification": "{account_sid: account_sid, call_sid: sid}", - "feedback": "{account_sid: account_sid, call_sid: sid}", - "event": "{account_sid: account_sid, call_sid: sid}", - "payment": "{account_sid: account_sid, call_sid: sid}", - "siprec": "{account_sid: account_sid, call_sid: sid}", - "stream": "{account_sid: account_sid, call_sid: sid}", - "user_defined_message_subscription": "{account_sid: account_sid, call_sid: sid}", - "user_defined_message": "{account_sid: account_sid, call_sid: sid}" - }, - "parent": "/Accounts/{Sid}.json" + "recordings": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json" + }, + "notifications": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Notifications.json" + }, + "events": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Events.json" + }, + "payments": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Payments.json" + }, + "siprec": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json" + }, + "streams": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Streams.json" + }, + "user_defined_message_subscriptions": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/UserDefinedMessageSubscriptions.json" + }, + "user_defined_messages": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/UserDefinedMessages.json" + } + }, + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a new outgoing call to phones, SIP-enabled endpoints or Twilio Client connections", + "tags": [ + "Api20100401Call" + ], "parameters": [ { "name": "AccountSid", @@ -13409,6 +15416,88 @@ "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" + } + } } } }, @@ -13421,9 +15510,6 @@ } ], "operationId": "CreateCall", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -13640,6 +15726,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" + } + } } } } @@ -13656,6 +15814,9 @@ }, "get": { "description": "Retrieves a collection of calls made to and from your account", + "tags": [ + "Api20100401Call" + ], "parameters": [ { "name": "AccountSid", @@ -13676,6 +15837,29 @@ "schema": { "type": "string", "format": "phone-number" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + }, + "examples": { + "readFullPage1": { + "value": "+123456789" + }, + "readFullPage2": { + "value": "+123456789" + }, + "readEmptyDatesGreater": { + "value": "+123456789" + }, + "readEmptyDatesLess": { + "value": "+123456789" + }, + "readEmptyDateFunDateFormats": { + "value": "+123456789" + } } }, { @@ -13685,6 +15869,29 @@ "schema": { "type": "string", "format": "phone-number" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + }, + "examples": { + "readFullPage1": { + "value": "+987654321" + }, + "readFullPage2": { + "value": "+987654321" + }, + "readEmptyDatesGreater": { + "value": "+987654321" + }, + "readEmptyDatesLess": { + "value": "+987654321" + }, + "readEmptyDateFunDateFormats": { + "value": "+987654321" + } } }, { @@ -13696,6 +15903,23 @@ "minLength": 34, "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$" + }, + "examples": { + "readFullPage1": { + "value": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFullPage2": { + "value": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmptyDatesGreater": { + "value": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmptyDatesLess": { + "value": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmptyDateFunDateFormats": { + "value": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -13705,6 +15929,23 @@ "schema": { "type": "string", "$ref": "#/components/schemas/call_enum_status" + }, + "examples": { + "readFullPage1": { + "value": "completed" + }, + "readFullPage2": { + "value": "completed" + }, + "readEmptyDatesGreater": { + "value": "completed" + }, + "readEmptyDatesLess": { + "value": "completed" + }, + "readEmptyDateFunDateFormats": { + "value": "completed" + } } }, { @@ -13714,6 +15955,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFullPage1": { + "value": "2008-01-02" + }, + "readFullPage2": { + "value": "2008-01-02" + } } }, { @@ -13723,6 +15972,18 @@ "schema": { "type": "string", "format": "date-time" + }, + "x-twilio": { + "shortDescription": "Only include calls that started on this date", + "ignoreFormat": true + }, + "examples": { + "readEmptyDatesLess": { + "value": "2008-01-02" + }, + "readEmptyDateFunDateFormats": { + "value": "06/11/2019 22:05:25 MST" + } } }, { @@ -13732,6 +15993,15 @@ "schema": { "type": "string", "format": "date-time" + }, + "x-twilio": { + "shortDescription": "Only include calls that started on this date", + "ignoreFormat": true + }, + "examples": { + "readEmptyDatesGreater": { + "value": "2008-01-02" + } } }, { @@ -13741,6 +16011,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFullPage1": { + "value": "2009-01-02" + }, + "readFullPage2": { + "value": "2009-01-02" + } } }, { @@ -13750,6 +16028,18 @@ "schema": { "type": "string", "format": "date-time" + }, + "x-twilio": { + "shortDescription": "Only include calls that ended on this date", + "ignoreFormat": true + }, + "examples": { + "readEmptyDatesLess": { + "value": "2009-01-02" + }, + "readEmptyDateFunDateFormats": { + "value": "2019-06-11 22:05:25.000" + } } }, { @@ -13759,6 +16049,15 @@ "schema": { "type": "string", "format": "date-time" + }, + "x-twilio": { + "shortDescription": "Only include calls that ended on this date", + "ignoreFormat": true + }, + "examples": { + "readEmptyDatesGreater": { + "value": "2009-01-02" + } } }, { @@ -13794,44 +16093,293 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListCallResponse", - "properties": { - "calls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.call" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListCallResponse", + "properties": { + "calls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.call" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Call\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Call\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Calls\")" + }, + "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" + } + }, + "readEmptyDateFunDateFormats": { + "value": { + "calls": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2019-06-11+22%3A05%3A25.000&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=2&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 2, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2019-06-11+22%3A05%3A25.000&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=2&Page=0" } } } @@ -13845,10 +16393,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCall", - "x-maturity": [ - "GA" - ] + "operationId": "ListCall" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json": { @@ -13866,22 +16411,72 @@ "status", "start_time" ], - "pathType": "instance", "dependentProperties": { - "recording": "{account_sid: account_sid, call_sid: sid}", - "notification": "{account_sid: account_sid, call_sid: sid}", - "feedback": "{account_sid: account_sid, call_sid: sid}", - "event": "{account_sid: account_sid, call_sid: sid}", - "payment": "{account_sid: account_sid, call_sid: sid}", - "siprec": "{account_sid: account_sid, call_sid: sid}", - "stream": "{account_sid: account_sid, call_sid: sid}", - "user_defined_message_subscription": "{account_sid: account_sid, call_sid: sid}", - "user_defined_message": "{account_sid: account_sid, call_sid: sid}" - }, - "parent": "/Accounts/{Sid}.json" + "recordings": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json" + }, + "notifications": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Notifications.json" + }, + "events": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Events.json" + }, + "payments": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Payments.json" + }, + "siprec": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json" + }, + "streams": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Streams.json" + }, + "user_defined_message_subscriptions": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/UserDefinedMessageSubscriptions.json" + }, + "user_defined_messages": { + "mapping": { + "account_sid": "account_sid", + "call_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/UserDefinedMessages.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.", + "tags": [ + "Api20100401Call" + ], "parameters": [ { "name": "AccountSid", @@ -13918,13 +16513,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCall", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCall" }, "get": { "description": "Fetch the call specified by the provided Call SID", + "tags": [ + "Api20100401Call" + ], "parameters": [ { "name": "AccountSid", @@ -13957,6 +16552,48 @@ "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" + } + } } } }, @@ -13968,13 +16605,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCall", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCall" }, "post": { "description": "Initiates a call redirect or terminates a call", + "tags": [ + "Api20100401Call" + ], "parameters": [ { "name": "AccountSid", @@ -14007,6 +16644,168 @@ "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" + } + } } } }, @@ -14019,9 +16818,6 @@ } ], "operationId": "UpdateCall", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -14098,6 +16894,47 @@ "description": "The maximum duration of the call in seconds. Constraints depend on account and configuration." } } + }, + "examples": { + "update": { + "value": { + "FallbackMethod": "GET", + "FallbackUrl": "https://example.com", + "Method": "GET", + "Status": "completed", + "StatusCallback": "https://example.com", + "StatusCallbackUrl": "https://example.com", + "StatusCallbackMethod": "GET", + "Url": "https://example.com" + } + }, + "cancel": { + "value": { + "FallbackMethod": "GET", + "FallbackUrl": "https://example.com", + "Method": "GET", + "Status": "canceled", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "Url": "https://example.com" + } + }, + "posttwiml": { + "value": { + "FallbackMethod": "GET", + "FallbackUrl": "https://example.com", + "Method": "GET", + "Status": "canceled", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "Twiml": "Enjoy" + } + }, + "updatetimelimit": { + "value": { + "TimeLimit": 600 + } + } } } } @@ -14116,11 +16953,14 @@ "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.", + "tags": [ + "Api20100401Event" + ], "parameters": [ { "name": "AccountSid", @@ -14179,44 +17019,125 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListCallEventResponse", - "properties": { - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.call.call_event" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListCallEventResponse", + "properties": { + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.call.call_event" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Event\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Event\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Events\")" + }, + "examples": { + "readFull": { + "value": { + "events": [ + { + "request": { + "method": "POST", + "url": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "parameters": { + "status_callback_method": "POST", + "twiml": "Hi!", + "trim": "trim-silence", + "timeout": "55", + "method": "POST", + "from": "+987654321", + "to": "+123456789", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "machine_detection_timeout": "0" + } + }, + "response": { + "response_code": 201, + "request_duration": 50, + "content_type": "application/json", + "response_body": "{\"sid\": \"CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}", + "date_created": "Tue, 11 Aug 2020 17:44:08 +0000" + } + } + ], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "events": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0" } } } @@ -14230,35 +17151,36 @@ "accountSid_authToken": [] } ], - "operationId": "ListCallEvent", - "x-maturity": [ - "GA" - ] + "operationId": "ListCallEvent" } }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Feedback.json": { + "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications/{Sid}.json": { "servers": [ { "url": "https://api.twilio.com" } ], - "description": "The call Feedback subresource describes the quality experienced during a phone call.", + "description": "Error notifications for calls", "x-twilio": { "defaultOutputProperties": [ "sid", - "quality_score", - "date_created" + "call_sid", + "error_code", + "message_date" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "instance" }, "get": { - "description": "Fetch a Feedback resource from a call", + "description": "", + "tags": [ + "Api20100401Notification" + ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call Notification resource to fetch.", "schema": { "type": "string", "minLength": 34, @@ -14270,7 +17192,7 @@ { "name": "CallSid", "in": "path", - "description": "The call sid that uniquely identifies the call", + "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resource to fetch.", "schema": { "type": "string", "minLength": 34, @@ -14278,6 +17200,18 @@ "pattern": "^CA[0-9a-fA-F]{32}$" }, "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Call Notification resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^NO[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -14285,7 +17219,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_feedback" + "$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" + } + } } } }, @@ -14297,18 +17254,36 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCallFeedback", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCallNotification" + } + }, + "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json": { + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "description": "Error notifications for calls", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "call_sid", + "error_code", + "message_date" + ], + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, - "post": { - "description": "Update a Feedback resource for a call", + "get": { + "description": "", + "tags": [ + "Api20100401Notification" + ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call Notification resources to read.", "schema": { "type": "string", "minLength": 34, @@ -14320,11 +17295,92 @@ { "name": "CallSid", "in": "path", - "description": "The call sid that uniquely identifies the call", + "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resources to read.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$" }, "required": true + }, + { + "name": "Log", + "in": "query", + "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 + } + } + }, + { + "name": "MessageDate", + "in": "query", + "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", + "schema": { + "type": "string", + "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } + } + }, + { + "name": "MessageDate<", + "in": "query", + "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "MessageDate>", + "in": "query", + "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged 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": { @@ -14332,7 +17388,119 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_feedback" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListCallNotificationResponse", + "properties": { + "notifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.call.call_notification" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Notification\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Notification\")" + } + } + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Notifications\")" + }, + "examples": { + "readFull": { + "value": { + "notifications": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Tue, 18 Aug 2015 08:46:56 +0000", + "date_updated": "Tue, 18 Aug 2015 08:46:57 +0000", + "error_code": "15003", + "log": "1", + "message_date": "Tue, 18 Aug 2015 08:46:56 +0000", + "message_text": "statusCallback=http%3A%2F%2Fexample.com%2Ffoo.xml&ErrorCode=15003&LogLevel=WARN&Msg=Got+HTTP+404+response+to+http%3A%2F%2Fexample.com%2Ffoo.xml", + "more_info": "https://www.twilio.com/docs/errors/15003", + "request_method": null, + "request_url": "", + "sid": "NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0", + "next_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json" + } + }, + "readEmpty": { + "value": { + "notifications": [], + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0", + "next_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json" + } + } } } }, @@ -14344,527 +17512,37 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateCallFeedback", - "x-maturity": [ - "GA" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateCallFeedbackRequest", - "properties": { - "QualityScore": { - "type": "integer", - "description": "The call quality expressed as an integer from `1` to `5` where `1` represents very poor call quality and `5` represents a perfect call." - }, - "Issue": { - "type": "array", - "items": { - "type": "string", - "$ref": "#/components/schemas/call_feedback_enum_issues" - }, - "description": "One or more issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`, or `one-way-audio`." - } - } - } - } - } - } + "operationId": "ListCallNotification" } }, - "/2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary.json": { + "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json": { "servers": [ { "url": "https://api.twilio.com" } ], - "description": "Call FeedbackSummary resources provide an idea of how your end user's perceive the quality of their calls and the most common issues they have encountered in the context of all your voice traffic during a specific time frame.", + "description": "A Recording resource represents the recording associated with a voice call, conference, or SIP Trunk.", "x-twilio": { "defaultOutputProperties": [ "sid", - "call_feedback_count", - "quality_score_average", - "start_date" + "call_sid", + "status", + "start_time", + "duration" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls.json", - "mountName": "feedback_summaries" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "post": { - "description": "Create a FeedbackSummary resource for a call", + "description": "Create a recording for the call", + "tags": [ + "Api20100401Recording" + ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_feedback_summary" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateCallFeedbackSummary", - "x-maturity": [ - "GA" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateCallFeedbackSummaryRequest", - "properties": { - "StartDate": { - "type": "string", - "format": "date", - "description": "Only include feedback given on or after this date. Format is `YYYY-MM-DD` and specified in UTC." - }, - "EndDate": { - "type": "string", - "format": "date", - "description": "Only include feedback given on or before this date. Format is `YYYY-MM-DD` and specified in UTC." - }, - "IncludeSubaccounts": { - "type": "boolean", - "description": "Whether to also include Feedback resources from all subaccounts. `true` includes feedback from all subaccounts and `false`, the default, includes feedback from only the specified account." - }, - "StatusCallback": { - "type": "string", - "format": "uri", - "description": "The URL that we will request when the feedback summary is complete." - }, - "StatusCallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "The HTTP method (`GET` or `POST`) we use to make the request to the `StatusCallback` URL." - } - }, - "required": [ - "StartDate", - "EndDate" - ] - } - } - } - } - } - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary/{Sid}.json": { - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "description": "Call FeedbackSummary resources provide an idea of how your end user's perceive the quality of their calls and the most common issues they have encountered in the context of all your voice traffic during a specific time frame.", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "call_feedback_count", - "quality_score_average", - "start_date" - ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Calls.json", - "mountName": "feedback_summaries" - }, - "get": { - "description": "Fetch a FeedbackSummary resource from a call", - "parameters": [ - { - "name": "AccountSid", - "in": "path", - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FS[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_feedback_summary" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchCallFeedbackSummary", - "x-maturity": [ - "GA" - ] - }, - "delete": { - "description": "Delete a FeedbackSummary resource from a call", - "parameters": [ - { - "name": "AccountSid", - "in": "path", - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FS[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteCallFeedbackSummary", - "x-maturity": [ - "GA" - ] - } - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications/{Sid}.json": { - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "description": "Error notifications for calls", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "call_sid", - "error_code", - "message_date" - ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AccountSid", - "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call Notification resource to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "CallSid", - "in": "path", - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resource to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Call Notification resource to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^NO[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_notification-instance" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchCallNotification", - "x-maturity": [ - "GA" - ] - } - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json": { - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "description": "Error notifications for calls", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "call_sid", - "error_code", - "message_date" - ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AccountSid", - "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call Notification resources to read.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "CallSid", - "in": "path", - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resources to read.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Log", - "in": "query", - "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" - } - }, - { - "name": "MessageDate", - "in": "query", - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "MessageDate<", - "in": "query", - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "MessageDate>", - "in": "query", - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListCallNotificationResponse", - "properties": { - "notifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.call.call_notification" - } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListCallNotification", - "x-maturity": [ - "GA" - ] - } - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json": { - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "description": "A Recording resource represents the recording associated with a voice call, conference, or SIP Trunk.", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "call_sid", - "status", - "start_time", - "duration" - ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" - }, - "post": { - "description": "Create a recording for the call", - "parameters": [ - { - "name": "AccountSid", - "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", "schema": { "type": "string", "minLength": 34, @@ -14892,6 +17570,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.call_recording" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": null, + "channels": 2, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:34 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": null, + "price_unit": null, + "duration": null, + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartCallRecordingAPI", + "status": "in-progress", + "error_code": null, + "encryption_details": null, + "track": "both", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -14904,9 +17606,6 @@ } ], "operationId": "CreateCallRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -14952,6 +17651,23 @@ "description": "The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio." } } + }, + "examples": { + "create": { + "value": { + "RecordingStatusCallbackEvent": [ + "in-progress completed failed" + ], + "RecordingStatusCallback": "https://example.com", + "RecordingStatusCallbackMethod": "GET", + "Trim": "do-not-trim", + "RecordingChannels": "dual", + "RecordingTrack": "both", + "PlayBeep": true, + "Transcribe": true, + "TranscriptionConfiguration": "JVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -14959,6 +17675,9 @@ }, "get": { "description": "Retrieve a list of recordings belonging to the call used to make the request", + "tags": [ + "Api20100401Recording" + ], "parameters": [ { "name": "AccountSid", @@ -14991,6 +17710,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -15000,6 +17727,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-01" + }, + "readEmpty": { + "value": "2008-01-01" + } } }, { @@ -15009,6 +17744,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-03" + }, + "readEmpty": { + "value": "2008-01-03" + } } }, { @@ -15035,53 +17778,134 @@ "in": "query", "description": "The page token. This is provided by the API.", "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListCallRecordingResponse", - "properties": { - "recordings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.call.call_recording" - } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListCallRecordingResponse", + "properties": { + "recordings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.call.call_recording" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\")" + } + } + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recordings\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": null, + "channels": 2, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "-0.0025", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "source": "StartCallRecordingAPI", + "status": "completed", + "track": "both", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "recordings": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0" } } } @@ -15095,10 +17919,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCallRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListCallRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json": { @@ -15116,11 +17937,14 @@ "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.", + "tags": [ + "Api20100401Recording" + ], "parameters": [ { "name": "AccountSid", @@ -15162,6 +17986,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.call_recording" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": null, + "channels": 2, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:36 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": null, + "price_unit": null, + "duration": null, + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartCallRecordingAPI", + "status": "paused", + "error_code": null, + "encryption_details": null, + "track": "both", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -15174,9 +18022,6 @@ } ], "operationId": "UpdateCallRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -15197,6 +18042,15 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "paused", + "PauseBehavior": "skip", + "PlayBeep": true + } + } } } } @@ -15204,6 +18058,9 @@ }, "get": { "description": "Fetch an instance of a recording for a call", + "tags": [ + "Api20100401Recording" + ], "parameters": [ { "name": "AccountSid", @@ -15248,6 +18105,34 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.call_recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": null, + "channels": 2, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "-0.0025", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "source": "StartCallRecordingAPI", + "status": "completed", + "error_code": null, + "track": "both", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -15259,13 +18144,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCallRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCallRecording" }, "delete": { "description": "Delete a recording from your account", + "tags": [ + "Api20100401Recording" + ], "parameters": [ { "name": "AccountSid", @@ -15314,10 +18199,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCallRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCallRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json": { @@ -15333,15 +18215,30 @@ "friendly_name", "status" ], - "pathType": "instance", "dependentProperties": { - "participant": "{account_sid: account_sid, conference_sid: sid}", - "recording": "{account_sid: account_sid, conference_sid: sid}" + "participants": { + "mapping": { + "account_sid": "account_sid", + "conference_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Conferences/{conference_sid}/Participants.json" + }, + "recordings": { + "mapping": { + "account_sid": "account_sid", + "conference_sid": "sid" + }, + "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", + "tags": [ + "Api20100401Conference" + ], "parameters": [ { "name": "AccountSid", @@ -15374,6 +18271,84 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference" + }, + "examples": { + "fetchValidMixerZone": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Fri, 18 Feb 2011 19:26:50 +0000", + "date_updated": "Fri, 18 Feb 2011 19:27:33 +0000", + "friendly_name": "AHH YEAH", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "region": "us1", + "status": "completed", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": "last-participant-left", + "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchValidRegionInProgress": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Fri, 18 Feb 2011 19:26:50 +0000", + "date_updated": "Fri, 18 Feb 2011 19:27:33 +0000", + "friendly_name": "AHH YEAH", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "region": "au1", + "status": "in-progress", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": null, + "call_sid_ending_conference": null + } + }, + "fetchWithoutMixerZoneIntegerStatus": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Fri, 18 Feb 2011 19:26:50 +0000", + "date_updated": "Fri, 18 Feb 2011 19:27:33 +0000", + "friendly_name": "AHH YEAH", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "region": "us1", + "status": "completed", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": "participant-with-end-conference-on-exit-left", + "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchUnknownMixerZoneInitIntegerStatus": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Fri, 18 Feb 2011 19:26:50 +0000", + "date_updated": "Fri, 18 Feb 2011 19:27:33 +0000", + "friendly_name": "AHH YEAH", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "region": "unknown", + "status": "init", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": "participant-with-end-conference-on-exit-left", + "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -15385,13 +18360,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConference", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConference" }, "post": { "description": "", + "tags": [ + "Api20100401Conference" + ], "parameters": [ { "name": "AccountSid", @@ -15421,6 +18396,46 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference" + }, + "examples": { + "updateEndConference": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Mon, 22 Aug 2011 20:58:45 +0000", + "date_updated": "Mon, 22 Aug 2011 20:58:46 +0000", + "friendly_name": null, + "region": "us1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": "conference-ended-via-api", + "call_sid_ending_conference": null + } + }, + "announceToConference": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Mon, 08 Feb 2021 20:58:45 +0000", + "date_updated": "Mon, 08 Feb 2021 20:58:46 +0000", + "friendly_name": "MyRoom", + "region": "us1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "in-progress", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": null, + "call_sid_ending_conference": null + } + } } } }, @@ -15433,9 +18448,6 @@ } ], "operationId": "UpdateConference", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -15467,39 +18479,809 @@ "description": "The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST`" } } + }, + "examples": { + "updateEndConference": { + "value": { + "Status": "completed" + } + }, + "announceToConference": { + "value": { + "AnnounceUrl": "http://www.myapp.com/announce" + } + } + } + } + } + } + } + }, + "/2010-04-01/Accounts/{AccountSid}/Conferences.json": { + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "description": "Voice call conferences", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "friendly_name", + "status" + ], + "dependentProperties": { + "participants": { + "mapping": { + "account_sid": "account_sid", + "conference_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Conferences/{conference_sid}/Participants.json" + }, + "recordings": { + "mapping": { + "account_sid": "account_sid", + "conference_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json" + } + }, + "parent": "/Accounts/{Sid}.json", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of conferences belonging to the account used to make the request", + "tags": [ + "Api20100401Conference" + ], + "parameters": [ + { + "name": "AccountSid", + "in": "path", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference resource(s) to read.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[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. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", + "schema": { + "type": "string", + "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2008-01-03" + }, + "readNext": { + "value": "2008-01-03" + }, + "readPrevious": { + "value": "2008-01-03" + }, + "readDateCreatedEquals": { + "value": "2020-07-07" + } + } + }, + { + "name": "DateCreated<", + "in": "query", + "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", + "schema": { + "type": "string", + "format": "date" + }, + "x-twilio": { + "shortDescription": "The `YYYY-MM-DD` value of the resources to read", + "ignoreFormat": true + }, + "examples": { + "readEmpty": { + "value": "2008-01-01" + }, + "readNext": { + "value": "2008-01-01" + }, + "readPrevious": { + "value": "2008-01-01" + } + } + }, + { + "name": "DateCreated>", + "in": "query", + "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", + "schema": { + "type": "string", + "format": "date" + }, + "x-twilio": { + "shortDescription": "The `YYYY-MM-DD` value of the resources to read", + "ignoreFormat": true + }, + "examples": { + "readEmpty": { + "value": "2008-01-02" + }, + "readNext": { + "value": "2008-01-02" + }, + "readPrevious": { + "value": "2008-01-02" + }, + "readDateCreatedOnOrAfter": { + "value": "2021-01-01" + } + } + }, + { + "name": "DateUpdated", + "in": "query", + "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", + "schema": { + "type": "string", + "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2018-11-13" + }, + "readNext": { + "value": "2018-11-13" + }, + "readPrevious": { + "value": "2018-11-13" + } + } + }, + { + "name": "DateUpdated<", + "in": "query", + "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", + "schema": { + "type": "string", + "format": "date" + }, + "x-twilio": { + "shortDescription": "The `YYYY-MM-DD` value of the resources to read", + "ignoreFormat": true + }, + "examples": { + "readEmpty": { + "value": "2018-11-11" + }, + "readNext": { + "value": "2018-11-11" + }, + "readPrevious": { + "value": "2018-11-11" + } + } + }, + { + "name": "DateUpdated>", + "in": "query", + "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", + "schema": { + "type": "string", + "format": "date" + }, + "x-twilio": { + "shortDescription": "The `YYYY-MM-DD` value of the resources to read", + "ignoreFormat": true + }, + "examples": { + "readEmpty": { + "value": "2018-11-12" + }, + "readNext": { + "value": "2018-11-12" + }, + "readPrevious": { + "value": "2018-11-12" + } + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "The string that identifies the Conference resources to read.", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "friendly_name" + }, + "readNext": { + "value": "friendly_name" + }, + "readPrevious": { + "value": "friendly_name" + }, + "readMyroom": { + "value": "MyRoom" + } + } + }, + { + "name": "Status", + "in": "query", + "description": "The status of the resources to read. Can be: `init`, `in-progress`, or `completed`.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/conference_enum_status" + }, + "examples": { + "readEmpty": { + "value": "init" + }, + "readNext": { + "value": "in-progress" + }, + "readPrevious": { + "value": "in-progress" + }, + "readDateCreatedOnOrAfter": { + "value": "in-progress" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListConferenceResponse", + "properties": { + "conferences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.conference" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Conference\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Conference\")" + } + } + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Conferences\")" + }, + "examples": { + "readEmpty": { + "value": { + "conferences": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=init&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=50&Page=0", + "next_page_uri": null, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=init&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=50&Page=0", + "page": 0, + "page_size": 50, + "start": 0, + "end": 0 + } + }, + "readNext": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFdddddddddddddddddddddddddddddddd", + "date_updated": "Thu, 01 Jan 2015 10:23:45 +0000", + "date_created": "Thu, 01 Jan 2015 10:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "unknown", + "sid": "CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee", + "date_updated": "Thu, 01 Jan 2015 09:23:45 +0000", + "date_created": "Thu, 01 Jan 2015 09:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "us1", + "sid": "CFffffffffffffffffffffffffffffffff", + "date_updated": "Thu, 01 Jan 2015 08:23:45 +0000", + "date_created": "Thu, 01 Jan 2015 08:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=2&PageToken=PACFffffffffffffffffffffffffffffffff", + "previous_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0&PageToken=PBCFdddddddddddddddddddddddddddddddd", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc", + "page": 1, + "page_size": 3, + "start": 3, + "end": 5 + } + }, + "readPrevious": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "Sat, 03 Jan 2015 11:23:45 +0000", + "date_created": "Sat, 03 Jan 2015 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "unknown", + "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_updated": "Fri, 02 Jan 2015 11:23:45 +0000", + "date_created": "Fri, 02 Jan 2015 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "us1", + "sid": "CFcccccccccccccccccccccccccccccccc", + "date_updated": "Thu, 01 Jan 2015 11:23:45 +0000", + "date_created": "Thu, 01 Jan 2015 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc", + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0&PageToken=PBCFdddddddddddddddddddddddddddddddd", + "page": 0, + "page_size": 3, + "start": 0, + "end": 2 + } + }, + "readMyroom": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "Sun, 03 Jan 2021 11:23:45 +0000", + "date_created": "Sun, 03 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "completed", + "region": "us1", + "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_updated": "Sat, 02 Jan 2021 11:23:45 +0000", + "date_created": "Sat, 02 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": "last-participant-left", + "call_sid_ending_conference": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + }, + { + "status": "completed", + "region": "ie1", + "sid": "CFcccccccccccccccccccccccccccccccc", + "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000", + "date_created": "Fri, 01 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": "last-participant-left", + "call_sid_ending_conference": "CAcccccccccccccccccccccccccccccccc" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0", + "next_page_uri": null, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0", + "page": 0, + "page_size": 20, + "start": 0, + "end": 2 + } + }, + "readFull": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "Fri, 03 Jul 2020 11:23:45 +0000", + "date_created": "Fri, 03 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "de1", + "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_updated": "Thu, 02 Jul 2020 11:23:45 +0000", + "date_created": "Thu, 02 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "completed", + "region": "br1", + "sid": "CFcccccccccccccccccccccccccccccccc", + "date_updated": "Wed, 01 Jul 2020 11:23:45 +0000", + "date_created": "Wed, 01 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json" + }, + "friendly_name": "FRIEND", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": "participant-with-end-conference-on-exit-left", + "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc", + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=0", + "page": 0, + "page_size": 3, + "start": 0, + "end": 2 + } + }, + "readDateCreatedEquals": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "Tue, 07 Jul 2020 11:23:45 +0000", + "date_created": "Tue, 07 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "de1", + "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_updated": "Tue, 07 Jul 2020 11:23:45 +0000", + "date_created": "Tue, 07 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "completed", + "region": "br1", + "sid": "CFcccccccccccccccccccccccccccccccc", + "date_updated": "Tue, 07 Jul 2020 11:23:45 +0000", + "date_created": "Tue, 07 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json" + }, + "friendly_name": "FRIEND", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": "participant-with-end-conference-on-exit-left", + "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc", + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0", + "page": 0, + "page_size": 3, + "start": 0, + "end": 2 + } + }, + "readDateCreatedOnOrAfter": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000", + "date_created": "Fri, 01 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "de1", + "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000", + "date_created": "Fri, 01 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "br1", + "sid": "CFcccccccccccccccccccccccccccccccc", + "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000", + "date_created": "Fri, 01 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json" + }, + "friendly_name": "FRIEND", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0", + "next_page_uri": null, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0", + "page": 0, + "page_size": 20, + "start": 0, + "end": 2 + } + } + } } - } + }, + "description": "OK" } - } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListConference" } }, - "/2010-04-01/Accounts/{AccountSid}/Conferences.json": { + "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json": { "servers": [ { "url": "https://api.twilio.com" } ], - "description": "Voice call conferences", + "description": "Recordings of conferences", "x-twilio": { "defaultOutputProperties": [ "sid", - "friendly_name", - "status" + "conference_sid", + "status", + "start_time", + "duration" ], - "pathType": "list", - "dependentProperties": { - "participant": "{account_sid: account_sid, conference_sid: sid}", - "recording": "{account_sid: account_sid, conference_sid: sid}" - }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json", + "pathType": "list" }, "get": { - "description": "Retrieve a list of conferences belonging to the account used to make the request", + "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 resource(s) to read.", + "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, @@ -15509,74 +19291,66 @@ "required": true }, { - "name": "DateCreated", - "in": "query", - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "DateCreated<", - "in": "query", - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "DateCreated>", - "in": "query", - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", + "name": "ConferenceSid", + "in": "path", + "description": "The Conference SID that identifies the conference associated with the recording to read.", "schema": { "type": "string", - "format": "date" - } + "minLength": 34, + "maxLength": 34, + "pattern": "^CF[0-9a-fA-F]{32}$" + }, + "required": true }, { - "name": "DateUpdated", + "name": "DateCreated", "in": "query", - "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", + "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": "DateUpdated<", + "name": "DateCreated<", "in": "query", - "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", + "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": "DateUpdated>", + "name": "DateCreated>", "in": "query", - "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", + "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": "FriendlyName", - "in": "query", - "description": "The string that identifies the Conference resources to read.", - "schema": { - "type": "string" - } - }, - { - "name": "Status", - "in": "query", - "description": "The status of the resources to read. Can be: `init`, `in-progress`, or `completed`.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/conference_enum_status" + }, + "examples": { + "readFull": { + "value": "2008-01-03" + }, + "readEmpty": { + "value": "2008-01-03" + } } }, { @@ -15612,44 +19386,124 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListConferenceResponse", - "properties": { - "conferences": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.conference" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListConferenceRecordingResponse", + "properties": { + "recordings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recordings\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "-0.0025", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "completed", + "error_code": null, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "recordings": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0" } } } @@ -15663,10 +19517,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConference", - "x-maturity": [ - "GA" - ] + "operationId": "ListConferenceRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json": { @@ -15684,11 +19535,14 @@ "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.", + "tags": [ + "Api20100401Recording" + ], "parameters": [ { "name": "AccountSid", @@ -15730,6 +19584,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:39 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": null, + "price_unit": null, + "duration": null, + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "paused", + "error_code": null, + "encryption_details": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -15742,9 +19619,6 @@ } ], "operationId": "UpdateConferenceRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -15765,6 +19639,15 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "paused", + "PauseBehavior": "skip", + "PlayBeep": true + } + } } } } @@ -15772,6 +19655,9 @@ }, "get": { "description": "Fetch an instance of a recording for a call", + "tags": [ + "Api20100401Recording" + ], "parameters": [ { "name": "AccountSid", @@ -15816,6 +19702,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "-0.0025", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "completed", + "error_code": null, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -15827,13 +19740,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConferenceRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConferenceRecording" }, "delete": { "description": "Delete a recording from your account", + "tags": [ + "Api20100401Recording" + ], "parameters": [ { "name": "AccountSid", @@ -15858,185 +19771,23 @@ "pattern": "^CF[0-9a-fA-F]{32}$" }, "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Conference Recording resource to delete.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteConferenceRecording", - "x-maturity": [ - "GA" - ] - } - }, - "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json": { - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "description": "Recordings of conferences", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "conference_sid", - "status", - "start_time", - "duration" - ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json" - }, - "get": { - "description": "Retrieve a list of recordings belonging to the call used to make the request", - "parameters": [ - { - "name": "AccountSid", - "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resources to read.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ConferenceSid", - "in": "path", - "description": "The Conference SID that identifies the conference associated with the recording to read.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "DateCreated", - "in": "query", - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "DateCreated<", - "in": "query", - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "DateCreated>", - "in": "query", - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Conference Recording resource to delete.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RE[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListConferenceRecordingResponse", - "properties": { - "recordings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" - } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" - } - } - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -16044,10 +19795,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConferenceRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConferenceRecording" } }, "/2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json": { @@ -16062,11 +19810,14 @@ "sid", "friendly_name" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a connect-app", + "tags": [ + "Api20100401ConnectApp" + ], "parameters": [ { "name": "AccountSid", @@ -16099,6 +19850,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.connect_app" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "authorize_redirect_url": "http://example.com/redirect", + "company_name": "Twilio", + "deauthorize_callback_method": "GET", + "deauthorize_callback_url": "http://example.com/deauth", + "description": null, + "friendly_name": "Connect app for deletion", + "homepage_url": "http://example.com/home", + "permissions": [], + "sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -16110,13 +19878,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConnectApp" }, "post": { "description": "Update a connect-app with the specified parameters", + "tags": [ + "Api20100401ConnectApp" + ], "parameters": [ { "name": "AccountSid", @@ -16149,6 +19917,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.connect_app" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "authorize_redirect_url": "http://example.com/redirect", + "company_name": "Twilio", + "deauthorize_callback_method": "GET", + "deauthorize_callback_url": "http://example.com/deauth", + "description": null, + "friendly_name": "Connect app for deletion", + "homepage_url": "http://example.com/home", + "permissions": [], + "sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -16161,9 +19946,6 @@ } ], "operationId": "UpdateConnectApp", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -16220,6 +20002,22 @@ "description": "A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: `get-all` and `post-all`." } } + }, + "examples": { + "update": { + "value": { + "AuthorizeRedirectUrl": "https://example.com", + "CompanyName": "company_name", + "DeauthorizeCallbackMethod": "GET", + "DeauthorizeCallbackUrl": "https://example.com", + "Description": "description", + "FriendlyName": "friendly_name", + "HomepageUrl": "https://example.com", + "Permissions": [ + "get-all" + ] + } + } } } } @@ -16227,6 +20025,9 @@ }, "delete": { "description": "Delete an instance of a connect-app", + "tags": [ + "Api20100401ConnectApp" + ], "parameters": [ { "name": "AccountSid", @@ -16263,10 +20064,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/ConnectApps.json": { @@ -16281,11 +20079,14 @@ "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", + "tags": [ + "Api20100401ConnectApp" + ], "parameters": [ { "name": "AccountSid", @@ -16332,44 +20133,114 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListConnectAppResponse", - "properties": { - "connect_apps": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.connect_app" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListConnectAppResponse", + "properties": { + "connect_apps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.connect_app" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"ConnectApp\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"ConnectApp\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ConnectApps\")" + }, + "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" + } + }, + "readEmpty": { + "value": { + "connect_apps": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=0&PageSize=50", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json" } } } @@ -16383,10 +20254,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "ListConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/Addresses/{AddressSid}/DependentPhoneNumbers.json": { @@ -16402,11 +20270,14 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Addresses/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Addresses/{Sid}.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401DependentPhoneNumber" + ], "parameters": [ { "name": "AccountSid", @@ -16465,44 +20336,129 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListDependentPhoneNumberResponse", - "properties": { - "dependent_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.address.dependent_phone_number" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListDependentPhoneNumberResponse", + "properties": { + "dependent_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.address.dependent_phone_number" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"DependentPhoneNumber\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"DependentPhoneNumber\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"DependentPhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "dependent_phone_numbers": [ + { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "3197004499318", + "phone_number": "+3197004499318", + "voice_url": null, + "voice_method": "POST", + "voice_fallback_url": null, + "voice_fallback_method": "POST", + "voice_caller_id_lookup": false, + "date_created": "Thu, 23 Feb 2017 10:26:31 -0800", + "date_updated": "Thu, 23 Feb 2017 10:26:31 -0800", + "sms_url": "", + "sms_method": "POST", + "sms_fallback_url": "", + "sms_fallback_method": "POST", + "address_requirements": "any", + "capabilities": { + "Voice": false, + "SMS": true, + "MMS": false + }, + "status_callback": "", + "status_callback_method": "POST", + "api_version": "2010-04-01", + "voice_application_sid": null, + "sms_application_sid": "", + "trunk_sid": null, + "emergency_status": "Inactive", + "emergency_address_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json?Page=0&PageSize=50", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json" + } + }, + "readEmpty": { + "value": { + "dependent_phone_numbers": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json?Page=0&PageSize=50", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json" } } } @@ -16516,10 +20472,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDependentPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "ListDependentPhoneNumber" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json": { @@ -16535,14 +20488,23 @@ "phone_number", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "assigned_add_on": "{account_sid: account_sid, resource_sid: sid}" + "assigned_add_ons": { + "mapping": { + "account_sid": "account_sid", + "resource_sid": "sid" + }, + "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.", + "tags": [ + "Api20100401IncomingPhoneNumber" + ], "parameters": [ { "name": "AccountSid", @@ -16575,6 +20537,54 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Inactive", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": true, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "voice_receive_mode": "voice", + "status": "in-use", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "assigned_add_ons": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json" + } + } + } } } }, @@ -16587,9 +20597,6 @@ } ], "operationId": "UpdateIncomingPhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -16766,6 +20773,34 @@ "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations." } } + }, + "examples": { + "update": { + "value": { + "AccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ApiVersion": "api_version", + "EmergencyStatus": "Inactive", + "EmergencyAddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "IdentitySid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VoiceCallerIdLookup": "true", + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "VoiceReceiveMode": "voice", + "BundleSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -16773,6 +20808,9 @@ }, "get": { "description": "Fetch an incoming-phone-number belonging to the account used to make the request.", + "tags": [ + "Api20100401IncomingPhoneNumber" + ], "parameters": [ { "name": "AccountSid", @@ -16805,6 +20843,54 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "voice_receive_mode": "voice", + "status": "in-use", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "assigned_add_ons": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json" + } + } + } } } }, @@ -16816,13 +20902,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIncomingPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchIncomingPhoneNumber" }, "delete": { "description": "Delete a phone-numbers belonging to the account used to make the request.", + "tags": [ + "Api20100401IncomingPhoneNumber" + ], "parameters": [ { "name": "AccountSid", @@ -16859,10 +20945,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIncomingPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteIncomingPhoneNumber" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json": { @@ -16878,14 +20961,23 @@ "phone_number", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "assigned_add_on": "{account_sid: account_sid, resource_sid: sid}" + "assigned_add_ons": { + "mapping": { + "account_sid": "account_sid", + "resource_sid": "sid" + }, + "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.", + "tags": [ + "Api20100401IncomingPhoneNumber" + ], "parameters": [ { "name": "AccountSid", @@ -16905,6 +20997,14 @@ "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -16913,6 +21013,20 @@ "description": "A string that identifies the IncomingPhoneNumber resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -16922,6 +21036,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -16965,44 +21087,145 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberResponse", - "properties": { - "incoming_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberResponse", + "properties": { + "incoming_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"IncomingPhoneNumber\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"IncomingPhoneNumber\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IncomingPhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": null, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use", + "subresource_uris": { + "assigned_add_ons": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json" + } + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" } } } @@ -17016,13 +21239,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumber" }, "post": { "description": "Purchase a phone-number for the account.", + "tags": [ + "Api20100401IncomingPhoneNumber" + ], "parameters": [ { "name": "AccountSid", @@ -17043,6 +21266,54 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "friendly_name", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "https://example.com", + "sms_method": "GET", + "sms_url": "https://example.com", + "status_callback": "https://example.com", + "status_callback_method": "GET", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_caller_id_lookup": false, + "voice_fallback_method": "GET", + "voice_fallback_url": "https://example.com", + "voice_method": "GET", + "voice_url": "https://example.com", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use", + "subresource_uris": { + "assigned_add_ons": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json" + } + } + } } } }, @@ -17055,9 +21326,6 @@ } ], "operationId": "CreateIncomingPhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -17236,6 +21504,34 @@ "description": "The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only)." } } + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ApiVersion": "api_version", + "AreaCode": "area_code", + "EmergencyStatus": "Active", + "EmergencyAddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "IdentitySid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "PhoneNumber": "+18089255327", + "SmsApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VoiceCallerIdLookup": "true", + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "BundleSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -17256,7 +21552,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -17264,14 +21560,24 @@ "friendly_name", "description" ], - "pathType": "instance", "dependentProperties": { - "assigned_add_on_extension": "{account_sid: account_sid, resource_sid: resource_sid, assigned_add_on_sid: sid}" + "extensions": { + "mapping": { + "account_sid": "account_sid", + "resource_sid": "resource_sid", + "assigned_add_on_sid": "sid" + }, + "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.", + "tags": [ + "Api20100401AssignedAddOn" + ], "parameters": [ { "name": "AccountSid", @@ -17316,6 +21622,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" + }, + "examples": { + "fetch": { + "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "Thu, 07 Apr 2016 23:52:28 +0000", + "date_updated": "Thu, 07 Apr 2016 23:52:28 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "extensions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json" + } + } + } } } }, @@ -17327,13 +21654,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchIncomingPhoneNumberAssignedAddOn" }, "delete": { "description": "Remove the assignment of an Add-on installation from the Number specified.", + "tags": [ + "Api20100401AssignedAddOn" + ], "parameters": [ { "name": "AccountSid", @@ -17382,10 +21709,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteIncomingPhoneNumberAssignedAddOn" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json": { @@ -17394,7 +21718,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -17402,14 +21726,24 @@ "friendly_name", "description" ], - "pathType": "list", "dependentProperties": { - "assigned_add_on_extension": "{account_sid: account_sid, resource_sid: resource_sid, assigned_add_on_sid: sid}" + "extensions": { + "mapping": { + "account_sid": "account_sid", + "resource_sid": "resource_sid", + "assigned_add_on_sid": "sid" + }, + "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.", + "tags": [ + "Api20100401AssignedAddOn" + ], "parameters": [ { "name": "AccountSid", @@ -17468,44 +21802,118 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberAssignedAddOnResponse", - "properties": { - "assigned_add_ons": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberAssignedAddOnResponse", + "properties": { + "assigned_add_ons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AssignedAddOn\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AssignedAddOn\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AssignedAddOns\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "assigned_add_ons": [ + { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "Thu, 07 Apr 2016 23:52:28 +0000", + "date_updated": "Thu, 07 Apr 2016 23:52:28 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "extensions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json" + } + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "assigned_add_ons": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0" } } } @@ -17519,13 +21927,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ] + "operationId": "ListIncomingPhoneNumberAssignedAddOn" }, "post": { "description": "Assign an Add-on installation to the Number specified.", + "tags": [ + "Api20100401AssignedAddOn" + ], "parameters": [ { "name": "AccountSid", @@ -17558,6 +21966,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" + }, + "examples": { + "create": { + "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "Thu, 07 Apr 2016 23:52:28 +0000", + "date_updated": "Thu, 07 Apr 2016 23:52:28 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "extensions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json" + } + } + } } } }, @@ -17570,9 +21999,6 @@ } ], "operationId": "CreateIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -17591,6 +22017,13 @@ "required": [ "InstalledAddOnSid" ] + }, + "examples": { + "create": { + "value": { + "InstalledAddOnSid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -17603,7 +22036,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -17611,12 +22044,15 @@ "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.", + "tags": [ + "Api20100401AssignedAddOnExtension" + ], "parameters": [ { "name": "AccountSid", @@ -17673,6 +22109,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" + }, + "examples": { + "fetch": { + "value": { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assigned_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "enabled": true + } + } } } }, @@ -17684,10 +22135,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIncomingPhoneNumberAssignedAddOnExtension", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchIncomingPhoneNumberAssignedAddOnExtension" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions.json": { @@ -17696,7 +22144,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -17704,12 +22152,15 @@ "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.", + "tags": [ + "Api20100401AssignedAddOnExtension" + ], "parameters": [ { "name": "AccountSid", @@ -17780,44 +22231,112 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberAssignedAddOnExtensionResponse", - "properties": { - "extensions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberAssignedAddOnExtensionResponse", + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AssignedAddOnExtension\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AssignedAddOnExtension\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Extensions\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "extensions": [ + { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assigned_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": true, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "extensions": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0" } } } @@ -17831,10 +22350,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberAssignedAddOnExtension", - "x-maturity": [ - "Beta" - ] + "operationId": "ListIncomingPhoneNumberAssignedAddOnExtension" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json": { @@ -17850,11 +22366,14 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json" + "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Local" + ], "parameters": [ { "name": "AccountSid", @@ -17874,6 +22393,14 @@ "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -17882,6 +22409,20 @@ "description": "A string that identifies the resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -17891,6 +22432,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -17932,46 +22481,143 @@ "responses": { "200": { "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberLocalResponse", - "properties": { - "incoming_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" - } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberLocalResponse", + "properties": { + "incoming_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Local\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Local\")" + } + } + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IncomingPhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": null, + "capabilities": { + "mms": true, + "sms": false, + "voice": true + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" } } } @@ -17985,13 +22631,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberLocal", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumberLocal" }, "post": { "description": "", + "tags": [ + "Api20100401Local" + ], "parameters": [ { "name": "AccountSid", @@ -18012,6 +22658,51 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "friendly_name", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "https://example.com", + "sms_method": "GET", + "sms_url": "https://example.com", + "status_callback": "https://example.com", + "status_callback_method": "GET", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_caller_id_lookup": true, + "voice_fallback_method": "GET", + "voice_fallback_url": "https://example.com", + "voice_method": "GET", + "voice_url": "https://example.com", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + } } } }, @@ -18024,9 +22715,6 @@ } ], "operationId": "CreateIncomingPhoneNumberLocal", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18204,6 +22892,34 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ApiVersion": "api_version", + "AreaCode": "area_code", + "EmergencyStatus": "Active", + "EmergencyAddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "IdentitySid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "PhoneNumber": "+18089255327", + "SmsApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VoiceCallerIdLookup": "true", + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "BundleSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -18223,11 +22939,14 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json" + "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Mobile" + ], "parameters": [ { "name": "AccountSid", @@ -18247,6 +22966,14 @@ "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -18255,6 +22982,20 @@ "description": "A string that identifies the resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -18264,6 +23005,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -18307,44 +23056,141 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberMobileResponse", - "properties": { - "incoming_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberMobileResponse", + "properties": { + "incoming_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Mobile\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Mobile\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IncomingPhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": null, + "capabilities": { + "mms": true, + "sms": false, + "voice": true + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" } } } @@ -18358,13 +23204,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberMobile", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumberMobile" }, "post": { "description": "", + "tags": [ + "Api20100401Mobile" + ], "parameters": [ { "name": "AccountSid", @@ -18385,6 +23231,51 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "friendly_name", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "https://example.com", + "sms_method": "GET", + "sms_url": "https://example.com", + "status_callback": "https://example.com", + "status_callback_method": "GET", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_caller_id_lookup": true, + "voice_fallback_method": "GET", + "voice_fallback_url": "https://example.com", + "voice_method": "GET", + "voice_url": "https://example.com", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + } } } }, @@ -18397,9 +23288,6 @@ } ], "operationId": "CreateIncomingPhoneNumberMobile", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18577,6 +23465,34 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ApiVersion": "api_version", + "AreaCode": "area_code", + "EmergencyStatus": "Active", + "EmergencyAddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "IdentitySid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "PhoneNumber": "+18089255327", + "SmsApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VoiceCallerIdLookup": "true", + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "BundleSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -18596,11 +23512,14 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json" + "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401TollFree" + ], "parameters": [ { "name": "AccountSid", @@ -18620,6 +23539,14 @@ "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -18628,6 +23555,20 @@ "description": "A string that identifies the resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -18637,6 +23578,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -18680,44 +23629,141 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberTollFreeResponse", - "properties": { - "incoming_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberTollFreeResponse", + "properties": { + "incoming_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"TollFree\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"TollFree\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IncomingPhoneNumbers\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": null, + "capabilities": { + "mms": true, + "sms": false, + "voice": true + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" } } } @@ -18731,13 +23777,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberTollFree", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumberTollFree" }, "post": { "description": "", + "tags": [ + "Api20100401TollFree" + ], "parameters": [ { "name": "AccountSid", @@ -18758,6 +23804,51 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "friendly_name", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "https://example.com", + "sms_method": "GET", + "sms_url": "https://example.com", + "status_callback": "https://example.com", + "status_callback_method": "GET", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_caller_id_lookup": true, + "voice_fallback_method": "GET", + "voice_fallback_url": "https://example.com", + "voice_method": "GET", + "voice_url": "https://example.com", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + } } } }, @@ -18770,9 +23861,6 @@ } ], "operationId": "CreateIncomingPhoneNumberTollFree", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18950,6 +24038,34 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ApiVersion": "api_version", + "AreaCode": "area_code", + "EmergencyStatus": "Active", + "EmergencyAddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "IdentitySid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "PhoneNumber": "+18089255327", + "SmsApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VoiceCallerIdLookup": "true", + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "BundleSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -18969,11 +24085,14 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "Api20100401Key" + ], "parameters": [ { "name": "AccountSid", @@ -19006,6 +24125,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.key" + }, + "examples": { + "fetch": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + } } } }, @@ -19017,13 +24146,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchKey", - "x-maturity": [ - "GA" - ] + "operationId": "FetchKey" }, "post": { "description": "", + "tags": [ + "Api20100401Key" + ], "parameters": [ { "name": "AccountSid", @@ -19056,6 +24185,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.key" + }, + "examples": { + "update": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + } } } }, @@ -19068,9 +24207,6 @@ } ], "operationId": "UpdateKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -19083,6 +24219,13 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "foo" + } + } } } } @@ -19090,6 +24233,9 @@ }, "delete": { "description": "", + "tags": [ + "Api20100401Key" + ], "parameters": [ { "name": "AccountSid", @@ -19126,10 +24272,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteKey", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteKey" } }, "/2010-04-01/Accounts/{AccountSid}/Keys.json": { @@ -19145,11 +24288,14 @@ "friendly_name", "date_created" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Key" + ], "parameters": [ { "name": "AccountSid", @@ -19196,44 +24342,107 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListKeyResponse", - "properties": { - "keys": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.key" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListKeyResponse", + "properties": { + "keys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.key" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Key\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Key\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Keys\")" + }, + "examples": { + "readFull": { + "value": { + "keys": [ + { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readEmpty": { + "value": { + "keys": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -19247,13 +24456,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListKey", - "x-maturity": [ - "GA" - ] + "operationId": "ListKey" }, "post": { "description": "", + "tags": [ + "Api20100401NewKey" + ], "parameters": [ { "name": "AccountSid", @@ -19274,6 +24483,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.new_key" + }, + "examples": { + "create": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000", + "secret": "foobar" + } + } } } }, @@ -19286,9 +24506,6 @@ } ], "operationId": "CreateNewKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -19301,6 +24518,13 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "foo" + } + } } } } @@ -19316,23 +24540,26 @@ "url": "https://api.twilio.com" } ], - "description": "The Media resource represents a piece of media, such as an image, that is associated with a message.", + "description": "The Media subresource of a Message resource represents a piece of media, such as an image, that is associated with the Message.", "x-twilio": { "defaultOutputProperties": [ "sid", "parent_sid", "content_type" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json", + "pathType": "instance" }, "delete": { - "description": "Delete media from your account. Once delete, you will no longer be billed", + "description": "Delete the Media resource.", + "tags": [ + "Api20100401Media" + ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is associated with the Media resource.", "schema": { "type": "string", "minLength": 34, @@ -19344,7 +24571,7 @@ { "name": "MessageSid", "in": "path", - "description": "The SID of the Message resource that this Media resource belongs to.", + "description": "The SID of the Message resource that is associated with the Media resource.", "schema": { "type": "string", "minLength": 34, @@ -19356,7 +24583,7 @@ { "name": "Sid", "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Media resource to delete", + "description": "The unique identifier of the to-be-deleted Media resource.", "schema": { "type": "string", "minLength": 34, @@ -19376,18 +24603,18 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMedia", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMedia" }, "get": { - "description": "Fetch a single media instance belonging to the account used to make the request", + "description": "Fetch a single Media resource associated with a specific Message resource", + "tags": [ + "Api20100401Media" + ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) associated with the Media resource.", "schema": { "type": "string", "minLength": 34, @@ -19399,7 +24626,7 @@ { "name": "MessageSid", "in": "path", - "description": "The SID of the Message resource that this Media resource belongs to.", + "description": "The SID of the Message resource that is associated with the Media resource.", "schema": { "type": "string", "minLength": 34, @@ -19411,7 +24638,7 @@ { "name": "Sid", "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Media resource to fetch", + "description": "The Twilio-provided string that uniquely identifies the Media resource to fetch.", "schema": { "type": "string", "minLength": 34, @@ -19427,6 +24654,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.message.media" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "image/jpeg", + "date_created": "Sun, 16 Aug 2015 15:53:54 +0000", + "date_updated": "Sun, 16 Aug 2015 15:53:55 +0000", + "parent_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media/MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -19438,10 +24678,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMedia", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMedia" } }, "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media.json": { @@ -19450,23 +24687,26 @@ "url": "https://api.twilio.com" } ], - "description": "The Media resource represents a piece of media, such as an image, that is associated with a message.", + "description": "The Media subresource of a Message resource represents a piece of media, such as an image, that is associated with the Message.", "x-twilio": { "defaultOutputProperties": [ "sid", "parent_sid", "content_type" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json", + "pathType": "list" }, "get": { - "description": "Retrieve a list of Media resources belonging to the account used to make the request", + "description": "Read a list of Media resources associated with a specific Message resource", + "tags": [ + "Api20100401Media" + ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is associated with the Media resources.", "schema": { "type": "string", "minLength": 34, @@ -19478,7 +24718,7 @@ { "name": "MessageSid", "in": "path", - "description": "The SID of the Message resource that this Media resource belongs to.", + "description": "The SID of the Message resource that is associated with the Media resources.", "schema": { "type": "string", "minLength": 34, @@ -19490,28 +24730,52 @@ { "name": "DateCreated", "in": "query", - "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", + "description": "Only include Media resources that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read Media that were created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read Media that were created on or after midnight of this date.", "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { "name": "DateCreated<", "in": "query", - "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", + "description": "Only include Media resources that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read Media that were created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read Media that were created on or after midnight of this date.", "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-01" + }, + "readEmpty": { + "value": "2008-01-01" + } } }, { "name": "DateCreated>", "in": "query", - "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", + "description": "Only include Media resources that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read Media that were created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read Media that were created on or after midnight of this date.", "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-03" + }, + "readEmpty": { + "value": "2008-01-03" + } } }, { @@ -19547,44 +24811,116 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListMediaResponse", - "properties": { - "media_list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.message.media" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListMediaResponse", + "properties": { + "media_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.message.media" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Media\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Media\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"MediaList\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0", + "media_list": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "image/jpeg", + "date_created": "Sun, 16 Aug 2015 15:53:54 +0000", + "date_updated": "Sun, 16 Aug 2015 15:53:55 +0000", + "parent_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media/MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0", + "media_list": [], + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0" } } } @@ -19598,10 +24934,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMedia", - "x-maturity": [ - "GA" - ] + "operationId": "ListMedia" } }, "/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json": { @@ -19618,11 +24951,14 @@ "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", + "tags": [ + "Api20100401Member" + ], "parameters": [ { "name": "AccountSid", @@ -19664,6 +25000,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.queue.member" + }, + "examples": { + "fetch": { + "value": { + "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_enqueued": "Tue, 07 Aug 2012 22:57:41 +0000", + "position": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "wait_time": 143 + } + }, + "fetchFront": { + "value": { + "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_enqueued": "Tue, 07 Aug 2012 22:57:41 +0000", + "position": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "wait_time": 143 + } + } } } }, @@ -19675,13 +25033,13 @@ "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", + "tags": [ + "Api20100401Member" + ], "parameters": [ { "name": "AccountSid", @@ -19723,6 +25081,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.queue.member" + }, + "examples": { + "update": { + "value": { + "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_enqueued": "Thu, 06 Dec 2018 18:42:47 +0000", + "position": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "wait_time": 143 + } + }, + "dequeueFront": { + "value": { + "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_enqueued": "Tue, 07 Aug 2012 22:57:41 +0000", + "position": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "wait_time": 143 + } + } } } }, @@ -19735,9 +25115,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -19767,6 +25144,20 @@ "required": [ "Url" ] + }, + "examples": { + "update": { + "value": { + "Method": "GET", + "Url": "https://example.com" + } + }, + "dequeueFront": { + "value": { + "Method": "GET", + "Url": "https://example.com" + } + } } } } @@ -19787,11 +25178,14 @@ "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", + "tags": [ + "Api20100401Member" + ], "parameters": [ { "name": "AccountSid", @@ -19850,44 +25244,109 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListMemberResponse", - "properties": { - "queue_members": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.queue.member" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListMemberResponse", + "properties": { + "queue_members": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.queue.member" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Member\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Member\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"QueueMembers\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "queue_members": [ + { + "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_enqueued": "Mon, 17 Dec 2018 18:36:39 +0000", + "position": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "wait_time": 124 + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?Page=0&PageSize=50", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "queue_members": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json" } } } @@ -19901,10 +25360,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/2010-04-01/Accounts/{AccountSid}/Messages.json": { @@ -19923,20 +25379,35 @@ "direction", "date_sent" ], - "pathType": "list", "dependentProperties": { - "media": "{account_sid: account_sid, message_sid: sid}", - "feedback": "{account_sid: account_sid, message_sid: sid}" + "media": { + "mapping": { + "account_sid": "account_sid", + "message_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Messages/{message_sid}/Media.json" + }, + "feedback": { + "mapping": { + "account_sid": "account_sid", + "message_sid": "sid" + }, + "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 from the account used to make the request", + "description": "Send a message", + "tags": [ + "Api20100401Message" + ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) creating the Message resource.", "schema": { "type": "string", "minLength": 34, @@ -19952,6 +25423,200 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.message" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "Hello! \ud83d\udc4d", + "date_created": "Thu, 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": null, + "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" + } + } } } }, @@ -19964,9 +25629,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -19977,35 +25639,35 @@ "To": { "type": "string", "format": "phone-number", - "description": "The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd-party channels." + "description": "The recipient's phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/messaging/channels), e.g. `whatsapp:+15552229999`." }, "StatusCallback": { "type": "string", "format": "uri", - "description": "The URL we should call using the `status_callback_method` to send status information to your application. If specified, we POST these message status changes to the URL: `queued`, `failed`, `sent`, `delivered`, or `undelivered`. Twilio will POST its [standard request parameters](https://www.twilio.com/docs/sms/twiml#request-parameters) as well as some additional parameters including `MessageSid`, `MessageStatus`, and `ErrorCode`. If you include this parameter with the `messaging_service_sid`, we use this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/sms/services/api). URLs must contain a valid hostname and underscores are not allowed." + "description": "The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_service_sid`, Twilio uses this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource). " }, "ApplicationSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", - "description": "The SID of the application that should receive message status. We POST a `message_sid` parameter and a `message_status` parameter with a value of `sent` or `failed` to the [application](https://www.twilio.com/docs/usage/api/applications)'s `message_status_callback`. If a `status_callback` parameter is also passed, it will be ignored and the application's `message_status_callback` parameter will be used." + "description": "The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) are sent to the TwiML App's `message_status_callback` URL. Note that the `status_callback` parameter of a request takes priority over the `application_sid` parameter; if both are included `application_sid` is ignored." }, "MaxPrice": { "type": "number", - "description": "The maximum total price in US dollars that you will pay for the message to be delivered. Can be a decimal value that has up to 4 decimal places. All messages are queued for delivery and the message cost is checked before the message is sent. If the cost exceeds `max_price`, the message will fail and a status of `Failed` is sent to the status callback. If `MaxPrice` is not set, the message cost is not checked." + "description": "[DEPRECATED] This parameter will no longer have any effect as of 2024-06-03." }, "ProvideFeedback": { "type": "boolean", - "description": "Whether to confirm delivery of the message. Set this value to `true` if you are sending messages that have a trackable user action and you intend to confirm delivery of the message using the [Message Feedback API](https://www.twilio.com/docs/sms/api/message-feedback-resource). This parameter is `false` by default." + "description": "Boolean indicating whether or not you intend to provide delivery confirmation feedback to Twilio (used in conjunction with the [Message Feedback subresource](https://www.twilio.com/docs/sms/api/message-feedback-resource)). Default value is `false`." }, "Attempt": { "type": "integer", - "description": "Total number of attempts made ( including this ) to send out the message regardless of the provider used" + "description": "Total number of attempts made (including this request) to send the message regardless of the provider used" }, "ValidityPeriod": { "type": "integer", - "description": "How long in seconds the message can remain in our outgoing message queue. After this period elapses, the message fails and we call your status callback. Can be between 1 and the default value of 14,400 seconds. After a message has been accepted by a carrier, however, we cannot guarantee that the message will not be queued after this period. We recommend that this value be at least 5 seconds." + "description": "The maximum length in seconds that the Message can remain in Twilio's outgoing message queue. If a queued Message exceeds the `validity_period`, the Message is not sent. Accepted values are integers from `1` to `14400`. Default value is `14400`. A `validity_period` greater than `5` is recommended. [Learn more about the validity period](https://www.twilio.com/blog/take-more-control-of-outbound-messages-using-validity-period-html)" }, "ForceDelivery": { "type": "boolean", @@ -20030,16 +25692,16 @@ "items": { "type": "string" }, - "description": "Rich actions for Channels Messages." + "description": "Rich actions for non-SMS/MMS channels. Used for [sending location in WhatsApp messages](https://www.twilio.com/docs/whatsapp/message-features#location-messages-with-whatsapp)." }, "ShortenUrls": { "type": "boolean", - "description": "Determines the usage of Click Tracking. Setting it to `true` will instruct Twilio to replace all links in the Message with a shortened version based on the associated Domain Sid and track clicks on them. If this parameter is not set on an API call, we will use the value set on the Messaging Service. If this parameter is not set and the value is not configured on the Messaging Service used this will default to `false`." + "description": "For Messaging Services with [Link Shortening configured](https://www.twilio.com/docs/messaging/features/link-shortening) only: A Boolean indicating whether or not Twilio should shorten links in the `body` of the Message. Default value is `false`. If `true`, the `messaging_service_sid` parameter must also be provided." }, "ScheduleType": { "type": "string", "$ref": "#/components/schemas/message_enum_schedule_type", - "description": "Indicates your intent to schedule a message. Pass the value `fixed` to schedule a message at a fixed time." + "description": "For Messaging Services only: Include this parameter with a value of `fixed` in conjuction with the `send_time` parameter in order to [schedule a Message](https://www.twilio.com/docs/messaging/features/message-scheduling)." }, "SendAt": { "type": "string", @@ -20048,34 +25710,32 @@ }, "SendAsMms": { "type": "boolean", - "description": "If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media." + "description": "If set to `true`, Twilio delivers the message as a single MMS message, regardless of the presence of media." }, - "ContentSid": { + "ContentVariables": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^HX[0-9a-fA-F]{32}$", - "description": "The SID of the Content object returned at Content API content create time (https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template). If this parameter is not specified, then the Content API will not be utilized." + "description": "For [Content Editor/API](https://www.twilio.com/docs/content) only: Key-value pairs of [Template variables](https://www.twilio.com/docs/content/using-variables-with-content-api) and their substitution values. `content_sid` parameter must also be provided. If values are not defined in the `content_variables` parameter, the [Template's default placeholder values](https://www.twilio.com/docs/content/content-api-resources#create-templates) are used." }, - "ContentVariables": { + "RiskCheck": { "type": "string", - "description": "Key-value pairs of variable names to substitution values, used alongside a content_sid. If not specified, Content API will default to the default variables defined at create time." + "$ref": "#/components/schemas/message_enum_risk_check", + "description": "For SMS pumping protection feature only: Include this parameter with a value of `disable` to skip any kind of risk check on the respective message request." }, "From": { "type": "string", "format": "phone-number", - "description": "A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using `messaging_service_sid`, this parameter must be empty." + "description": "The sender's Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). The value of the `from` parameter must be a sender that is hosted within Twilio and belongs to the Account creating the Message. If you are using `messaging_service_sid`, this parameter can be empty (Twilio assigns a `from` value from the Messaging Service's Sender Pool) or you can provide a specific sender from your Sender Pool." }, "MessagingServiceSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with the Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) you have configured and leave the `from` parameter empty. When only this parameter is set, Twilio will use your enabled Copilot Features to select the `from` phone number for delivery." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services) you want to associate with the Message. When this parameter is provided and the `from` parameter is omitted, Twilio selects the optimal sender from the Messaging Service's Sender Pool. You may also provide a `from` parameter if you want to use a specific Sender from the Sender Pool." }, "Body": { "type": "string", - "description": "The text of the message you want to send. Can be up to 1,600 characters in length." + "description": "The text content of the outgoing message. Can be up to 1,600 characters in length. SMS only: If the `body` contains more than 160 [GSM-7](https://www.twilio.com/docs/glossary/what-is-gsm-7-character-encoding) characters (or 70 [UCS-2](https://www.twilio.com/docs/glossary/what-is-ucs-2-character-encoding) characters), the message is segmented and charged accordingly. For long `body` text, consider using the [send_as_mms parameter](https://www.twilio.com/blog/mms-for-long-text-messages)." }, "MediaUrl": { "type": "array", @@ -20083,12 +25743,113 @@ "type": "string", "format": "uri" }, - "description": "The URL of the media to send with the message. The media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on the recipient's device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada." + "description": "The URL of media to include in the Message content. `jpeg`, `jpg`, `gif`, and `png` file types are fully supported by Twilio and content is formatted for delivery on destination devices. The media size limit is 5 MB for supported file types (`jpeg`, `jpg`, `png`, `gif`) and 500 KB for [other types](https://www.twilio.com/docs/messaging/guides/accepted-mime-types) of accepted media. To send more than one image in the message, provide multiple `media_url` parameters in the POST request. You can include up to ten `media_url` parameters per message. [International](https://support.twilio.com/hc/en-us/articles/223179808-Sending-and-receiving-MMS-messages) and [carrier](https://support.twilio.com/hc/en-us/articles/223133707-Is-MMS-supported-for-all-carriers-in-US-and-Canada-) limits apply." + }, + "ContentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "description": "For [Content Editor/API](https://www.twilio.com/docs/content) only: The SID of the Content Template to be used with the Message, e.g., `HXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`. If this parameter is not provided, a Content Template is not used. Find the SID in the Console on the Content Editor page. For Content API users, the SID is found in Twilio's response when [creating the Template](https://www.twilio.com/docs/content/content-api-resources#create-templates) or by [fetching your Templates](https://www.twilio.com/docs/content/content-api-resources#fetch-all-content-resources)." + } + }, + "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\"}" } }, - "required": [ - "To" - ] + "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" + } + } } } } @@ -20101,18 +25862,22 @@ ], [ "body", - "media_url" + "media_url", + "content_sid" ] ] } }, "get": { - "description": "Retrieve a list of messages belonging to the account used to make the request", + "description": "Retrieve a list of Message resources associated with a Twilio Account", + "tags": [ + "Api20100401Message" + ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) associated with the Message resources.", "schema": { "type": "string", "minLength": 34, @@ -20124,46 +25889,139 @@ { "name": "To", "in": "query", - "description": "Read messages sent to only this phone number.", + "description": "Filter by recipient. For example: Set this `to` parameter to `+15558881111` to retrieve a list of Message resources with `to` properties of `+15558881111`", "schema": { "type": "string", "format": "phone-number" + }, + "x-twilio": { + "pii": { + "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" + } } }, { "name": "From", "in": "query", - "description": "Read messages sent from only this phone number or alphanumeric sender ID.", + "description": "Filter by sender. For example: Set this `from` parameter to `+15552229999` to retrieve a list of Message resources with `from` properties of `+15552229999`", "schema": { "type": "string", "format": "phone-number" + }, + "x-twilio": { + "pii": { + "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" + } } }, { "name": "DateSent", "in": "query", - "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", + "description": "Filter by Message `sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).", "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptySentdateEquals": { + "value": "2008-01-02" + } } }, { "name": "DateSent<", "in": "query", - "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", + "description": "Filter by Message `sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).", "schema": { "type": "string", "format": "date-time" + }, + "x-twilio": { + "shortDescription": "Filter by Message `sent_date`", + "ignoreFormat": true + }, + "examples": { + "readEmptySentdateLess": { + "value": "2008-01-02" + } } }, { "name": "DateSent>", "in": "query", - "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", + "description": "Filter by Message `sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).", "schema": { "type": "string", "format": "date-time" + }, + "x-twilio": { + "shortDescription": "Filter by Message `sent_date`", + "ignoreFormat": true + }, + "examples": { + "readFullPage1": { + "value": "2008-01-02" + }, + "readEmptySentdateGreater": { + "value": "2008-01-02" + }, + "readEmptySentdateGreaterFormat1": { + "value": "06/11/2019 22:05:25 MST" + }, + "readEmptySentdateGreaterFormat2": { + "value": "2019-06-11 22:05:25.000" + }, + "readEmptySentdateGreaterFormat3": { + "value": "Wed, 19 Jun 2019 22:04:00 -0000" + } } }, { @@ -20199,44 +26057,224 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListMessageResponse", - "properties": { - "messages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.message" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListMessageResponse", + "properties": { + "messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.message" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Message\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Message\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Messages\")" + }, + "examples": { + "readFullPage1": { + "value": { + "end": 1, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=1&PageToken=PAMMc26223853f8c46b4ab7dfaa6abba0a26", + "page": 0, + "page_size": 2, + "previous_page_uri": null, + "messages": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "testing", + "date_created": "Fri, 24 May 2019 17:44:46 +0000", + "date_sent": "Fri, 24 May 2019 17:44:50 +0000", + "date_updated": "Fri, 24 May 2019 17:44:50 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": "+12019235161", + "messaging_service_sid": null, + "num_media": "0", + "num_segments": "1", + "price": "-0.00750", + "price_unit": "USD", + "sid": "SMded05904ccb347238880ca9264e8fe1c", + "status": "sent", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c/Media.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c/Feedback.json" + }, + "tags": { + "campaign_name": "Spring Sale 2022", + "message_type": "cart_abandoned" + }, + "to": "+18182008801", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c.json" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "look mom I have media!", + "date_created": "Fri, 24 May 2019 17:44:46 +0000", + "date_sent": "Fri, 24 May 2019 17:44:49 +0000", + "date_updated": "Fri, 24 May 2019 17:44:49 +0000", + "direction": "inbound", + "error_code": 30004, + "error_message": "Message blocked", + "from": "+12019235161", + "messaging_service_sid": null, + "num_media": "3", + "num_segments": "1", + "price": "-0.00750", + "price_unit": "USD", + "sid": "MMc26223853f8c46b4ab7dfaa6abba0a26", + "status": "received", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26/Media.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26/Feedback.json" + }, + "tags": { + "campaign_name": "Spring Sale 2022", + "message_type": "cart_abandoned" + }, + "to": "+18182008801", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26.json" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=0" + } + }, + "readEmptySentdateLess": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3C=2008-01-02&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3C=2008-01-02&PageSize=25&Page=0" + } + }, + "readEmptySentdateEquals": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent=2008-01-02&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent=2008-01-02&PageSize=25&Page=0" + } + }, + "readEmptySentdateGreater": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=25&Page=0" + } + }, + "readEmptySentdateGreaterFormat1": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=25&Page=0" + } + }, + "readEmptySentdateGreaterFormat2": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2019-06-11+22%3A05%3A25.000&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2019-06-11+22%3A05%3A25.000&PageSize=25&Page=0" + } + }, + "readEmptySentdateGreaterFormat3": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=Wed%2C+19+Jun+2019+22%3A04%3A00+-0000&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=Wed%2C+19+Jun+2019+22%3A04%3A00+-0000&PageSize=25&Page=0" } } } @@ -20250,10 +26288,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json": { @@ -20272,20 +26307,35 @@ "direction", "date_sent" ], - "pathType": "instance", "dependentProperties": { - "media": "{account_sid: account_sid, message_sid: sid}", - "feedback": "{account_sid: account_sid, message_sid: sid}" + "media": { + "mapping": { + "account_sid": "account_sid", + "message_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Messages/{message_sid}/Media.json" + }, + "feedback": { + "mapping": { + "account_sid": "account_sid", + "message_sid": "sid" + }, + "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 record from your account", + "description": "Deletes a Message resource from your account", + "tags": [ + "Api20100401Message" + ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) associated with the Message resource", "schema": { "type": "string", "minLength": 34, @@ -20297,7 +26347,7 @@ { "name": "Sid", "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Message resource to delete.", + "description": "The SID of the Message resource you wish to delete", "schema": { "type": "string", "minLength": 34, @@ -20317,18 +26367,18 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "get": { - "description": "Fetch a message belonging to the account used to make the request", + "description": "Fetch a specific Message", + "tags": [ + "Api20100401Message" + ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) associated with the Message resource", "schema": { "type": "string", "minLength": 34, @@ -20340,7 +26390,7 @@ { "name": "Sid", "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Message resource to fetch.", + "description": "The SID of the Message resource to be fetched", "schema": { "type": "string", "minLength": 34, @@ -20356,6 +26406,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.message" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "testing", + "date_created": "Fri, 24 May 2019 17:18:27 +0000", + "date_sent": "Fri, 24 May 2019 17:18:28 +0000", + "date_updated": "Fri, 24 May 2019 17:18:28 +0000", + "direction": "outbound-api", + "error_code": 30007, + "error_message": "Carrier violation", + "from": "+12019235161", + "messaging_service_sid": "MGdeadbeefdeadbeefdeadbeefdeadbeef", + "num_media": "0", + "num_segments": "1", + "price": "-0.00750", + "price_unit": "USD", + "sid": "SMb7c0a2ce80504485a6f653a7110836f5", + "status": "sent", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json" + }, + "tags": { + "campaign_name": "Spring Sale 2022", + "message_type": "cart_abandoned" + }, + "to": "+18182008801", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json" + } + } } } }, @@ -20367,13 +26450,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "post": { - "description": "To redact a message-body from a post-flight message record, post to the message instance resource with an empty body", + "description": "Update a Message resource (used to redact Message `body` text and to cancel not-yet-sent messages)", + "tags": [ + "Api20100401Message" + ], "parameters": [ { "name": "AccountSid", @@ -20390,7 +26473,7 @@ { "name": "Sid", "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Message resource to update.", + "description": "The SID of the Message resource to be updated", "schema": { "type": "string", "minLength": 34, @@ -20406,6 +26489,64 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.message" + }, + "examples": { + "redactBody": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "", + "date_created": "Fri, 24 May 2019 17:18:27 +0000", + "date_sent": "Fri, 24 May 2019 17:18:28 +0000", + "date_updated": "Fri, 24 May 2019 17:18:28 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": "+12019235161", + "messaging_service_sid": "MGdeadbeefdeadbeefdeadbeefdeadbeef", + "num_media": "0", + "num_segments": "1", + "price": null, + "price_unit": "USD", + "sid": "SMb7c0a2ce80504485a6f653a7110836f5", + "status": "sent", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json" + }, + "tags": {}, + "to": "+18182008801", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json" + } + }, + "cancelMessage": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "Hello World!", + "date_created": "Fri, 24 May 2019 17:18:27 +0000", + "date_sent": null, + "date_updated": "Fri, 24 May 2019 18:18:28 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": null, + "messaging_service_sid": "MGdeadbeefdeadbeefdeadbeefdeadbeef", + "num_media": "0", + "num_segments": "1", + "price": null, + "price_unit": "USD", + "sid": "SMb7c0a2ce80504485a6f653a7110836f5", + "status": "canceled", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json" + }, + "tags": {}, + "to": "+18182008801", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json" + } + } } } }, @@ -20418,9 +26559,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -20430,12 +26568,24 @@ "properties": { "Body": { "type": "string", - "description": "The text of the message you want to send. Can be up to 1,600 characters long." + "description": "The new `body` of the Message resource. To redact the text content of a Message, this parameter's value must be an empty string" }, "Status": { "type": "string", "$ref": "#/components/schemas/message_enum_update_status", - "description": "When set as `canceled`, allows a message cancelation request if a message has not yet been sent." + "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" } } } @@ -20450,23 +26600,26 @@ "url": "https://api.twilio.com" } ], - "description": "Customer-provided feedback on delivery confirmation", + "description": "The MessageFeedback subresource of a Message resource. MessageFeedback contains the reported outcome of whether the Message recipient performed a tracked user action.", "x-twilio": { "defaultOutputProperties": [ "message_sid", "outcome", "date_created" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json", + "pathType": "list" }, "post": { - "description": "", + "description": "Create Message Feedback to confirm a tracked user action was performed by the recipient of the associated Message", + "tags": [ + "Api20100401Feedback" + ], "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) associated with the Message resource for which to create MessageFeedback.", "schema": { "type": "string", "minLength": 34, @@ -20478,7 +26631,7 @@ { "name": "MessageSid", "in": "path", - "description": "The SID of the Message resource for which the feedback was provided.", + "description": "The SID of the Message resource for which to create MessageFeedback.", "schema": { "type": "string", "minLength": 34, @@ -20494,6 +26647,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.message.message_feedback" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "message_sid": "MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "outcome": "confirmed", + "uri": "uri" + } + } } } }, @@ -20506,9 +26671,6 @@ } ], "operationId": "CreateMessageFeedback", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -20519,7 +26681,14 @@ "Outcome": { "type": "string", "$ref": "#/components/schemas/message_feedback_enum_outcome", - "description": "Whether the feedback has arrived. Can be: `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in [the initial HTTP POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), the initial value of this property is `unconfirmed`. After the message arrives, update the value to `confirmed`." + "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" } } } @@ -20541,11 +26710,14 @@ "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.", + "tags": [ + "Api20100401NewSigningKey" + ], "parameters": [ { "name": "AccountSid", @@ -20566,6 +26738,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.new_signing_key" + }, + "examples": { + "create": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000", + "secret": "foobar" + } + } } } }, @@ -20578,9 +26761,6 @@ } ], "operationId": "CreateNewSigningKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -20593,6 +26773,13 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "foo" + } + } } } } @@ -20603,6 +26790,9 @@ }, "get": { "description": "", + "tags": [ + "Api20100401SigningKey" + ], "parameters": [ { "name": "AccountSid", @@ -20649,44 +26839,107 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSigningKeyResponse", - "properties": { - "signing_keys": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.signing_key" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSigningKeyResponse", + "properties": { + "signing_keys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.signing_key" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"SigningKey\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"SigningKey\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"SigningKeys\")" + }, + "examples": { + "readFull": { + "value": { + "signing_keys": [ + { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readEmpty": { + "value": { + "signing_keys": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -20700,10 +26953,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSigningKey", - "x-maturity": [ - "GA" - ] + "operationId": "ListSigningKey" } }, "/2010-04-01/Accounts/{AccountSid}/Notifications/{Sid}.json": { @@ -20720,11 +26970,14 @@ "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", + "tags": [ + "Api20100401Notification" + ], "parameters": [ { "name": "AccountSid", @@ -20757,6 +27010,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.notification-instance" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Mon, 13 Sep 2010 20:02:01 +0000", + "date_updated": "Mon, 13 Sep 2010 20:02:01 +0000", + "error_code": "11200", + "log": "0", + "message_date": "Mon, 13 Sep 2010 20:02:00 +0000", + "message_text": "EmailNotification=false&LogLevel=ERROR&sourceComponent=12000&Msg=&httpResponse=500&ErrorCode=11200&url=http%3A%2F%2Fvoiceforms4000.appspot.com%2Ftwiml", + "more_info": "http://www.twilio.com/docs/errors/11200", + "request_method": "get", + "request_url": "https://voiceforms4000.appspot.com/twiml/9436/question/0", + "request_variables": "AccountSid=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&CallStatus=in-progress&ToZip=94937&ToCity=INVERNESS&ToState=CA&Called=%2B14156694923&To=%2B14156694923&ToCountry=US&CalledZip=94937&Direction=inbound&ApiVersion=2010-04-01&Caller=%2B17378742833&CalledCity=INVERNESS&CalledCountry=US&CallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&CalledState=CA&From=%2B17378742833", + "response_body": "Response body from your webhook URL as a string.", + "response_headers": "Date=Mon%2C+13+Sep+2010+20%3A02%3A00+GMT&Content-Length=466&Connection=close&Content-Type=text%2Fhtml%3B+charset%3DUTF-8&Server=Google+Frontend", + "sid": "NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -20768,10 +27044,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNotification", - "x-maturity": [ - "GA" - ] + "operationId": "FetchNotification" } }, "/2010-04-01/Accounts/{AccountSid}/Notifications.json": { @@ -20788,11 +27061,14 @@ "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", + "tags": [ + "Api20100401Notification" + ], "parameters": [ { "name": "AccountSid", @@ -20812,6 +27088,14 @@ "description": "Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read.", "schema": { "type": "integer" + }, + "examples": { + "readFull": { + "value": 1 + }, + "readEmpty": { + "value": 1 + } } }, { @@ -20821,6 +27105,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -20874,44 +27166,117 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListNotificationResponse", - "properties": { - "notifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.notification" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListNotificationResponse", + "properties": { + "notifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.notification" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Notification\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Notification\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Notifications\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0", + "previous_page_uri": null, + "next_page_uri": null, + "notifications": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Apr 2015 16:47:33 +0000", + "date_updated": "Thu, 30 Apr 2015 16:47:35 +0000", + "error_code": "21609", + "log": "1", + "message_date": "Thu, 30 Apr 2015 16:47:32 +0000", + "message_text": "LogLevel=WARN&invalidStatusCallbackUrl=&Msg=Invalid+Url+for+callSid%3A+CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa+invalid+statusCallbackUrl%3A+&ErrorCode=21609", + "more_info": "https://www.twilio.com/docs/errors/21609", + "request_method": null, + "request_url": "", + "sid": "NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "page": 0, + "page_size": 1, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0", + "next_page_uri": null, + "notifications": [], + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0" } } } @@ -20925,10 +27290,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListNotification", - "x-maturity": [ - "GA" - ] + "operationId": "ListNotification" } }, "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json": { @@ -20944,11 +27306,14 @@ "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", + "tags": [ + "Api20100401OutgoingCallerId" + ], "parameters": [ { "name": "AccountSid", @@ -20981,6 +27346,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" + }, + "examples": { + "fetch": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "(415) 867-5309", + "phone_number": "+141586753096", + "date_created": "Fri, 21 Aug 2009 00:11:24 +0000", + "date_updated": "Fri, 21 Aug 2009 00:11:24 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -20992,13 +27370,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOutgoingCallerId", - "x-maturity": [ - "GA" - ] + "operationId": "FetchOutgoingCallerId" }, "post": { "description": "Updates the caller-id", + "tags": [ + "Api20100401OutgoingCallerId" + ], "parameters": [ { "name": "AccountSid", @@ -21031,6 +27409,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 21 Aug 2009 00:11:24 +0000", + "date_updated": "Fri, 21 Aug 2009 00:11:24 +0000", + "friendly_name": "friendly_name", + "phone_number": "+141586753096", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -21043,9 +27434,6 @@ } ], "operationId": "UpdateOutgoingCallerId", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21058,6 +27446,13 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -21065,6 +27460,9 @@ }, "delete": { "description": "Delete the caller-id specified from the account", + "tags": [ + "Api20100401OutgoingCallerId" + ], "parameters": [ { "name": "AccountSid", @@ -21101,10 +27499,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteOutgoingCallerId", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteOutgoingCallerId" } }, "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json": { @@ -21120,11 +27515,14 @@ "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", + "tags": [ + "Api20100401OutgoingCallerId" + ], "parameters": [ { "name": "AccountSid", @@ -21145,6 +27543,12 @@ "schema": { "type": "string", "format": "phone-number" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -21153,6 +27557,12 @@ "description": "The string that identifies the OutgoingCallerId resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -21188,44 +27598,110 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListOutgoingCallerIdResponse", - "properties": { - "outgoing_caller_ids": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListOutgoingCallerIdResponse", + "properties": { + "outgoing_caller_ids": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"OutgoingCallerId\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"OutgoingCallerId\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"OutgoingCallerIds\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0", + "next_page_uri": null, + "outgoing_caller_ids": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 21 Aug 2009 00:11:24 +0000", + "date_updated": "Fri, 21 Aug 2009 00:11:24 +0000", + "friendly_name": "(415) 867-5309", + "phone_number": "+141586753096", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0", + "next_page_uri": null, + "outgoing_caller_ids": [], + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0" } } } @@ -21239,13 +27715,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListOutgoingCallerId", - "x-maturity": [ - "GA" - ] + "operationId": "ListOutgoingCallerId" }, "post": { "description": "", + "tags": [ + "Api20100401ValidationRequest" + ], "parameters": [ { "name": "AccountSid", @@ -21266,6 +27742,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.validation_request" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "phone_number": "+18001234567", + "validation_code": "111111" + } + } } } }, @@ -21278,9 +27765,6 @@ } ], "operationId": "CreateValidationRequest", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21327,6 +27811,18 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "CallDelay": 100, + "Extension": "extension", + "FriendlyName": "friendly_name", + "PhoneNumber": "+18001234567", + "StatusCallback": "http://www.example.com", + "StatusCallbackMethod": "GET" + } + } } } } @@ -21351,11 +27847,14 @@ "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", + "tags": [ + "Api20100401Participant" + ], "parameters": [ { "name": "AccountSid", @@ -21397,6 +27896,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference.participant" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "fetchByLabel": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -21408,13 +27945,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchParticipant" }, "post": { "description": "Update the properties of the participant", + "tags": [ + "Api20100401Participant" + ], "parameters": [ { "name": "AccountSid", @@ -21456,6 +27993,116 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference.participant" + }, + "examples": { + "muteParticipant": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "muteParticipantByLabel": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "holdParticipantWithMusic": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": true, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "announceToParticipant": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "modifyParticipant": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "complete", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "modifyParticipantByLabel": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "complete", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -21468,9 +28115,6 @@ } ], "operationId": "UpdateParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21560,6 +28204,41 @@ "description": "The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`." } } + }, + "examples": { + "muteParticipant": { + "value": { + "Muted": "true" + } + }, + "muteParticipantByLabel": { + "value": { + "Muted": "true" + } + }, + "holdParticipantWithMusic": { + "value": { + "Hold": "true", + "HoldUrl": "http://www.myapp.com/hold" + } + }, + "announceToParticipant": { + "value": { + "AnnounceUrl": "http://www.myapp.com/announce" + } + }, + "modifyParticipant": { + "value": { + "Coaching": true, + "CallSidToCoach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + }, + "modifyParticipantByLabel": { + "value": { + "Coaching": true, + "CallSidToCoach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + } } } } @@ -21567,6 +28246,9 @@ }, "delete": { "description": "Kick a participant from a given conference", + "tags": [ + "Api20100401Participant" + ], "parameters": [ { "name": "AccountSid", @@ -21612,10 +28294,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteParticipant" } }, "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json": { @@ -21633,11 +28312,14 @@ "muted", "hold" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "Api20100401Participant" + ], "parameters": [ { "name": "AccountSid", @@ -21667,6 +28349,206 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference.participant" + }, + "examples": { + "createWithSid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyName": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithSidAsCoach": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithNonE164Number": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyNameJitterBufferSize": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyNameByoc": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyNameCallerId": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "label": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyNameReason": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyNameRecordingTrack": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFromToClient": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFromToSip": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -21679,9 +28561,6 @@ } ], "operationId": "CreateParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21917,7 +28796,7 @@ }, "MachineDetection": { "type": "string", - "description": "Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. If `send_digits` is provided, this parameter is ignored. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection)." + "description": "Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection)." }, "MachineDetectionTimeout": { "type": "integer", @@ -21956,12 +28835,206 @@ "Trim": { "type": "string", "description": "Whether to trim any leading and trailing silence from the participant recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`." + }, + "CallToken": { + "type": "string", + "description": "A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call." } }, "required": [ "From", "To" ] + }, + "examples": { + "createWithSid": { + "value": { + "From": "+17736774757", + "To": "+14157663747", + "Label": "customer", + "EarlyMedia": true, + "Beep": "onEnter", + "Muted": false, + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "Trim": "do-not-trim", + "TimeLimit": 3600, + "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 + } + } } } } @@ -21969,6 +29042,9 @@ }, "get": { "description": "Retrieve a list of participants belonging to the account used to make the request", + "tags": [ + "Api20100401Participant" + ], "parameters": [ { "name": "AccountSid", @@ -22000,6 +29076,17 @@ "description": "Whether to return only participants that are muted. Can be: `true` or `false`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readNext": { + "value": "true" + }, + "readPrevious": { + "value": "true" + } } }, { @@ -22008,6 +29095,11 @@ "description": "Whether to return only participants that are on hold. Can be: `true` or `false`.", "schema": { "type": "boolean" + }, + "examples": { + "readEmpty": { + "value": true + } } }, { @@ -22051,44 +29143,225 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListParticipantResponse", - "properties": { - "participants": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.conference.participant" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListParticipantResponse", + "properties": { + "participants": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.conference.participant" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Participant\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Participant\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Participants\")" + }, + "examples": { + "readEmpty": { + "value": { + "participants": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0", + "next_page_uri": null, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0", + "page": 0, + "page_size": 50, + "end": 0, + "start": 0 + } + }, + "readFull": { + "value": { + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Sat, 19 Feb 2011 21:07:19 +0000", + "date_updated": "Sat, 19 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Sat, 19 Feb 2011 21:07:19 +0000", + "date_updated": "Sat, 19 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0", + "page": 0, + "page_size": 2, + "start": 0, + "end": 1 + } + }, + "readNext": { + "value": { + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAcccccccccccccccccccccccccccccccc", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 17 Feb 2011 21:07:19 +0000", + "date_updated": "Thu, 17 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAcccccccccccccccccccccccccccccccc.json" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAdddddddddddddddddddddddddddddddd", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 16 Feb 2011 21:07:19 +0000", + "date_updated": "Wed, 16 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAdddddddddddddddddddddddddddddddd.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=2&PageToken=PACPdddddddddddddddddddddddddddddddd", + "previous_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0&PageToken=PBCPcccccccccccccccccccccccccccccccc", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "page": 1, + "page_size": 2, + "start": 2, + "end": 3 + } + }, + "readPrevious": { + "value": { + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Sat, 19 Feb 2011 21:07:19 +0000", + "date_updated": "Sat, 19 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0&PageToken=PBCPcccccccccccccccccccccccccccccccc", + "page": 0, + "page_size": 2, + "start": 0, + "end": 1 } } } @@ -22102,10 +29375,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListParticipant" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json": { @@ -22119,11 +29389,14 @@ "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", + "tags": [ + "Api20100401Payment" + ], "parameters": [ { "name": "AccountSid", @@ -22156,6 +29429,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.payments" + }, + "examples": { + "startPaymentSessionSuccess": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000", + "date_updated": "Wed, 18 Dec 2019 20:02:01 +0000", + "sid": "PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -22168,9 +29453,6 @@ } ], "operationId": "CreatePayments", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22250,6 +29532,24 @@ "IdempotencyKey", "StatusCallback" ] + }, + "examples": { + "startPaymentSessionSuccess": { + "value": { + "ChargeAmount": "12.00", + "Currency": "USD", + "Description": "api testing", + "IdempotencyKey": "abcd", + "Input": "dtmf", + "Parameter": "{'name':'foobar'}", + "PaymentConnector": "stripe_connector", + "PaymentMethod": "credit-card", + "PostalCode": true, + "SecurityCode": true, + "StatusCallback": "https://myapp.com/payments", + "ValidCardTypes": "visa amex" + } + } } } } @@ -22267,11 +29567,14 @@ "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.", + "tags": [ + "Api20100401Payment" + ], "parameters": [ { "name": "AccountSid", @@ -22316,6 +29619,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.payments" + }, + "examples": { + "collectCreditCardNumber": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000", + "date_updated": "Wed, 18 Dec 2019 20:02:01 +0000", + "sid": "PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "collectCreditCardExpiryDate": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000", + "date_updated": "Wed, 18 Dec 2019 20:02:01 +0000", + "sid": "PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "completePayment": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000", + "date_updated": "Wed, 18 Dec 2019 20:02:01 +0000", + "sid": "PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -22328,9 +29663,6 @@ } ], "operationId": "UpdatePayments", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22362,6 +29694,29 @@ "IdempotencyKey", "StatusCallback" ] + }, + "examples": { + "collectCreditCardNumber": { + "value": { + "Capture": "payment-card-number", + "IdempotencyKey": "abcd", + "StatusCallback": "https://myapp.com/payments" + } + }, + "collectCreditCardExpiryDate": { + "value": { + "Capture": "expiration-date", + "IdempotencyKey": "abcd", + "StatusCallback": "https://myapp.com/payments" + } + }, + "completePayment": { + "value": { + "IdempotencyKey": "abcd", + "Status": "complete", + "StatusCallback": "https://myapp.com/payments" + } + } } } } @@ -22382,14 +29737,23 @@ "current_size", "average_wait_time" ], - "pathType": "instance", "dependentProperties": { - "member": "{account_sid: account_sid, queue_sid: sid}" + "members": { + "mapping": { + "account_sid": "account_sid", + "queue_sid": "sid" + }, + "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", + "tags": [ + "Api20100401Queue" + ], "parameters": [ { "name": "AccountSid", @@ -22422,6 +29786,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.queue" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "average_wait_time": 0, + "current_size": 0, + "date_created": "Tue, 04 Aug 2015 18:39:09 +0000", + "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000", + "friendly_name": "0.361280134646222", + "max_size": 100, + "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "members": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json" + } + } + } } } }, @@ -22433,13 +29815,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchQueue", - "x-maturity": [ - "GA" - ] + "operationId": "FetchQueue" }, "post": { "description": "Update the queue with the new parameters", + "tags": [ + "Api20100401Queue" + ], "parameters": [ { "name": "AccountSid", @@ -22472,6 +29854,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.queue" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "average_wait_time": 0, + "current_size": 0, + "date_created": "Tue, 04 Aug 2015 18:39:09 +0000", + "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000", + "friendly_name": "0.361280134646222", + "max_size": 100, + "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "members": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json" + } + } + } } } }, @@ -22484,9 +29884,6 @@ } ], "operationId": "UpdateQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22503,6 +29900,14 @@ "description": "The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "MaxSize": 1 + } + } } } } @@ -22510,6 +29915,9 @@ }, "delete": { "description": "Remove an empty queue", + "tags": [ + "Api20100401Queue" + ], "parameters": [ { "name": "AccountSid", @@ -22546,10 +29954,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteQueue", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteQueue" } }, "/2010-04-01/Accounts/{AccountSid}/Queues.json": { @@ -22566,14 +29971,23 @@ "current_size", "average_wait_time" ], - "pathType": "list", "dependentProperties": { - "member": "{account_sid: account_sid, queue_sid: sid}" + "members": { + "mapping": { + "account_sid": "account_sid", + "queue_sid": "sid" + }, + "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", + "tags": [ + "Api20100401Queue" + ], "parameters": [ { "name": "AccountSid", @@ -22620,44 +30034,115 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListQueueResponse", - "properties": { - "queues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.queue" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListQueueResponse", + "properties": { + "queues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.queue" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Queue\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Queue\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Queues\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "queues": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "average_wait_time": 0, + "current_size": 0, + "date_created": "Tue, 04 Aug 2015 18:39:09 +0000", + "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000", + "friendly_name": "0.361280134646222", + "max_size": 100, + "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "members": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json" + } + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "queues": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0" } } } @@ -22671,13 +30156,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListQueue", - "x-maturity": [ - "GA" - ] + "operationId": "ListQueue" }, "post": { "description": "Create a queue", + "tags": [ + "Api20100401Queue" + ], "parameters": [ { "name": "AccountSid", @@ -22698,6 +30183,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.queue" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "average_wait_time": 0, + "current_size": 0, + "date_created": "Tue, 04 Aug 2015 18:39:09 +0000", + "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000", + "friendly_name": "0.361280134646222", + "max_size": 100, + "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "members": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json" + } + } + } } } }, @@ -22710,9 +30213,6 @@ } ], "operationId": "CreateQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22732,6 +30232,14 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "MaxSize": 1 + } + } } } } @@ -22753,15 +30261,30 @@ "start_time", "duration" ], - "pathType": "instance", "dependentProperties": { - "transcription": "{account_sid: account_sid, recording_sid: sid}", - "add_on_result": "{account_sid: account_sid, reference_sid: sid}" + "transcriptions": { + "mapping": { + "account_sid": "account_sid", + "recording_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{recording_sid}/Transcriptions.json" + }, + "add_on_results": { + "mapping": { + "account_sid": "account_sid", + "reference_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults.json" + } }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a recording", + "tags": [ + "Api20100401Recording" + ], "parameters": [ { "name": "AccountSid", @@ -22793,6 +30316,11 @@ "description": "A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.", "schema": { "type": "boolean" + }, + "examples": { + "fetchIncludeSoftDeleted": { + "value": "true" + } } } ], @@ -22802,6 +30330,68 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "-0.00250", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "completed", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchIncludeSoftDeleted": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", + "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", + "start_time": "Mon, 14 Feb 2022 22:23:00 +0100", + "price": "-0.00250", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "deleted", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -22813,13 +30403,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecording" }, "delete": { "description": "Delete a recording from your account", + "tags": [ + "Api20100401Recording" + ], "parameters": [ { "name": "AccountSid", @@ -22856,10 +30446,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings.json": { @@ -22877,15 +30464,30 @@ "start_time", "duration" ], - "pathType": "list", "dependentProperties": { - "transcription": "{account_sid: account_sid, recording_sid: sid}", - "add_on_result": "{account_sid: account_sid, reference_sid: sid}" + "transcriptions": { + "mapping": { + "account_sid": "account_sid", + "recording_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{recording_sid}/Transcriptions.json" + }, + "add_on_results": { + "mapping": { + "account_sid": "account_sid", + "reference_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults.json" + } }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of recordings belonging to the account used to make the request", + "tags": [ + "Api20100401Recording" + ], "parameters": [ { "name": "AccountSid", @@ -22906,6 +30508,17 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + }, + "readIncludeSoftDeleted": { + "value": "2008-01-02" + } } }, { @@ -22915,6 +30528,17 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-01" + }, + "readEmpty": { + "value": "2008-01-01" + }, + "readIncludeSoftDeleted": { + "value": "2008-01-01" + } } }, { @@ -22924,6 +30548,17 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-03" + }, + "readEmpty": { + "value": "2008-01-03" + }, + "readIncludeSoftDeleted": { + "value": "2008-01-03" + } } }, { @@ -22954,6 +30589,11 @@ "description": "A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.", "schema": { "type": "boolean" + }, + "examples": { + "readIncludeSoftDeleted": { + "value": "True" + } } }, { @@ -22989,44 +30629,199 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListRecordingResponse", - "properties": { - "recordings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListRecordingResponse", + "properties": { + "recordings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.recording" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recordings\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "0.04", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "completed", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "recordings": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0" + } + }, + "readIncludeSoftDeleted": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 2, + "previous_page_uri": null, + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 2, + "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", + "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", + "start_time": "Mon, 14 Feb 2022 22:23:00 +0100", + "price": "0.04", + "price_unit": "USD", + "duration": "6", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "OutboundAPI", + "status": "deleted", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "channels": 2, + "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", + "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", + "start_time": "Mon, 14 Feb 2022 22:23:00 +0000", + "price": "0.04", + "price_unit": "USD", + "duration": "6", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "source": "OutboundAPI", + "status": "completed", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0" } } } @@ -23040,10 +30835,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json": { @@ -23060,14 +30852,24 @@ "add_on_sid", "date_created" ], - "pathType": "instance", "dependentProperties": { - "payload": "{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: sid}" + "payloads": { + "mapping": { + "account_sid": "account_sid", + "reference_sid": "reference_sid", + "add_on_result_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads.json" + } }, - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of an AddOnResult", + "tags": [ + "Api20100401AddOnResult" + ], "parameters": [ { "name": "AccountSid", @@ -23112,6 +30914,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + }, + "examples": { + "fetch": { + "value": { + "sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_completed": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json" + } + } + } } } }, @@ -23123,13 +30943,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingAddOnResult", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingAddOnResult" }, "delete": { "description": "Delete a result and purge all associated Payloads", + "tags": [ + "Api20100401AddOnResult" + ], "parameters": [ { "name": "AccountSid", @@ -23178,10 +30998,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecordingAddOnResult", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecordingAddOnResult" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json": { @@ -23198,14 +31015,24 @@ "add_on_sid", "date_created" ], - "pathType": "list", "dependentProperties": { - "payload": "{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: sid}" + "payloads": { + "mapping": { + "account_sid": "account_sid", + "reference_sid": "reference_sid", + "add_on_result_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads.json" + } }, - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of results belonging to the recording", + "tags": [ + "Api20100401AddOnResult" + ], "parameters": [ { "name": "AccountSid", @@ -23264,44 +31091,115 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListRecordingAddOnResultResponse", - "properties": { - "add_on_results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListRecordingAddOnResultResponse", + "properties": { + "add_on_results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AddOnResult\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AddOnResult\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AddOnResults\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "add_on_results": [ + { + "sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_completed": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json" + } + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "add_on_results": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0" } } } @@ -23315,10 +31213,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecordingAddOnResult", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecordingAddOnResult" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json": { @@ -23334,14 +31229,25 @@ "label", "content_type" ], - "pathType": "instance", "dependentProperties": { - "api/v2010/recording_add_on_result_payload_data": "{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: sid}" + "data": { + "mapping": { + "account_sid": "account_sid", + "reference_sid": "reference_sid", + "add_on_result_sid": "add_on_result_sid", + "payload_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json" + } }, - "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a result payload", + "tags": [ + "Api20100401Payload" + ], "parameters": [ { "name": "AccountSid", @@ -23398,6 +31304,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" + }, + "examples": { + "fetch": { + "value": { + "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "application/json", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json" + } + } + } } } }, @@ -23409,13 +31334,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingAddOnResultPayload", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingAddOnResultPayload" }, "delete": { "description": "Delete a payload from the result along with all associated Data", + "tags": [ + "Api20100401Payload" + ], "parameters": [ { "name": "AccountSid", @@ -23476,10 +31401,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecordingAddOnResultPayload", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecordingAddOnResultPayload" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json": { @@ -23495,14 +31417,25 @@ "label", "content_type" ], - "pathType": "list", "dependentProperties": { - "api/v2010/recording_add_on_result_payload_data": "{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: sid}" + "data": { + "mapping": { + "account_sid": "account_sid", + "reference_sid": "reference_sid", + "add_on_result_sid": "add_on_result_sid", + "payload_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json" + } }, - "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of payloads belonging to the AddOnResult", + "tags": [ + "Api20100401Payload" + ], "parameters": [ { "name": "AccountSid", @@ -23573,44 +31506,116 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListRecordingAddOnResultPayloadResponse", - "properties": { - "payloads": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListRecordingAddOnResultPayloadResponse", + "properties": { + "payloads": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Payload\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Payload\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Payloads\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "payloads": [ + { + "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "application/json", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json" + } + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "payloads": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0" } } } @@ -23624,10 +31629,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecordingAddOnResultPayload", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecordingAddOnResultPayload" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json": { @@ -23644,11 +31646,14 @@ "status", "duration" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "Api20100401Transcription" + ], "parameters": [ { "name": "AccountSid", @@ -23693,6 +31698,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "date_created": "Mon, 22 Aug 2011 20:58:44 +0000", + "date_updated": "Mon, 22 Aug 2011 20:58:44 +0000", + "duration": "10", + "price": "0.00000", + "price_unit": "USD", + "recording_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "in-progress", + "transcription_text": "THIS IS A TEST", + "type": "fast", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -23704,13 +31728,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingTranscription" }, "delete": { "description": "", + "tags": [ + "Api20100401Transcription" + ], "parameters": [ { "name": "AccountSid", @@ -23759,10 +31783,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecordingTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecordingTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions.json": { @@ -23779,11 +31800,14 @@ "status", "duration" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Transcription" + ], "parameters": [ { "name": "AccountSid", @@ -23842,44 +31866,122 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListRecordingTranscriptionResponse", - "properties": { - "transcriptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListRecordingTranscriptionResponse", + "properties": { + "transcriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Transcription\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Transcription\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Transcriptions\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "transcriptions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "date_created": "Mon, 22 Aug 2011 20:58:44 +0000", + "date_updated": "Mon, 22 Aug 2011 20:58:44 +0000", + "duration": "10", + "price": "0.00000", + "price_unit": "USD", + "recording_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "in-progress", + "transcription_text": "THIS IS A TEST", + "type": "fast", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "transcriptions": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0" } } } @@ -23893,10 +31995,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecordingTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecordingTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json": { @@ -23912,11 +32011,14 @@ "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", + "tags": [ + "Api20100401ShortCode" + ], "parameters": [ { "name": "AccountSid", @@ -23949,6 +32051,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.short_code" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": null, + "date_updated": null, + "friendly_name": "API_CLUSTER_TEST_SHORT_CODE", + "short_code": "99990", + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "POST", + "sms_fallback_url": null, + "sms_method": "POST", + "sms_url": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -23960,13 +32080,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchShortCode", - "x-maturity": [ - "GA" - ] + "operationId": "FetchShortCode" }, "post": { "description": "Update a short code with the following parameters", + "tags": [ + "Api20100401ShortCode" + ], "parameters": [ { "name": "AccountSid", @@ -23999,6 +32119,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.short_code" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": null, + "date_updated": null, + "friendly_name": "API_CLUSTER_TEST_SHORT_CODE", + "short_code": "99990", + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "POST", + "sms_fallback_url": null, + "sms_method": "POST", + "sms_url": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -24011,9 +32149,6 @@ } ], "operationId": "UpdateShortCode", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -24066,6 +32201,18 @@ "description": "The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`." } } + }, + "examples": { + "update": { + "value": { + "ApiVersion": "api_version", + "FriendlyName": "friendly_name", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com" + } + } } } } @@ -24085,11 +32232,14 @@ "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", + "tags": [ + "Api20100401ShortCode" + ], "parameters": [ { "name": "AccountSid", @@ -24109,6 +32259,14 @@ "description": "The string that identifies the ShortCode resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -24117,6 +32275,14 @@ "description": "Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "short_code" + }, + "readEmpty": { + "value": "short_code" + } } }, { @@ -24152,44 +32318,121 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListShortCodeResponse", - "properties": { - "short_codes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.short_code" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListShortCodeResponse", + "properties": { + "short_codes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.short_code" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"ShortCode\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"ShortCode\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ShortCodes\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "short_codes": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": null, + "date_updated": null, + "friendly_name": "API_CLUSTER_TEST_SHORT_CODE", + "short_code": "99990", + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "POST", + "sms_fallback_url": null, + "sms_method": "POST", + "sms_url": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "short_codes": [], + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json" } } } @@ -24203,10 +32446,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListShortCode", - "x-maturity": [ - "GA" - ] + "operationId": "ListShortCode" } }, "/2010-04-01/Accounts/{AccountSid}/SigningKeys/{Sid}.json": { @@ -24215,17 +32455,20 @@ "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": "", + "tags": [ + "Api20100401SigningKey" + ], "parameters": [ { "name": "AccountSid", @@ -24258,6 +32501,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.signing_key" + }, + "examples": { + "fetch": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + } } } }, @@ -24269,13 +32522,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSigningKey", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSigningKey" }, "post": { "description": "", + "tags": [ + "Api20100401SigningKey" + ], "parameters": [ { "name": "AccountSid", @@ -24308,6 +32561,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.signing_key" + }, + "examples": { + "update": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + } } } }, @@ -24320,9 +32583,6 @@ } ], "operationId": "UpdateSigningKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -24335,6 +32595,13 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "foo" + } + } } } } @@ -24342,6 +32609,9 @@ }, "delete": { "description": "", + "tags": [ + "Api20100401SigningKey" + ], "parameters": [ { "name": "AccountSid", @@ -24378,10 +32648,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSigningKey", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSigningKey" } }, "/2010-04-01/Accounts/{AccountSid}/SIP.json": { @@ -24390,11 +32657,11 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json": { @@ -24403,12 +32670,12 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Accounts/{AccountSid}/SIP/Domains/{Sid}.json", - "className": "auth_types" + "className": "auth_types", + "pathType": "list" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json": { @@ -24417,12 +32684,12 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json", - "className": "auth_type_calls" + "className": "auth_type_calls", + "pathType": "list" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json": { @@ -24437,12 +32704,15 @@ "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", + "tags": [ + "Api20100401AuthCallsCredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -24475,6 +32745,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -24487,9 +32768,6 @@ } ], "operationId": "CreateSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -24508,6 +32786,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -24515,6 +32800,9 @@ }, "get": { "description": "Retrieve a list of credential list mappings belonging to the domain used in the request", + "tags": [ + "Api20100401AuthCallsCredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -24573,44 +32861,108 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipAuthCallsCredentialListMappingResponse", - "properties": { - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipAuthCallsCredentialListMappingResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AuthCallsCredentialListMapping\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AuthCallsCredentialListMapping\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Contents\")" + }, + "examples": { + "readEmpty": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readFull": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -24624,10 +32976,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipAuthCallsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json": { @@ -24642,12 +32991,15 @@ "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", + "tags": [ + "Api20100401AuthCallsCredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -24692,6 +33044,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -24703,13 +33066,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipAuthCallsCredentialListMapping" }, "delete": { "description": "Delete a credential list mapping from the requested domain", + "tags": [ + "Api20100401AuthCallsCredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -24758,10 +33121,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipAuthCallsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings.json": { @@ -24776,12 +33136,15 @@ "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", + "tags": [ + "Api20100401AuthCallsIpAccessControlListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -24814,6 +33177,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -24826,9 +33200,6 @@ } ], "operationId": "CreateSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -24847,6 +33218,13 @@ "required": [ "IpAccessControlListSid" ] + }, + "examples": { + "create": { + "value": { + "IpAccessControlListSid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -24854,6 +33232,9 @@ }, "get": { "description": "Retrieve a list of IP Access Control List mappings belonging to the domain used in the request", + "tags": [ + "Api20100401AuthCallsIpAccessControlListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -24912,44 +33293,108 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipAuthCallsIpAccessControlListMappingResponse", - "properties": { - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipAuthCallsIpAccessControlListMappingResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AuthCallsIpAccessControlListMapping\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AuthCallsIpAccessControlListMapping\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Contents\")" + }, + "examples": { + "readEmpty": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readFull": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -24963,10 +33408,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipAuthCallsIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings/{Sid}.json": { @@ -24981,12 +33423,15 @@ "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", + "tags": [ + "Api20100401AuthCallsIpAccessControlListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -25031,6 +33476,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -25042,13 +33498,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipAuthCallsIpAccessControlListMapping" }, "delete": { "description": "Delete an IP Access Control List mapping from the requested domain", + "tags": [ + "Api20100401AuthCallsIpAccessControlListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -25097,10 +33553,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipAuthCallsIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations.json": { @@ -25109,12 +33562,12 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json", - "className": "auth_type_registrations" + "className": "auth_type_registrations", + "pathType": "list" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings.json": { @@ -25129,12 +33582,15 @@ "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", + "tags": [ + "Api20100401AuthRegistrationsCredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -25167,6 +33623,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -25179,9 +33646,6 @@ } ], "operationId": "CreateSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -25200,6 +33664,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -25207,6 +33678,9 @@ }, "get": { "description": "Retrieve a list of credential list mappings belonging to the domain used in the request", + "tags": [ + "Api20100401AuthRegistrationsCredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -25265,44 +33739,108 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipAuthRegistrationsCredentialListMappingResponse", - "properties": { - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipAuthRegistrationsCredentialListMappingResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AuthRegistrationsCredentialListMapping\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AuthRegistrationsCredentialListMapping\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Contents\")" + }, + "examples": { + "readEmpty": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readFull": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -25316,10 +33854,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipAuthRegistrationsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings/{Sid}.json": { @@ -25334,12 +33869,15 @@ "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", + "tags": [ + "Api20100401AuthRegistrationsCredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -25384,6 +33922,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -25395,13 +33944,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipAuthRegistrationsCredentialListMapping" }, "delete": { "description": "Delete a credential list mapping from the requested domain", + "tags": [ + "Api20100401AuthRegistrationsCredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -25450,10 +33999,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipAuthRegistrationsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json": { @@ -25469,11 +34015,14 @@ "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.", + "tags": [ + "Api20100401Credential" + ], "parameters": [ { "name": "AccountSid", @@ -25532,44 +34081,110 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipCredentialResponse", - "properties": { - "credentials": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipCredentialResponse", + "properties": { + "credentials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Credential\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Credential\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Credentials\")" + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "credential_list_sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 19 Aug 2015 19:48:45 +0000", + "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "username": "1440013725.28" + } + ], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "credentials": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0" } } } @@ -25583,13 +34198,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipCredential" }, "post": { "description": "Create a new credential resource.", + "tags": [ + "Api20100401Credential" + ], "parameters": [ { "name": "AccountSid", @@ -25622,6 +34237,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "credential_list_sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 19 Aug 2015 19:48:45 +0000", + "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "username": "1440013725.28" + } + } } } }, @@ -25634,9 +34262,6 @@ } ], "operationId": "CreateSipCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -25657,6 +34282,14 @@ "Username", "Password" ] + }, + "examples": { + "create": { + "value": { + "Password": "password", + "Username": "username" + } + } } } } @@ -25676,11 +34309,14 @@ "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.", + "tags": [ + "Api20100401Credential" + ], "parameters": [ { "name": "AccountSid", @@ -25725,6 +34361,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "credential_list_sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 19 Aug 2015 19:48:45 +0000", + "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "username": "1440013725.28" + } + } } } }, @@ -25736,13 +34385,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipCredential" }, "post": { "description": "Update a credential resource.", + "tags": [ + "Api20100401Credential" + ], "parameters": [ { "name": "AccountSid", @@ -25787,6 +34436,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "credential_list_sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 19 Aug 2015 19:48:45 +0000", + "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "username": "username" + } + } } } }, @@ -25799,9 +34461,6 @@ } ], "operationId": "UpdateSipCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -25814,6 +34473,13 @@ "description": "The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)" } } + }, + "examples": { + "update": { + "value": { + "Password": "password" + } + } } } } @@ -25821,6 +34487,9 @@ }, "delete": { "description": "Delete a credential resource.", + "tags": [ + "Api20100401Credential" + ], "parameters": [ { "name": "AccountSid", @@ -25869,10 +34538,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipCredential" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json": { @@ -25887,14 +34553,23 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "credential": "{account_sid: account_sid, credential_list_sid: sid}" + "credentials": { + "mapping": { + "account_sid": "account_sid", + "credential_list_sid": "sid" + }, + "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", + "tags": [ + "Api20100401CredentialList" + ], "parameters": [ { "name": "AccountSid", @@ -25941,44 +34616,112 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipCredentialListResponse", - "properties": { - "credential_lists": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipCredentialListResponse", + "properties": { + "credential_lists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"CredentialList\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"CredentialList\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"CredentialLists\")" + }, + "examples": { + "readFull": { + "value": { + "credential_lists": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Low Rises", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0", + "next_page_uri": null, + "start": 0, + "end": 0, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "credential_lists": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0", + "next_page_uri": null, + "start": 0, + "end": 0, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0" } } } @@ -25992,13 +34735,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipCredentialList" }, "post": { "description": "Create a Credential List", + "tags": [ + "Api20100401CredentialList" + ], "parameters": [ { "name": "AccountSid", @@ -26019,6 +34762,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Low Rises", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -26031,9 +34789,6 @@ } ], "operationId": "CreateSipCredentialList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26049,6 +34804,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -26067,14 +34829,23 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "credential": "{account_sid: account_sid, credential_list_sid: sid}" + "credentials": { + "mapping": { + "account_sid": "account_sid", + "credential_list_sid": "sid" + }, + "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", + "tags": [ + "Api20100401CredentialList" + ], "parameters": [ { "name": "AccountSid", @@ -26107,6 +34878,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Low Rises", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -26118,13 +34904,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipCredentialList" }, "post": { "description": "Update a Credential List", + "tags": [ + "Api20100401CredentialList" + ], "parameters": [ { "name": "AccountSid", @@ -26157,6 +34943,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Low Rises", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -26169,9 +34970,6 @@ } ], "operationId": "UpdateSipCredentialList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26187,6 +34985,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -26194,6 +34999,9 @@ }, "delete": { "description": "Delete a Credential List", + "tags": [ + "Api20100401CredentialList" + ], "parameters": [ { "name": "AccountSid", @@ -26230,10 +35038,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipCredentialList" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings.json": { @@ -26248,11 +35053,14 @@ "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.", + "tags": [ + "Api20100401CredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -26285,6 +35093,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Production Gateways IP Address - Scranton", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -26297,9 +35118,6 @@ } ], "operationId": "CreateSipCredentialListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26318,6 +35136,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -26325,6 +35150,9 @@ }, "get": { "description": "Read multiple CredentialListMapping resources from an account.", + "tags": [ + "Api20100401CredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -26383,44 +35211,110 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipCredentialListMappingResponse", - "properties": { - "credential_list_mappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipCredentialListMappingResponse", + "properties": { + "credential_list_mappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"CredentialListMapping\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"CredentialListMapping\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"CredentialListMappings\")" + }, + "examples": { + "readFull": { + "value": { + "credential_list_mappings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Production Gateways IP Address - Scranton", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0", + "next_page_uri": null, + "start": 0, + "end": 0, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "credential_list_mappings": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0", + "next_page_uri": null, + "start": 0, + "end": 0, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0" } } } @@ -26434,10 +35328,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings/{Sid}.json": { @@ -26452,11 +35343,14 @@ "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.", + "tags": [ + "Api20100401CredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -26501,6 +35395,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Production Gateways IP Address - Scranton", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -26512,13 +35419,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipCredentialListMapping" }, "delete": { "description": "Delete a CredentialListMapping resource from an account.", + "tags": [ + "Api20100401CredentialListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -26567,10 +35474,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains.json": { @@ -26586,16 +35490,37 @@ "domain_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "ip_access_control_list_mapping": "{account_sid: account_sid, domain_sid: sid}", - "credential_list_mapping": "{account_sid: account_sid, domain_sid: sid}", - "auth_types": "{account_sid: account_sid, domain_sid: sid}" + "ip_access_control_list_mappings": { + "mapping": { + "account_sid": "account_sid", + "domain_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/IpAccessControlListMappings.json" + }, + "credential_list_mappings": { + "mapping": { + "account_sid": "account_sid", + "domain_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/CredentialListMappings.json" + }, + "auth": { + "mapping": { + "account_sid": "account_sid", + "domain_sid": "sid" + }, + "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", + "tags": [ + "Api20100401Domain" + ], "parameters": [ { "name": "AccountSid", @@ -26642,44 +35567,127 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipDomainResponse", - "properties": { - "domains": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipDomainResponse", + "properties": { + "domains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Domain\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Domain\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Domains\")" + }, + "examples": { + "readFull": { + "value": { + "domains": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "auth_type": "IP_ACL", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "domain_name": "dunder-mifflin-scranton.sip.twilio.com", + "friendly_name": "Scranton Office", + "sip_registration": true, + "sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credential_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json", + "ip_access_control_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_status_callback_method": "POST", + "voice_status_callback_url": null, + "voice_url": "https://dundermifflin.example.com/twilio/app.php", + "emergency_calling_enabled": true, + "secure": true, + "byoc_trunk_sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_caller_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "start": 0, + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "domains": [], + "start": 0, + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0" } } } @@ -26693,13 +35701,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipDomain" }, "post": { "description": "Create a new Domain", + "tags": [ + "Api20100401Domain" + ], "parameters": [ { "name": "AccountSid", @@ -26720,6 +35728,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "auth_type": "IP_ACL", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "domain_name": "dunder-mifflin-scranton.sip.twilio.com", + "friendly_name": "Scranton Office", + "sip_registration": true, + "sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credential_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json", + "ip_access_control_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_status_callback_method": "POST", + "voice_status_callback_url": null, + "voice_url": "https://dundermifflin.example.com/twilio/app.php", + "emergency_calling_enabled": true, + "secure": true, + "byoc_trunk_sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_caller_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -26732,9 +35770,6 @@ } ], "operationId": "CreateSipDomain", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26834,6 +35869,25 @@ "required": [ "DomainName" ] + }, + "examples": { + "create": { + "value": { + "DomainName": "dunder-mifflin-scranton.sip.twilio.com", + "FriendlyName": "Scranton Office", + "VoiceFallbackMethod": "POST", + "VoiceFallbackUrl": "", + "VoiceMethod": "POST", + "VoiceStatusCallbackMethod": "POST", + "VoiceStatusCallbackUrl": "", + "VoiceUrl": "https://dundermifflin.example.com/twilio/app.php", + "SipRegistration": true, + "EmergencyCallingEnabled": true, + "Secure": true, + "ByocTrunkSid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "EmergencyCallerSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -26853,16 +35907,37 @@ "domain_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "ip_access_control_list_mapping": "{account_sid: account_sid, domain_sid: sid}", - "credential_list_mapping": "{account_sid: account_sid, domain_sid: sid}", - "auth_types": "{account_sid: account_sid, domain_sid: sid}" + "ip_access_control_list_mappings": { + "mapping": { + "account_sid": "account_sid", + "domain_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/IpAccessControlListMappings.json" + }, + "credential_list_mappings": { + "mapping": { + "account_sid": "account_sid", + "domain_sid": "sid" + }, + "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/CredentialListMappings.json" + }, + "auth": { + "mapping": { + "account_sid": "account_sid", + "domain_sid": "sid" + }, + "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", + "tags": [ + "Api20100401Domain" + ], "parameters": [ { "name": "AccountSid", @@ -26895,6 +35970,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "auth_type": "IP_ACL", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "domain_name": "dunder-mifflin-scranton.sip.twilio.com", + "friendly_name": "Scranton Office", + "sip_registration": true, + "sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credential_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json", + "ip_access_control_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_status_callback_method": "POST", + "voice_status_callback_url": null, + "voice_url": "https://dundermifflin.example.com/twilio/app.php", + "emergency_calling_enabled": true, + "secure": true, + "byoc_trunk_sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_caller_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -26906,13 +36011,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipDomain" }, "post": { "description": "Update the attributes of a domain", + "tags": [ + "Api20100401Domain" + ], "parameters": [ { "name": "AccountSid", @@ -26945,6 +36050,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "auth_type": "IP_ACL", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "domain_name": "dunder-mifflin-scranton.sip.twilio.com", + "friendly_name": "Scranton Office", + "sip_registration": true, + "sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credential_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json", + "ip_access_control_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_status_callback_method": "POST", + "voice_status_callback_url": null, + "voice_url": "https://dundermifflin.example.com/twilio/app.php", + "emergency_calling_enabled": true, + "secure": true, + "byoc_trunk_sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_caller_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -26957,9 +36092,6 @@ } ], "operationId": "UpdateSipDomain", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27056,6 +36188,25 @@ "description": "Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call." } } + }, + "examples": { + "update": { + "value": { + "DomainName": "dunder-mifflin-scranton.sip.twilio.com", + "FriendlyName": "Scranton Office", + "VoiceFallbackMethod": "POST", + "VoiceFallbackUrl": "", + "VoiceMethod": "POST", + "VoiceStatusCallbackMethod": "POST", + "VoiceStatusCallbackUrl": "", + "VoiceUrl": "https://dundermifflin.example.com/twilio/app.php", + "SipRegistration": true, + "EmergencyCallingEnabled": true, + "Secure": true, + "ByocTrunkSid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "EmergencyCallerSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -27063,6 +36214,9 @@ }, "delete": { "description": "Delete an instance of a Domain", + "tags": [ + "Api20100401Domain" + ], "parameters": [ { "name": "AccountSid", @@ -27099,10 +36253,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipDomain" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists.json": { @@ -27117,14 +36268,23 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "ip_address": "{account_sid: account_sid, ip_access_control_list_sid: sid}" + "ip_addresses": { + "mapping": { + "account_sid": "account_sid", + "ip_access_control_list_sid": "sid" + }, + "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", + "tags": [ + "Api20100401IpAccessControlList" + ], "parameters": [ { "name": "AccountSid", @@ -27171,44 +36331,112 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipIpAccessControlListResponse", - "properties": { - "ip_access_control_lists": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipIpAccessControlListResponse", + "properties": { + "ip_access_control_lists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"IpAccessControlList\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"IpAccessControlList\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAccessControlLists\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0", + "ip_access_control_lists": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "ip_addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0", + "ip_access_control_lists": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0" } } } @@ -27222,13 +36450,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipIpAccessControlList" }, "post": { "description": "Create a new IpAccessControlList resource", + "tags": [ + "Api20100401IpAccessControlList" + ], "parameters": [ { "name": "AccountSid", @@ -27249,6 +36477,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "ip_addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27261,9 +36504,6 @@ } ], "operationId": "CreateSipIpAccessControlList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27279,6 +36519,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -27297,14 +36544,23 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "ip_address": "{account_sid: account_sid, ip_access_control_list_sid: sid}" + "ip_addresses": { + "mapping": { + "account_sid": "account_sid", + "ip_access_control_list_sid": "sid" + }, + "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", + "tags": [ + "Api20100401IpAccessControlList" + ], "parameters": [ { "name": "AccountSid", @@ -27337,6 +36593,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "ip_addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27348,13 +36619,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipIpAccessControlList" }, "post": { "description": "Rename an IpAccessControlList", + "tags": [ + "Api20100401IpAccessControlList" + ], "parameters": [ { "name": "AccountSid", @@ -27387,6 +36658,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "ip_addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27399,9 +36685,6 @@ } ], "operationId": "UpdateSipIpAccessControlList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27417,6 +36700,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -27424,6 +36714,9 @@ }, "delete": { "description": "Delete an IpAccessControlList from the requested account", + "tags": [ + "Api20100401IpAccessControlList" + ], "parameters": [ { "name": "AccountSid", @@ -27460,10 +36753,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipIpAccessControlList" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings/{Sid}.json": { @@ -27478,11 +36768,14 @@ "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.", + "tags": [ + "Api20100401IpAccessControlListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -27527,6 +36820,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27538,13 +36844,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipIpAccessControlListMapping" }, "delete": { "description": "Delete an IpAccessControlListMapping resource.", + "tags": [ + "Api20100401IpAccessControlListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -27593,10 +36899,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings.json": { @@ -27611,11 +36914,14 @@ "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.", + "tags": [ + "Api20100401IpAccessControlListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -27648,6 +36954,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27660,9 +36979,6 @@ } ], "operationId": "CreateSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27681,6 +36997,13 @@ "required": [ "IpAccessControlListSid" ] + }, + "examples": { + "create": { + "value": { + "IpAccessControlListSid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -27688,6 +37011,9 @@ }, "get": { "description": "Retrieve a list of IpAccessControlListMapping resources.", + "tags": [ + "Api20100401IpAccessControlListMapping" + ], "parameters": [ { "name": "AccountSid", @@ -27746,44 +37072,110 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipIpAccessControlListMappingResponse", - "properties": { - "ip_access_control_list_mappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipIpAccessControlListMappingResponse", + "properties": { + "ip_access_control_list_mappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"IpAccessControlListMapping\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"IpAccessControlListMapping\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAccessControlListMappings\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0", + "ip_access_control_list_mappings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0", + "ip_access_control_list_mappings": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0" } } } @@ -27797,10 +37189,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json": { @@ -27816,11 +37205,14 @@ "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.", + "tags": [ + "Api20100401IpAddress" + ], "parameters": [ { "name": "AccountSid", @@ -27879,44 +37271,112 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipIpAddressResponse", - "properties": { - "ip_addresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipIpAddressResponse", + "properties": { + "ip_addresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"IpAddress\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"IpAddress\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAddresses\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0", + "ip_addresses": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "friendly_name": "friendly_name", + "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.1", + "cidr_prefix_length": 32, + "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0", + "ip_addresses": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0" } } } @@ -27930,13 +37390,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipIpAddress", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipIpAddress" }, "post": { "description": "Create a new IpAddress resource.", + "tags": [ + "Api20100401IpAddress" + ], "parameters": [ { "name": "AccountSid", @@ -27969,6 +37429,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "friendly_name": "friendly_name", + "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.1", + "cidr_prefix_length": 32, + "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27981,9 +37456,6 @@ } ], "operationId": "CreateSipIpAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -28008,6 +37480,15 @@ "FriendlyName", "IpAddress" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "IpAddress": "192.168.1.1", + "CidrPrefixLength": 32 + } + } } } } @@ -28027,11 +37508,14 @@ "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.", + "tags": [ + "Api20100401IpAddress" + ], "parameters": [ { "name": "AccountSid", @@ -28076,6 +37560,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "friendly_name": "friendly_name", + "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.1", + "cidr_prefix_length": 32, + "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -28087,13 +37586,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipIpAddress", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipIpAddress" }, "post": { "description": "Update an IpAddress resource.", + "tags": [ + "Api20100401IpAddress" + ], "parameters": [ { "name": "AccountSid", @@ -28138,6 +37637,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "friendly_name": "friendly_name", + "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.1", + "cidr_prefix_length": 32, + "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -28150,9 +37664,6 @@ } ], "operationId": "UpdateSipIpAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -28173,6 +37684,15 @@ "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "IpAddress": "192.168.1.1", + "CidrPrefixLength": 32 + } + } } } } @@ -28180,6 +37700,9 @@ }, "delete": { "description": "Delete an IpAddress resource.", + "tags": [ + "Api20100401IpAddress" + ], "parameters": [ { "name": "AccountSid", @@ -28228,10 +37751,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipIpAddress", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipIpAddress" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec.json": { @@ -28246,11 +37766,14 @@ "call_sid", "name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a Siprec", + "tags": [ + "Api20100401Siprec" + ], "parameters": [ { "name": "AccountSid", @@ -28283,6 +37806,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.siprec" + }, + "examples": { + "createNoArgs": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": null, + "status": "in-progress", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithArgs": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "myName", + "status": "in-progress", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -28295,9 +37842,6 @@ } ], "operationId": "CreateSiprec", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -29129,6 +38673,26 @@ "description": "Parameter value" } } + }, + "examples": { + "createNoArgs": { + "value": {} + }, + "createWithArgs": { + "value": { + "Name": "myName", + "ConnectorName": "myConnectorName", + "Track": "inbound_track", + "StatusCallback": "http://statuscallback.com", + "StatusCallbackMethod": "PUT", + "Parameter1.Name": "name1", + "Parameter1.Value": "value1", + "Parameter2.Name": "name2", + "Parameter2.Value": "value2", + "Parameter3.Name": "name3", + "Parameter3.Value": "value3" + } + } } } } @@ -29147,11 +38711,14 @@ "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", + "tags": [ + "Api20100401Siprec" + ], "parameters": [ { "name": "AccountSid", @@ -29193,6 +38760,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.siprec" + }, + "examples": { + "updateBySid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": null, + "status": "stopped", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "updateByName": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "mySiprec", + "status": "stopped", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -29205,9 +38796,6 @@ } ], "operationId": "UpdateSiprec", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -29224,6 +38812,18 @@ "required": [ "Status" ] + }, + "examples": { + "updateBySid": { + "value": { + "Status": "stopped" + } + }, + "updateByName": { + "value": { + "Status": "stopped" + } + } } } } @@ -29242,11 +38842,14 @@ "call_sid", "name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a Stream", + "tags": [ + "Api20100401Stream" + ], "parameters": [ { "name": "AccountSid", @@ -29279,6 +38882,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.stream" + }, + "examples": { + "createNoArgs": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": null, + "status": "in-progress", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithArgs": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "myName", + "status": "in-progress", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -29291,9 +38918,6 @@ } ], "operationId": "CreateStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -30129,6 +39753,28 @@ "required": [ "Url" ] + }, + "examples": { + "createNoArgs": { + "value": { + "Url": "myUrl" + } + }, + "createWithArgs": { + "value": { + "Name": "myName", + "Url": "myUrl", + "Track": "inbound_track", + "StatusCallback": "http://statuscallback.com", + "StatusCallbackMethod": "PUT", + "Parameter1.Name": "name1", + "Parameter1.Value": "value1", + "Parameter2.Name": "name2", + "Parameter2.Value": "value2", + "Parameter3.Name": "name3", + "Parameter3.Value": "value3" + } + } } } } @@ -30147,11 +39793,14 @@ "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", + "tags": [ + "Api20100401Stream" + ], "parameters": [ { "name": "AccountSid", @@ -30193,6 +39842,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.stream" + }, + "examples": { + "updateBySid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": null, + "status": "stopped", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "updateByName": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "myStream", + "status": "stopped", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -30205,9 +39878,6 @@ } ], "operationId": "UpdateStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -30224,6 +39894,18 @@ "required": [ "Status" ] + }, + "examples": { + "updateBySid": { + "value": { + "Status": "stopped" + } + }, + "updateByName": { + "value": { + "Status": "stopped" + } + } } } } @@ -30242,11 +39924,14 @@ "username", "ice_servers" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a new token for ICE servers", + "tags": [ + "Api20100401Token" + ], "parameters": [ { "name": "AccountSid", @@ -30267,6 +39952,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.token" + }, + "examples": { + "create": { + "value": { + "username": "dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269", + "ice_servers": [ + { + "urls": "stun:global.stun.twilio.com:3478" + }, + { + "username": "dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269", + "credential": "tE2DajzSJwnsSbc123", + "urls": "turn:global.turn.twilio.com:3478?transport=udp" + }, + { + "username": "dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269", + "credential": "tE2DajzSJwnsSbc123", + "urls": "turn:global.turn.twilio.com:3478?transport=tcp" + }, + { + "username": "dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269", + "credential": "tE2DajzSJwnsSbc123", + "urls": "turn:global.turn.twilio.com:443?transport=tcp" + } + ], + "date_updated": "Fri, 01 May 2020 01:42:57 +0000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ttl": "86400", + "date_created": "Fri, 01 May 2020 01:42:57 +0000", + "password": "tE2DajzSJwnsSbc123" + } + } } } }, @@ -30279,9 +39996,6 @@ } ], "operationId": "CreateToken", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -30294,6 +40008,13 @@ "description": "The duration in seconds for which the generated credentials are valid. The default value is 86400 (24 hours)." } } + }, + "examples": { + "create": { + "value": { + "Ttl": 1 + } + } } } } @@ -30314,11 +40035,14 @@ "status", "duration" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a Transcription", + "tags": [ + "Api20100401Transcription" + ], "parameters": [ { "name": "AccountSid", @@ -30351,6 +40075,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.transcription" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "date_created": "Sun, 13 Feb 2011 02:12:08 +0000", + "date_updated": "Sun, 13 Feb 2011 02:30:01 +0000", + "duration": "1", + "price": "-0.05000", + "price_unit": "USD", + "recording_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "transcription_text": "(blank)", + "type": "fast", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -30362,13 +40105,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTranscription" }, "delete": { "description": "Delete a transcription from the account used to make the request", + "tags": [ + "Api20100401Transcription" + ], "parameters": [ { "name": "AccountSid", @@ -30405,10 +40148,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/Transcriptions.json": { @@ -30425,11 +40165,14 @@ "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", + "tags": [ + "Api20100401Transcription" + ], "parameters": [ { "name": "AccountSid", @@ -30476,44 +40219,122 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListTranscriptionResponse", - "properties": { - "transcriptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.transcription" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListTranscriptionResponse", + "properties": { + "transcriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.transcription" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Transcription\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Transcription\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Transcriptions\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=3", + "next_page_uri": null, + "num_pages": 4, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 4, + "transcriptions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "date_created": "Thu, 25 Aug 2011 20:59:45 +0000", + "date_updated": "Thu, 25 Aug 2011 20:59:45 +0000", + "duration": "10", + "price": "0.00000", + "price_unit": "USD", + "recording_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "transcription_text": null, + "type": "fast", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=3", + "next_page_uri": null, + "num_pages": 4, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 4, + "transcriptions": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0" } } } @@ -30527,10 +40348,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "ListTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/Usage.json": { @@ -30539,11 +40357,11 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records.json": { @@ -30561,11 +40379,14 @@ "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", + "tags": [ + "Api20100401Record" + ], "parameters": [ { "name": "AccountSid", @@ -30586,6 +40407,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_record_enum_category" + }, + "examples": { + "readFull": { + "value": "calleridlookups" + }, + "readEmpty": { + "value": "calleridlookups" + } } }, { @@ -30595,6 +40424,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -30604,6 +40441,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -30647,44 +40492,133 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Record\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Record\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "totalprice", + "count": null, + "count_unit": "", + "description": "Total Price", + "end_date": "2015-09-04", + "price": "2192.84855", + "price_unit": "usd", + "start_date": "2011-08-23", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=totalprice", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=totalprice", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=totalprice", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=totalprice", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=totalprice", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=totalprice", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=totalprice", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=totalprice" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice&StartDate=2011-08-23&EndDate=2015-09-04", + "usage": "2192.84855", + "usage_unit": "usd" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records", + "usage_records": [] } } } @@ -30698,10 +40632,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecord" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/AllTime.json": { @@ -30719,11 +40650,14 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401AllTime" + ], "parameters": [ { "name": "AccountSid", @@ -30805,44 +40739,133 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordAllTimeResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordAllTimeResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AllTime\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AllTime\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-04", + "price": "0", + "price_unit": "usd", + "start_date": "2011-08-23", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Category=sms-inbound-shortcode&StartDate=2011-08-23&EndDate=2015-09-04", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime", + "usage_records": [] } } } @@ -30856,10 +40879,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordAllTime", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordAllTime" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Daily.json": { @@ -30877,11 +40897,14 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Daily" + ], "parameters": [ { "name": "AccountSid", @@ -30963,44 +40986,133 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordDailyResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordDailyResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Daily\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Daily\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=101843&PageSize=1", + "next_page_uri": null, + "num_pages": 101844, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 101844, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-06", + "price": "0", + "price_unit": "usd", + "start_date": "2015-09-06", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Category=sms-inbound-shortcode&StartDate=2015-09-06&EndDate=2015-09-06", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=101843&PageSize=1", + "next_page_uri": null, + "num_pages": 101844, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 101844, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily", + "usage_records": [] } } } @@ -31014,10 +41126,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordDaily", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordDaily" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/LastMonth.json": { @@ -31035,11 +41144,14 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401LastMonth" + ], "parameters": [ { "name": "AccountSid", @@ -31121,44 +41233,133 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordLastMonthResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordLastMonthResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"LastMonth\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"LastMonth\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-08-31", + "price": "0", + "price_unit": "usd", + "start_date": "2015-08-01", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Category=sms-inbound-shortcode&StartDate=2015-08-01&EndDate=2015-08-31", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth", + "usage_records": [] } } } @@ -31172,10 +41373,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordLastMonth", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordLastMonth" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json": { @@ -31193,11 +41391,14 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Monthly" + ], "parameters": [ { "name": "AccountSid", @@ -31279,44 +41480,133 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordMonthlyResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordMonthlyResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Monthly\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Monthly\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=3449&PageSize=1", + "next_page_uri": null, + "num_pages": 3450, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 3450, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-04", + "price": "0", + "price_unit": "usd", + "start_date": "2015-09-01", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Category=sms-inbound-shortcode&StartDate=2015-09-01&EndDate=2015-09-04", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=3449&PageSize=1", + "next_page_uri": null, + "num_pages": 3450, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 3450, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly", + "usage_records": [] } } } @@ -31330,10 +41620,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordMonthly", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordMonthly" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/ThisMonth.json": { @@ -31351,11 +41638,14 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401ThisMonth" + ], "parameters": [ { "name": "AccountSid", @@ -31437,44 +41727,133 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordThisMonthResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordThisMonthResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"ThisMonth\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"ThisMonth\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-04", + "price": "0", + "price_unit": "usd", + "start_date": "2015-09-01", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Category=sms-inbound-shortcode&StartDate=2015-09-01&EndDate=2015-09-04", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth", + "usage_records": [] } } } @@ -31488,10 +41867,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordThisMonth", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordThisMonth" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Today.json": { @@ -31509,11 +41885,14 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Today" + ], "parameters": [ { "name": "AccountSid", @@ -31592,47 +41971,136 @@ ], "responses": { "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListUsageRecordTodayResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today" - } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordTodayResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Today\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Today\")" + } + } + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-04", + "price": "0", + "price_unit": "usd", + "start_date": "2015-09-04", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Category=sms-inbound-shortcode&StartDate=2015-09-04&EndDate=2015-09-04", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today", + "usage_records": [] } } } @@ -31646,10 +42114,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordToday", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordToday" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yearly.json": { @@ -31667,11 +42132,14 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Yearly" + ], "parameters": [ { "name": "AccountSid", @@ -31753,44 +42221,133 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordYearlyResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordYearlyResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Yearly\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Yearly\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=344&PageSize=1", + "next_page_uri": null, + "num_pages": 345, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 345, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-04", + "price": "0", + "price_unit": "usd", + "start_date": "2015-01-01", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Category=sms-inbound-shortcode&StartDate=2015-01-01&EndDate=2015-09-04", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=344&PageSize=1", + "next_page_uri": null, + "num_pages": 345, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 345, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly", + "usage_records": [] } } } @@ -31804,10 +42361,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordYearly", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordYearly" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yesterday.json": { @@ -31825,11 +42379,14 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "Api20100401Yesterday" + ], "parameters": [ { "name": "AccountSid", @@ -31911,44 +42468,133 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordYesterdayResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordYesterdayResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Yesterday\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Yesterday\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-03", + "price": "0", + "price_unit": "usd", + "start_date": "2015-09-03", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Category=sms-inbound-shortcode&StartDate=2015-09-03&EndDate=2015-09-03", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday", + "usage_records": [] } } } @@ -31962,10 +42608,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordYesterday", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordYesterday" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json": { @@ -31982,11 +42625,14 @@ "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", + "tags": [ + "Api20100401Trigger" + ], "parameters": [ { "name": "AccountSid", @@ -32019,6 +42665,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "callback_method": "GET", + "callback_url": "http://cap.com/streetfight", + "current_value": "0", + "date_created": "Sun, 06 Sep 2015 12:58:45 +0000", + "date_fired": null, + "date_updated": "Sun, 06 Sep 2015 12:58:45 +0000", + "friendly_name": "raphael-cluster-1441544325.86", + "recurring": "yearly", + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trigger_by": "price", + "trigger_value": "50", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_category": "totalprice", + "usage_record_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice" + } + } } } }, @@ -32030,13 +42698,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsageTrigger", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUsageTrigger" }, "post": { "description": "Update an instance of a usage trigger", + "tags": [ + "Api20100401Trigger" + ], "parameters": [ { "name": "AccountSid", @@ -32069,6 +42737,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "callback_method": "GET", + "callback_url": "http://cap.com/streetfight", + "current_value": "0", + "date_created": "Sun, 06 Sep 2015 12:58:45 +0000", + "date_fired": null, + "date_updated": "Sun, 06 Sep 2015 12:58:45 +0000", + "friendly_name": "raphael-cluster-1441544325.86", + "recurring": "yearly", + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trigger_by": "price", + "trigger_value": "50", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_category": "totalprice", + "usage_record_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice" + } + } } } }, @@ -32081,9 +42771,6 @@ } ], "operationId": "UpdateUsageTrigger", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -32114,6 +42801,15 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "update": { + "value": { + "CallbackMethod": "GET", + "CallbackUrl": "https://example.com", + "FriendlyName": "friendly_name" + } + } } } } @@ -32121,6 +42817,9 @@ }, "delete": { "description": "", + "tags": [ + "Api20100401Trigger" + ], "parameters": [ { "name": "AccountSid", @@ -32157,10 +42856,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUsageTrigger", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUsageTrigger" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json": { @@ -32177,11 +42873,14 @@ "usage_category", "trigger_by" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage.json" + "parent": "/Accounts/{AccountSid}/Usage.json", + "pathType": "list" }, "post": { "description": "Create a new UsageTrigger", + "tags": [ + "Api20100401Trigger" + ], "parameters": [ { "name": "AccountSid", @@ -32202,6 +42901,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "callback_method": "GET", + "callback_url": "http://cap.com/streetfight", + "current_value": "0", + "date_created": "Sun, 06 Sep 2015 12:58:45 +0000", + "date_fired": null, + "date_updated": "Sun, 06 Sep 2015 12:58:45 +0000", + "friendly_name": "raphael-cluster-1441544325.86", + "recurring": "yearly", + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trigger_by": "price", + "trigger_value": "50", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_category": "totalprice", + "usage_record_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice" + } + } } } }, @@ -32214,9 +42935,6 @@ } ], "operationId": "CreateUsageTrigger", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -32271,6 +42989,19 @@ "TriggerValue", "UsageCategory" ] + }, + "examples": { + "create": { + "value": { + "CallbackMethod": "GET", + "CallbackUrl": "https://example.com", + "FriendlyName": "friendly_name", + "Recurring": "daily", + "TriggerBy": "count", + "TriggerValue": "trigger_value", + "UsageCategory": "calleridlookups" + } + } } } } @@ -32278,6 +43009,9 @@ }, "get": { "description": "Retrieve a list of usage-triggers belonging to the account used to make the request", + "tags": [ + "Api20100401Trigger" + ], "parameters": [ { "name": "AccountSid", @@ -32298,6 +43032,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_recurring" + }, + "examples": { + "readFull": { + "value": "daily" + }, + "readEmpty": { + "value": "daily" + } } }, { @@ -32307,6 +43049,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_trigger_field" + }, + "examples": { + "readFull": { + "value": "count" + }, + "readEmpty": { + "value": "count" + } } }, { @@ -32316,6 +43066,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_usage_category" + }, + "examples": { + "readFull": { + "value": "calleridlookups" + }, + "readEmpty": { + "value": "calleridlookups" + } } }, { @@ -32351,44 +43109,125 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageTriggerResponse", - "properties": { - "usage_triggers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + "allOf": [ + { + "properties": { + "end": { + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + }, + "first_page_uri": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "nullable": true, + "type": "string", + "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": { + "format": "uri", + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageTriggerResponse", + "properties": { + "usage_triggers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Trigger\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Trigger\")" + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageTriggers\")" + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=626", + "next_page_uri": null, + "num_pages": 627, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 627, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers", + "usage_triggers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "callback_method": "GET", + "callback_url": "http://cap.com/streetfight", + "current_value": "0", + "date_created": "Sun, 06 Sep 2015 12:58:45 +0000", + "date_fired": null, + "date_updated": "Sun, 06 Sep 2015 12:58:45 +0000", + "friendly_name": "raphael-cluster-1441544325.86", + "recurring": "yearly", + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trigger_by": "price", + "trigger_value": "50", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_category": "totalprice", + "usage_record_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=626", + "next_page_uri": null, + "num_pages": 627, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 627, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers", + "usage_triggers": [] } } } @@ -32402,10 +43241,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageTrigger", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageTrigger" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessages.json": { @@ -32419,11 +43255,14 @@ "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.", + "tags": [ + "Api20100401UserDefinedMessage" + ], "parameters": [ { "name": "AccountSid", @@ -32456,6 +43295,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.user_defined_message" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "KXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000" + } + } } } }, @@ -32468,9 +43317,6 @@ } ], "operationId": "CreateUserDefinedMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -32490,6 +43336,14 @@ "required": [ "Content" ] + }, + "examples": { + "create": { + "value": { + "Content": "{\"key\":\"value\"}", + "IdempotencyKey": "1" + } + } } } } @@ -32507,11 +43361,14 @@ "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.", + "tags": [ + "Api20100401UserDefinedMessageSubscription" + ], "parameters": [ { "name": "AccountSid", @@ -32544,6 +43401,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.user_defined_message_subscription" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ZYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions/ZYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -32556,9 +43424,6 @@ } ], "operationId": "CreateUserDefinedMessageSubscription", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -32592,6 +43457,15 @@ "required": [ "Callback" ] + }, + "examples": { + "create": { + "value": { + "Callback": "http://www.example.com", + "Method": "POST", + "IdempotencyKey": "1" + } + } } } } @@ -32609,11 +43483,14 @@ "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.", + "tags": [ + "Api20100401UserDefinedMessageSubscription" + ], "parameters": [ { "name": "AccountSid", @@ -32662,10 +43539,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserDefinedMessageSubscription", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserDefinedMessageSubscription" } } }, @@ -32674,18 +43548,221 @@ "url": "https://api.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "Api20100401Account" + }, + { + "name": "Api20100401AddOnResult" + }, + { + "name": "Api20100401Address" + }, + { + "name": "Api20100401AllTime" + }, + { + "name": "Api20100401Application" + }, + { + "name": "Api20100401AssignedAddOn" + }, + { + "name": "Api20100401AssignedAddOnExtension" + }, + { + "name": "Api20100401AuthCallsCredentialListMapping" + }, + { + "name": "Api20100401AuthCallsIpAccessControlListMapping" + }, + { + "name": "Api20100401AuthRegistrationsCredentialListMapping" + }, + { + "name": "Api20100401AuthorizedConnectApp" + }, + { + "name": "Api20100401AvailablePhoneNumberCountry" + }, + { + "name": "Api20100401Balance" + }, + { + "name": "Api20100401Call" + }, + { + "name": "Api20100401Conference" + }, + { + "name": "Api20100401ConnectApp" + }, + { + "name": "Api20100401Credential" + }, + { + "name": "Api20100401CredentialList" + }, + { + "name": "Api20100401CredentialListMapping" + }, + { + "name": "Api20100401Daily" + }, + { + "name": "Api20100401Data" + }, + { + "name": "Api20100401DependentPhoneNumber" + }, + { + "name": "Api20100401Domain" + }, + { + "name": "Api20100401Event" + }, + { + "name": "Api20100401Feedback" + }, + { + "name": "Api20100401HealthCheck" + }, + { + "name": "Api20100401IncomingPhoneNumber" + }, + { + "name": "Api20100401IpAccessControlList" + }, + { + "name": "Api20100401IpAccessControlListMapping" + }, + { + "name": "Api20100401IpAddress" + }, + { + "name": "Api20100401Key" + }, + { + "name": "Api20100401LastMonth" + }, + { + "name": "Api20100401Local" + }, + { + "name": "Api20100401MachineToMachine" + }, + { + "name": "Api20100401Media" + }, + { + "name": "Api20100401Member" + }, + { + "name": "Api20100401Message" + }, + { + "name": "Api20100401Mobile" + }, + { + "name": "Api20100401Monthly" + }, + { + "name": "Api20100401National" + }, + { + "name": "Api20100401NewKey" + }, + { + "name": "Api20100401NewSigningKey" + }, + { + "name": "Api20100401Notification" + }, + { + "name": "Api20100401OutgoingCallerId" + }, + { + "name": "Api20100401Participant" + }, + { + "name": "Api20100401Payload" + }, + { + "name": "Api20100401Payment" + }, + { + "name": "Api20100401Queue" + }, + { + "name": "Api20100401Record" + }, + { + "name": "Api20100401Recording" + }, + { + "name": "Api20100401Region" + }, + { + "name": "Api20100401SharedCost" + }, + { + "name": "Api20100401ShortCode" + }, + { + "name": "Api20100401SigningKey" + }, + { + "name": "Api20100401Sip" + }, + { + "name": "Api20100401Siprec" + }, + { + "name": "Api20100401SmsMessage" + }, + { + "name": "Api20100401Stream" + }, + { + "name": "Api20100401ThisMonth" + }, + { + "name": "Api20100401Today" + }, + { + "name": "Api20100401Token" + }, + { + "name": "Api20100401TollFree" + }, + { + "name": "Api20100401Transcription" + }, + { + "name": "Api20100401Trigger" + }, + { + "name": "Api20100401UserDefinedMessage" + }, + { + "name": "Api20100401UserDefinedMessageSubscription" + }, + { + "name": "Api20100401ValidationRequest" + }, { - "name": "GA", - "description": "This product is Generally Available." + "name": "Api20100401Voip" }, { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "name": "Api20100401Yearly" }, { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." + "name": "Api20100401Yesterday" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_autopilot_v1.json b/spec/json/twilio_autopilot_v1.json deleted file mode 100644 index 902ad0cc..00000000 --- a/spec/json/twilio_autopilot_v1.json +++ /dev/null @@ -1,4696 +0,0 @@ -{ - "components": { - "schemas": { - "autopilot.v1.assistant": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Assistant resource." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when 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 when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long." - }, - "latest_model_build_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "nullable": true, - "description": "Reserved." - }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true, - "description": "A list of the URLs of the Assistant's related resources." - }, - "log_queries": { - "type": "boolean", - "nullable": true, - "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored." - }, - "development_stage": { - "type": "string", - "nullable": true, - "description": "A string describing the state of the assistant." - }, - "needs_model_build": { - "type": "boolean", - "nullable": true, - "description": "Whether model needs to be rebuilt." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the Assistant resource." - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. It can be up to 64 characters long." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the Assistant resource." - }, - "callback_url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "Reserved." - }, - "callback_events": { - "type": "string", - "nullable": true, - "description": "Reserved." - } - } - }, - "autopilot.v1.assistant.defaults": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Defaults resource." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the Defaults resource." - }, - "data": { - "nullable": true, - "description": "The JSON string that describes the default task links for the `assistant_initiation`, `collect`, and `fallback` situations." - } - } - }, - "autopilot.v1.assistant.dialogue": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Dialogue resource." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UK[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the Dialogue resource." - }, - "data": { - "nullable": true, - "description": "The JSON string that describes the dialogue session object." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the Dialogue resource." - } - } - }, - "autopilot.v1.assistant.task.field": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Field resource." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when 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 when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "field_type": { - "type": "string", - "nullable": true, - "description": "The Field Type of the field. Can be: a [Built-in Field Type](https://www.twilio.com/docs/autopilot/built-in-field-types), the unique_name, or the SID of a custom Field Type." - }, - "task_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with this Field." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UE[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the Field resource." - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the Field resource." - } - } - }, - "autopilot.v1.assistant.field_type": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the FieldType resource." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when 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 when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long." - }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true, - "description": "A list of the URLs of related resources." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UB[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the FieldType resource." - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the FieldType resource." - } - } - }, - "autopilot.v1.assistant.field_type.field_value": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the FieldValue resource." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when 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 when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "field_type_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UB[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the Field Type associated with the Field Value." - }, - "language": { - "type": "string", - "nullable": true, - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`" - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the resource." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the FieldValue resource." - }, - "value": { - "type": "string", - "nullable": true, - "description": "The Field Value data." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the FieldValue resource." - }, - "synonym_of": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The word for which the field value is a synonym of." - } - } - }, - "autopilot.v1.assistant.model_build": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ModelBuild resource." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when 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 when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the ModelBuild resource." - }, - "status": { - "type": "string", - "$ref": "#/components/schemas/model_build_enum_status", - "nullable": true, - "description": "The status of the model build process. Can be: `enqueued`, `building`, `completed`, or `failed`" - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the ModelBuild resource." - }, - "build_duration": { - "type": "integer", - "nullable": true, - "description": "The time in seconds it took to build the model." - }, - "error_code": { - "type": "integer", - "nullable": true, - "description": "If the `status` for the model build is `failed`, this value is a code to more information about the failure. This value will be null for all other statuses. See [error code dictionary](https://www.twilio.com/docs/api/errors) for a description of the error." - } - } - }, - "model_build_enum_status": { - "type": "string", - "enum": [ - "enqueued", - "building", - "completed", - "failed", - "canceled" - ] - }, - "autopilot.v1.assistant.query": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Query resource." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when 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 when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "results": { - "nullable": true, - "description": "The natural language analysis results that include the [Task](https://www.twilio.com/docs/autopilot/api/task) recognized and a list of identified [Fields](https://www.twilio.com/docs/autopilot/api/task-field)." - }, - "language": { - "type": "string", - "nullable": true, - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used by the Query. For example: `en-US`." - }, - "model_build_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) queried." - }, - "query": { - "type": "string", - "nullable": true, - "description": "The end-user's natural language input." - }, - "sample_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of an optional reference to the [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) created from the query." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UH[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the Query resource." - }, - "status": { - "type": "string", - "nullable": true, - "description": "The status of the Query. Can be: `pending-review`, `reviewed`, or `discarded`" - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the Query resource." - }, - "source_channel": { - "type": "string", - "nullable": true, - "description": "The communication channel from where the end-user input came." - }, - "dialogue_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UK[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue)." - } - } - }, - "autopilot.v1.restore_assistant": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Assistant resource." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the Assistant resource." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when 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 when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long." - }, - "needs_model_build": { - "type": "boolean", - "nullable": true, - "description": "Whether model needs to be rebuilt." - }, - "latest_model_build_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "nullable": true, - "description": "Reserved." - }, - "log_queries": { - "type": "boolean", - "nullable": true, - "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored." - }, - "development_stage": { - "type": "string", - "nullable": true, - "description": "A string describing the state of the assistant." - }, - "callback_url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "Reserved." - }, - "callback_events": { - "type": "string", - "nullable": true, - "description": "Reserved." - } - } - }, - "autopilot.v1.assistant.task.sample": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sample resource." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when 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 when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "task_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the resource." - }, - "language": { - "type": "string", - "nullable": true, - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the Sample resource." - }, - "tagged_text": { - "type": "string", - "nullable": true, - "description": "The text example of how end users might express the task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging)." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the Sample resource." - }, - "source_channel": { - "type": "string", - "nullable": true, - "description": "The communication channel from which the sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included." - } - } - }, - "autopilot.v1.assistant.style_sheet": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the StyleSheet resource." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the StyleSheet resource." - }, - "data": { - "nullable": true, - "description": "The JSON string that describes the style sheet object." - } - } - }, - "autopilot.v1.assistant.task": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Task resource." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when 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 when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long." - }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true, - "description": "A list of the URLs of related resources." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the Task resource." - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." - }, - "actions_url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The URL from which the Assistant can fetch actions." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the Task resource." - } - } - }, - "autopilot.v1.assistant.task.task_actions": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskActions resource." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource." - }, - "task_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the resource." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the TaskActions resource." - }, - "data": { - "nullable": true, - "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task." - } - } - }, - "autopilot.v1.assistant.task.task_statistics": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskStatistics resource." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource." - }, - "task_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) for which the statistics were collected." - }, - "samples_count": { - "type": "integer", - "nullable": true, - "description": "The total number of [Samples](https://www.twilio.com/docs/autopilot/api/task-sample) associated with the Task." - }, - "fields_count": { - "type": "integer", - "nullable": true, - "description": "The total number of [Fields](https://www.twilio.com/docs/autopilot/api/task-field) associated with the Task." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the TaskStatistics resource." - } - } - }, - "autopilot.v1.assistant.webhook": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the Webhook 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/iam/api/account) that created the Webhook resource." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when 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 when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UM[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the Webhook resource." - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." - }, - "events": { - "type": "string", - "nullable": true, - "description": "The list of space-separated events that this Webhook is subscribed to." - }, - "webhook_url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The URL associated with this Webhook." - }, - "webhook_method": { - "type": "string", - "nullable": true, - "description": "The method used when calling the webhook's URL." - } - } - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } - } - }, - "info": { - "title": "Twilio - Autopilot", - "description": "This is the public Twilio REST API.", - "termsOfService": "https://www.twilio.com/legal/tos", - "contact": { - "name": "Twilio Support", - "url": "https://support.twilio.com", - "email": "support@twilio.com" - }, - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "version": "1.43.2" - }, - "openapi": "3.0.1", - "paths": { - "/v1/Assistants/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "pathType": "instance", - "dependentProperties": { - "field_type": "{assistant_sid: sid}", - "task": "{assistant_sid: sid}", - "model_build": "{assistant_sid: sid}", - "query": "{assistant_sid: sid}", - "style_sheet": "{assistant_sid: sid}", - "defaults": "{assistant_sid: sid}", - "dialogue": "{assistant_sid: sid}", - "webhook": "{assistant_sid: sid}" - } - }, - "get": { - "description": "", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Assistant resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchAssistant", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Assistant resource to update.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateAssistant", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateAssistantRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." - }, - "LogQueries": { - "type": "boolean", - "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored." - }, - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique." - }, - "CallbackUrl": { - "type": "string", - "format": "uri", - "description": "Reserved." - }, - "CallbackEvents": { - "type": "string", - "description": "Reserved." - }, - "StyleSheet": { - "description": "The JSON string that defines the Assistant's [style sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet)" - }, - "Defaults": { - "description": "A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks." - }, - "DevelopmentStage": { - "type": "string", - "description": "A string describing the state of the assistant." - } - } - } - } - } - } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Assistant resource to delete.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteAssistant", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Assistants": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "pathType": "list", - "dependentProperties": { - "field_type": "{assistant_sid: sid}", - "task": "{assistant_sid: sid}", - "model_build": "{assistant_sid: sid}", - "query": "{assistant_sid: sid}", - "style_sheet": "{assistant_sid: sid}", - "defaults": "{assistant_sid: sid}", - "dialogue": "{assistant_sid: sid}", - "webhook": "{assistant_sid: sid}" - } - }, - "get": { - "description": "", - "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": "ListAssistantResponse", - "properties": { - "assistants": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autopilot.v1.assistant" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListAssistant", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateAssistant", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateAssistantRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long." - }, - "LogQueries": { - "type": "boolean", - "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored." - }, - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique." - }, - "CallbackUrl": { - "type": "string", - "format": "uri", - "description": "Reserved." - }, - "CallbackEvents": { - "type": "string", - "description": "Reserved." - }, - "StyleSheet": { - "description": "The JSON string that defines the Assistant's [style sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet)" - }, - "Defaults": { - "description": "A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks." - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Defaults": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "data" - ], - "pathType": "instance", - "parent": "/Assistants/{Sid}", - "className": "defaults" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.defaults" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDefaults", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.defaults" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDefaults", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateDefaultsRequest", - "properties": { - "Defaults": { - "description": "A JSON string that describes the default task links for the `assistant_initiation`, `collect`, and `fallback` situations." - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Dialogues/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "data" - ], - "pathType": "instance", - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Dialogue resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.dialogue" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDialogue", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Assistants/{AssistantSid}/Dialogues": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "data" - ], - "pathType": "list", - "parent": "/Assistants/{Sid}" - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "field_type" - ], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Field resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task.field" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchField", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to delete.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resource to delete.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Field resource to delete.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteField", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "field_type" - ], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to read.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resources to read.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListFieldResponse", - "properties": { - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task.field" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListField", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the new resource.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the new Field resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task.field" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateField", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateFieldRequest", - "properties": { - "FieldType": { - "type": "string", - "description": "The Field Type of the new field. Can be: a [Built-in Field Type](https://www.twilio.com/docs/autopilot/built-in-field-types), the `unique_name`, or the `sid` of a custom Field Type." - }, - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource." - } - }, - "required": [ - "FieldType", - "UniqueName" - ] - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/FieldTypes/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "pathType": "instance", - "dependentProperties": { - "field_value": "{assistant_sid: assistant_sid, field_type_sid: sid}" - }, - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the FieldType resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchFieldType", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the to update.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the FieldType resource to update.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateFieldType", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateFieldTypeRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." - }, - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique." - } - } - } - } - } - } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the FieldType resource to delete.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteFieldType", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Assistants/{AssistantSid}/FieldTypes": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "pathType": "list", - "dependentProperties": { - "field_value": "{assistant_sid: assistant_sid, field_type_sid: sid}" - }, - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListFieldTypeResponse", - "properties": { - "field_types": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListFieldType", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateFieldType", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateFieldTypeRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique." - }, - "FriendlyName": { - "type": "string", - "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long." - } - }, - "required": [ - "UniqueName" - ] - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "value", - "language" - ], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "FieldTypeSid", - "in": "path", - "description": "The SID of the Field Type associated with the Field Value to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the FieldValue resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.field_type.field_value" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchFieldValue", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the resources to delete.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "FieldTypeSid", - "in": "path", - "description": "The SID of the Field Type associated with the Field Value to delete.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the FieldValue resource to delete.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteFieldValue", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "value", - "language" - ], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the resources to read.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "FieldTypeSid", - "in": "path", - "description": "The SID of the Field Type associated with the Field Value to read.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Language", - "in": "query", - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`", - "schema": { - "type": "string" - } - }, - { - "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": "ListFieldValueResponse", - "properties": { - "field_values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autopilot.v1.assistant.field_type.field_value" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListFieldValue", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the new resource.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "FieldTypeSid", - "in": "path", - "description": "The SID of the Field Type associated with the Field Value.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.field_type.field_value" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateFieldValue", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateFieldValueRequest", - "properties": { - "Language": { - "type": "string", - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`" - }, - "Value": { - "type": "string", - "description": "The Field Value data." - }, - "SynonymOf": { - "type": "string", - "description": "The string value that indicates which word the field value is a synonym of." - } - }, - "required": [ - "Language", - "Value" - ] - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "status", - "date_created" - ], - "pathType": "instance", - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the ModelBuild resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchModelBuild", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the ModelBuild resource to update.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateModelBuild", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateModelBuildRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource." - } - } - } - } - } - } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the ModelBuild resource to delete.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteModelBuild", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Assistants/{AssistantSid}/ModelBuilds": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "status", - "date_created" - ], - "pathType": "list", - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListModelBuildResponse", - "properties": { - "model_builds": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListModelBuild", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateModelBuild", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateModelBuildRequest", - "properties": { - "StatusCallback": { - "type": "string", - "format": "uri", - "description": "The URL we should call using a POST method to send status information to your application." - }, - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource." - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Queries/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "query", - "status", - "language" - ], - "pathType": "instance", - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Query resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.query" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchQuery", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Query resource to update.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.query" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateQuery", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateQueryRequest", - "properties": { - "SampleSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "description": "The SID of an optional reference to the [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) created from the query." - }, - "Status": { - "type": "string", - "description": "The new status of the resource. Can be: `pending-review`, `reviewed`, or `discarded`" - } - } - } - } - } - } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Query resource to delete.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteQuery", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Assistants/{AssistantSid}/Queries": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "query", - "status", - "language" - ], - "pathType": "list", - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Language", - "in": "query", - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used by the Query resources to read. For example: `en-US`.", - "schema": { - "type": "string" - } - }, - { - "name": "ModelBuild", - "in": "query", - "description": "The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.", - "schema": { - "type": "string" - } - }, - { - "name": "Status", - "in": "query", - "description": "The status of the resources to read. Can be: `pending-review`, `reviewed`, or `discarded`", - "schema": { - "type": "string" - } - }, - { - "name": "DialogueSid", - "in": "query", - "description": "The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UK[0-9a-fA-F]{32}$" - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListQueryResponse", - "properties": { - "queries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autopilot.v1.assistant.query" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListQuery", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.query" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateQuery", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateQueryRequest", - "properties": { - "Language": { - "type": "string", - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the new query. For example: `en-US`." - }, - "Query": { - "type": "string", - "description": "The end-user's natural language input. It can be up to 2048 characters long." - }, - "Tasks": { - "type": "string", - "description": "The list of tasks to limit the new query to. Tasks are expressed as a comma-separated list of task `unique_name` values. For example, `task-unique_name-1, task-unique_name-2`. Listing specific tasks is useful to constrain the paths that a user can take." - }, - "ModelBuild": { - "type": "string", - "description": "The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried." - } - }, - "required": [ - "Language", - "Query" - ] - } - } - } - } - } - }, - "/v1/Assistants/Restore": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "account_sid", - "sid", - "unique_name", - "friendly_name" - ], - "pathType": "list", - "mountName": "restore_assistant" - }, - "post": { - "description": "", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.restore_assistant" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateRestoreAssistant", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateRestoreAssistantRequest", - "properties": { - "Assistant": { - "type": "string", - "description": "The Twilio-provided string that uniquely identifies the Assistant resource to restore." - } - }, - "required": [ - "Assistant" - ] - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "tagged_text", - "language", - "source_channel" - ], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to create.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Sample resource to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchSample", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource to update.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to update.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Sample resource to update.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateSample", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateSampleRequest", - "properties": { - "Language": { - "type": "string", - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`." - }, - "TaggedText": { - "type": "string", - "description": "The text example of how end users might express the task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging)." - }, - "SourceChannel": { - "type": "string", - "description": "The communication channel from which the sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included." - } - } - } - } - } - } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to delete.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to delete.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Sample resource to delete.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSample", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "tagged_text", - "language", - "source_channel" - ], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to read.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resources to read.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Language", - "in": "query", - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`.", - "schema": { - "type": "string" - } - }, - { - "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": "ListSampleResponse", - "properties": { - "samples": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListSample", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the new resource.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to create.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateSample", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateSampleRequest", - "properties": { - "Language": { - "type": "string", - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the new sample. For example: `en-US`." - }, - "TaggedText": { - "type": "string", - "description": "The text example of how end users might express the task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging)." - }, - "SourceChannel": { - "type": "string", - "description": "The communication channel from which the new sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included." - } - }, - "required": [ - "Language", - "TaggedText" - ] - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/StyleSheet": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "data" - ], - "pathType": "instance", - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "Returns Style sheet JSON object for the Assistant", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.style_sheet" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchStyleSheet", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Updates the style sheet for an Assistant identified by `assistant_sid`.", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.style_sheet" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateStyleSheet", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateStyleSheetRequest", - "properties": { - "StyleSheet": { - "description": "The JSON string that describes the style sheet object." - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "pathType": "instance", - "dependentProperties": { - "field": "{assistant_sid: assistant_sid, task_sid: sid}", - "sample": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_actions": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_statistics": "{assistant_sid: assistant_sid, task_sid: sid}" - }, - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Task resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchTask", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Task resource to update.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateTask", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateTaskRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." - }, - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the resource. This value must be 64 characters or less in length and be unique. It can be used as an alternative to the `sid` in the URL path to address the resource." - }, - "Actions": { - "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task." - }, - "ActionsUrl": { - "type": "string", - "format": "uri", - "description": "The URL from which the Assistant can fetch actions." - } - } - } - } - } - } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Task resource to delete.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteTask", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Assistants/{AssistantSid}/Tasks": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "pathType": "list", - "dependentProperties": { - "field": "{assistant_sid: assistant_sid, task_sid: sid}", - "sample": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_actions": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_statistics": "{assistant_sid: assistant_sid, task_sid: sid}" - }, - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListTaskResponse", - "properties": { - "tasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListTask", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateTask", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateTaskRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length." - }, - "FriendlyName": { - "type": "string", - "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long." - }, - "Actions": { - "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task. It is optional and not unique." - }, - "ActionsUrl": { - "type": "string", - "format": "uri", - "description": "The URL from which the Assistant can fetch actions." - } - }, - "required": [ - "UniqueName" - ] - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "data" - ], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "mountName": "task_actions", - "className": "task_actions" - }, - "get": { - "description": "Returns JSON actions for the Task.", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task for which the task actions to fetch were defined.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) for which the task actions to fetch were defined.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchTaskActions", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task for which the task actions to update were defined.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) for which the task actions to update were defined.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateTaskActions", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateTaskActionsRequest", - "properties": { - "Actions": { - "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task." - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "samples_count", - "fields_count" - ], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "className": "task_statistics" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) that is associated with the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_statistics" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchTaskStatistics", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Assistants/{AssistantSid}/Webhooks/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "events", - "wehbook_url", - "webhook_method" - ], - "pathType": "instance", - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Webhook resource to fetch.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchWebhook", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Webhook resource to update.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateWebhook", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateWebhookRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length." - }, - "Events": { - "type": "string", - "description": "The list of space-separated events that this Webhook will subscribe to." - }, - "WebhookUrl": { - "type": "string", - "format": "uri", - "description": "The URL associated with this Webhook." - }, - "WebhookMethod": { - "type": "string", - "description": "The method to be used when calling the webhook's URL." - } - } - } - } - } - } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Webhook resource to delete.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteWebhook", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Assistants/{AssistantSid}/Webhooks": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "events", - "wehbook_url", - "webhook_method" - ], - "pathType": "list", - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListWebhookResponse", - "properties": { - "webhooks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListWebhook", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateWebhook", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateWebhookRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length." - }, - "Events": { - "type": "string", - "description": "The list of space-separated events that this Webhook will subscribe to." - }, - "WebhookUrl": { - "type": "string", - "format": "uri", - "description": "The URL associated with this Webhook." - }, - "WebhookMethod": { - "type": "string", - "description": "The method to be used when calling the webhook's URL." - } - }, - "required": [ - "UniqueName", - "Events", - "WebhookUrl" - ] - } - } - } - } - } - } - }, - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "x-maturity": [ - { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." - } - ] -} \ No newline at end of file diff --git a/spec/json/twilio_bulkexports_v1.json b/spec/json/twilio_bulkexports_v1.json index aa67f4c7..83dd3f6b 100644 --- a/spec/json/twilio_bulkexports_v1.json +++ b/spec/json/twilio_bulkexports_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "bulkexports.v1.export.day": { "type": "object", @@ -250,12 +256,6 @@ "DeletedByUserRequest" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -271,7 +271,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -281,7 +281,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "friendly_name", @@ -291,11 +291,14 @@ "size", "redirectTo" ], - "pathType": "instance", - "parent": "/Exports/{ResourceType}" + "parent": "/Exports/{ResourceType}", + "pathType": "instance" }, "get": { "description": "Fetch a specific Day.", + "tags": [ + "BulkexportsV1Day" + ], "parameters": [ { "name": "ResourceType", @@ -322,6 +325,13 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export.day-instance" + }, + "examples": { + "fetch": { + "value": { + "redirect_to": "https://documentation-example-twilio-bucket.s3.amazonaws.com/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -333,10 +343,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDay", - "x-maturity": [ - "GA" - ] + "operationId": "FetchDay" } }, "/v1/Exports/{ResourceType}/Days": { @@ -345,7 +352,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "friendly_name", @@ -355,11 +362,14 @@ "size", "redirectTo" ], - "pathType": "list", - "parent": "/Exports/{ResourceType}" + "parent": "/Exports/{ResourceType}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Days for a resource.", + "tags": [ + "BulkexportsV1Day" + ], "parameters": [ { "name": "ResourceType", @@ -413,16 +423,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -431,17 +443,53 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "days": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0", + "next_page_url": null, + "key": "days" + } + } + }, + "readFull": { + "value": { + "days": [ + { + "day": "2017-04-01", + "size": 100, + "resource_type": "Messages", + "create_date": "2017-04-02", + "friendly_name": "friendly_name" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0", + "next_page_url": null, + "key": "days" } } } @@ -456,10 +504,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDay", - "x-maturity": [ - "GA" - ] + "operationId": "ListDay" } }, "/v1/Exports/{ResourceType}": { @@ -468,17 +513,30 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { - "day": "{resource_type: resource_type}", - "export_custom_job": "{resource_type: resource_type}" - } + "days": { + "mapping": { + "resource_type": "resource_type" + }, + "resource_url": "/v1/Exports/{resource_type}/Days" + }, + "export_custom_jobs": { + "mapping": { + "resource_type": "resource_type" + }, + "resource_url": "/v1/Exports/{resource_type}/Jobs" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Export.", + "tags": [ + "BulkexportsV1Export" + ], "parameters": [ { "name": "ResourceType", @@ -496,6 +554,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export" + }, + "examples": { + "fetch": { + "value": { + "resource_type": "Messages", + "url": "https://bulkexports.twilio.com/v1/Exports/Messages", + "links": { + "days": "https://bulkexports.twilio.com/v1/Exports/Messages/Days" + } + } + } } } }, @@ -507,10 +576,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExport", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExport" } }, "/v1/Exports": { @@ -519,14 +585,24 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { - "day": "{resource_type: resource_type}", - "export_custom_job": "{resource_type: resource_type}" - } + "days": { + "mapping": { + "resource_type": "resource_type" + }, + "resource_url": "/v1/Exports/{resource_type}/Days" + }, + "export_custom_jobs": { + "mapping": { + "resource_type": "resource_type" + }, + "resource_url": "/v1/Exports/{resource_type}/Jobs" + } + }, + "pathType": "list" } }, "/v1/Exports/{ResourceType}/Configuration": { @@ -535,7 +611,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "enabled", @@ -544,11 +620,14 @@ "webhook_method", "webhook_url" ], - "pathType": "instance", - "mountName": "export_configuration" + "mountName": "export_configuration", + "pathType": "instance" }, "get": { "description": "Fetch a specific Export Configuration.", + "tags": [ + "BulkexportsV1ExportConfiguration" + ], "parameters": [ { "name": "ResourceType", @@ -566,6 +645,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export_configuration" + }, + "examples": { + "fetch": { + "value": { + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Configuration", + "enabled": true, + "webhook_url": "", + "webhook_method": "", + "resource_type": "Messages" + } + } } } }, @@ -577,13 +667,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExportConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExportConfiguration" }, "post": { "description": "Update a specific Export Configuration.", + "tags": [ + "BulkexportsV1ExportConfiguration" + ], "parameters": [ { "name": "ResourceType", @@ -601,6 +691,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export_configuration" + }, + "examples": { + "update": { + "value": { + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Configuration", + "enabled": true, + "webhook_url": "", + "resource_type": "Messages", + "webhook_method": "" + } + } } } }, @@ -613,9 +714,6 @@ } ], "operationId": "UpdateExportConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -637,6 +735,13 @@ "description": "Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url" } } + }, + "examples": { + "update": { + "value": { + "Enabled": true + } + } } } } @@ -649,7 +754,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "details", @@ -664,12 +769,15 @@ "webhook_method", "webhook_url" ], - "pathType": "list", "parent": "/Exports/{ResourceType}", - "mountName": "export_custom_jobs" + "mountName": "export_custom_jobs", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "BulkexportsV1ExportCustomJob" + ], "parameters": [ { "name": "ResourceType", @@ -723,16 +831,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -741,18 +851,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0", + "page_size": 50, + "key": "jobs", + "first_page_url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0", + "next_page_url": null, + "page": 0 + }, + "jobs": [] + } + }, + "readFull": { + "value": { + "meta": { + "previous_page_url": null, + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0", + "page_size": 50, + "key": "jobs", + "first_page_url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0", + "next_page_url": null, + "page": 0 + }, + "jobs": [ + { + "start_day": "start_day", + "job_sid": "JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "webhook_method": "webhook_method", + "details": {}, + "end_day": "end_day", + "webhook_url": "webhook_url", + "email": "email", + "resource_type": "resource_type", + "job_queue_position": "1", + "estimated_completion_time": "2021-03-15T20:20:14.547" + } + ] } } } @@ -766,13 +918,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListExportCustomJob", - "x-maturity": [ - "GA" - ] + "operationId": "ListExportCustomJob" }, "post": { "description": "", + "tags": [ + "BulkexportsV1ExportCustomJob" + ], "parameters": [ { "name": "ResourceType", @@ -790,6 +942,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export.export_custom_job" + }, + "examples": { + "create": { + "value": { + "start_day": "start_day", + "job_sid": "JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "webhook_method": "webhook_method", + "details": {}, + "end_day": "end_day", + "webhook_url": "webhook_url", + "email": "email", + "resource_type": "resource_type", + "job_queue_position": "1", + "estimated_completion_time": "2021-03-15T20:20:14.547" + } + } } } }, @@ -802,9 +971,6 @@ } ], "operationId": "CreateExportCustomJob", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -842,6 +1008,18 @@ "EndDay", "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "EndDay": "end_day_value", + "StartDay": "start_day_value", + "WebhookUrl": "webhook_url_value", + "WebhookMethod": "webhook_method_value", + "FriendlyName": "friendly_name_value", + "Email": "email_value" + } + } } } } @@ -854,7 +1032,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "details", @@ -869,11 +1047,14 @@ "webhook_method", "webhook_url" ], - "pathType": "instance", - "parent": "/Exports" + "parent": "/Exports", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "BulkexportsV1Job" + ], "parameters": [ { "name": "JobSid", @@ -894,6 +1075,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export.job" + }, + "examples": { + "fetch": { + "value": { + "start_day": "start_day", + "job_sid": "JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://bulkexports.twilio.com/v1/Exports/Jobs/JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "end_day": "end_day", + "details": {}, + "webhook_url": "https://webhookexample.com", + "webhook_method": "webhook_method", + "email": "email", + "resource_type": "resource_type", + "job_queue_position": "1", + "estimated_completion_time": "2021-03-15T20:20:14.547" + } + } } } }, @@ -905,13 +1104,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchJob", - "x-maturity": [ - "GA" - ] + "operationId": "FetchJob" }, "delete": { "description": "", + "tags": [ + "BulkexportsV1Job" + ], "parameters": [ { "name": "JobSid", @@ -936,10 +1135,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteJob", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteJob" } }, "/v1/Exports/Jobs": { @@ -948,7 +1144,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "details", @@ -963,8 +1159,8 @@ "webhook_method", "webhook_url" ], - "pathType": "list", - "parent": "/Exports" + "parent": "/Exports", + "pathType": "list" } } }, @@ -973,10 +1169,26 @@ "url": "https://bulkexports.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "BulkexportsV1Day" + }, + { + "name": "BulkexportsV1Export" + }, + { + "name": "BulkexportsV1ExportConfiguration" + }, + { + "name": "BulkexportsV1ExportCustomJob" + }, + { + "name": "BulkexportsV1Job" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_chat_v1.json b/spec/json/twilio_chat_v1.json index d06959b9..64a1b72d 100644 --- a/spec/json/twilio_chat_v1.json +++ b/spec/json/twilio_chat_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "chat.v1.service.channel": { "type": "object", @@ -31,17 +37,35 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -64,7 +88,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`." + "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "members_count": { "type": "integer", @@ -119,7 +149,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -198,7 +234,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/api/chat/rest/users) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/api/chat/rest/users) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -271,7 +313,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/api/chat/rest/users) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/api/chat/rest/users) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -334,7 +382,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "service_sid": { "type": "string", @@ -380,12 +434,24 @@ "from": { "type": "string", "nullable": true, - "description": "The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the message's author. The default value is `system`." + "description": "The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the message's author. The default value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "body": { "type": "string", "nullable": true, - "description": "The content of the message." + "description": "The content of the message.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "index": { "type": "integer", @@ -437,7 +503,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -502,7 +574,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -639,12 +717,24 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "role_sid": { "type": "string", @@ -657,7 +747,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Service](https://www.twilio.com/docs/api/chat/rest/services). This value is often a username or an email address. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's User within the [Service](https://www.twilio.com/docs/api/chat/rest/services). This value is often a username or an email address. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "is_online": { "type": "boolean", @@ -767,12 +863,6 @@ "not_participating" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -788,7 +878,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -805,16 +895,37 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "member": "{service_sid: service_sid, channel_sid: sid}", - "message": "{service_sid: service_sid, channel_sid: sid}", - "invite": "{service_sid: service_sid, channel_sid: sid}" + "members": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Members" + }, + "messages": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Messages" + }, + "invites": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Invites" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV1Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -844,6 +955,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -855,13 +991,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", + "tags": [ + "ChatV1Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -895,13 +1031,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", + "tags": [ + "ChatV1Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -931,6 +1067,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -943,9 +1104,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -966,6 +1124,16 @@ "description": "A valid JSON string that contains application-specific data." } } + }, + "examples": { + "update": { + "value": { + "Type": "channel", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }" + } + } } } } @@ -985,16 +1153,37 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "member": "{service_sid: service_sid, channel_sid: sid}", - "message": "{service_sid: service_sid, channel_sid: sid}", - "invite": "{service_sid: service_sid, channel_sid: sid}" + "members": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Members" + }, + "messages": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Messages" + }, + "invites": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Invites" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV1Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1015,6 +1204,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel" + }, + "examples": { + "create": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -1027,9 +1241,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1055,6 +1266,16 @@ "description": "The visibility of the channel. Can be: `public` or `private` and defaults to `public`." } } + }, + "examples": { + "create": { + "value": { + "Type": "public", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }" + } + } } } } @@ -1062,6 +1283,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV1Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1130,16 +1354,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1148,17 +1374,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "channels": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + } + } + }, + "readEmpty": { + "value": { + "channels": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" } } } @@ -1173,10 +1449,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v1/Credentials": { @@ -1196,6 +1469,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV1Credential" + ], "parameters": [ { "name": "PageSize", @@ -1240,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" @@ -1258,17 +1536,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -1283,19 +1600,33 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", + "tags": [ + "ChatV1Credential" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1308,9 +1639,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1351,6 +1679,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -1374,6 +1709,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV1Credential" + ], "parameters": [ { "name": "Sid", @@ -1394,6 +1732,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1405,13 +1757,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", + "tags": [ + "ChatV1Credential" + ], "parameters": [ { "name": "Sid", @@ -1432,6 +1784,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1444,9 +1810,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1479,6 +1842,13 @@ "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -1486,6 +1856,9 @@ }, "delete": { "description": "", + "tags": [ + "ChatV1Credential" + ], "parameters": [ { "name": "Sid", @@ -1510,10 +1883,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -1529,11 +1899,14 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV1Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -1575,6 +1948,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.invite" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1586,13 +1975,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", + "tags": [ + "ChatV1Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -1638,10 +2027,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -1657,11 +2043,14 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV1Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -1691,6 +2080,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.invite" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1703,9 +2108,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1728,6 +2130,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1735,6 +2145,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV1Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -1766,6 +2179,24 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -1811,16 +2242,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1829,17 +2262,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "invites": [], + "meta": { + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "invites": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" } } } @@ -1854,10 +2328,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInvite" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { @@ -1873,11 +2344,14 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV1Member" + ], "parameters": [ { "name": "ServiceSid", @@ -1919,6 +2393,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.member" + }, + "examples": { + "fetch": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1930,13 +2421,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", + "tags": [ + "ChatV1Member" + ], "parameters": [ { "name": "ServiceSid", @@ -1982,13 +2473,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", + "tags": [ + "ChatV1Member" + ], "parameters": [ { "name": "ServiceSid", @@ -2030,6 +2521,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.member" + }, + "examples": { + "updateRoleSid": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": 666, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2042,9 +2565,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2065,6 +2585,18 @@ "description": "The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member has read within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels)." } } + }, + "examples": { + "updateRoleSid": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "LastConsumedMessageIndex": 666 + } + } } } } @@ -2084,11 +2616,14 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV1Member" + ], "parameters": [ { "name": "ServiceSid", @@ -2118,6 +2653,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.member" + }, + "examples": { + "create": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2130,9 +2682,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2155,6 +2704,13 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio" + } + } } } } @@ -2162,6 +2718,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV1Member" + ], "parameters": [ { "name": "ServiceSid", @@ -2193,6 +2752,12 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -2238,16 +2803,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2256,18 +2823,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [ + { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [] } } } @@ -2281,10 +2890,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -2301,11 +2907,14 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV1Message" + ], "parameters": [ { "name": "ServiceSid", @@ -2350,6 +2959,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.message" + }, + "examples": { + "fetch": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2361,13 +2989,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "delete": { "description": "", + "tags": [ + "ChatV1Message" + ], "parameters": [ { "name": "ServiceSid", @@ -2416,13 +3044,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", + "tags": [ + "ChatV1Message" + ], "parameters": [ { "name": "ServiceSid", @@ -2467,6 +3095,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.message" + }, + "examples": { + "update": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{\"test\": \"test\"}", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2479,9 +3126,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2498,6 +3142,13 @@ "description": "A valid JSON string that contains application-specific data." } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello" + } + } } } } @@ -2518,11 +3169,14 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV1Message" + ], "parameters": [ { "name": "ServiceSid", @@ -2555,6 +3209,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.message" + }, + "examples": { + "create": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithAttributes": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2567,9 +3257,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2593,6 +3280,19 @@ "required": [ "Body" ] + }, + "examples": { + "create": { + "value": { + "Body": "Hello" + } + }, + "createWithAttributes": { + "value": { + "Body": "Hello", + "Attributes": "{\"test\": \"test\"}" + } + } } } } @@ -2600,6 +3300,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV1Message" + ], "parameters": [ { "name": "ServiceSid", @@ -2677,16 +3380,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2695,18 +3400,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [] } } } @@ -2720,10 +3469,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v1/Services/{ServiceSid}/Roles/{Sid}": { @@ -2739,11 +3485,14 @@ "friendly_name", "type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV1Role" + ], "parameters": [ { "name": "ServiceSid", @@ -2776,6 +3525,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2787,13 +3556,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", + "tags": [ + "ChatV1Role" + ], "parameters": [ { "name": "ServiceSid", @@ -2830,13 +3599,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", + "tags": [ + "ChatV1Role" + ], "parameters": [ { "name": "ServiceSid", @@ -2869,6 +3638,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2881,9 +3670,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2902,6 +3688,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -2921,11 +3714,14 @@ "friendly_name", "type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV1Role" + ], "parameters": [ { "name": "ServiceSid", @@ -2946,6 +3742,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2958,9 +3774,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2990,6 +3803,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -2997,6 +3819,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV1Role" + ], "parameters": [ { "name": "ServiceSid", @@ -3053,16 +3878,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3071,18 +3898,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -3096,10 +3968,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v1/Services/{Sid}": { @@ -3115,15 +3984,33 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "channel": "{service_sid: sid}", - "role": "{service_sid: sid}", - "user": "{service_sid: sid}" - } + "channels": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels" + }, + "roles": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Roles" + }, + "users": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Users" + } + }, + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV1Service" + ], "parameters": [ { "name": "Sid", @@ -3144,6 +4031,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": {} + } + } } } }, @@ -3155,13 +4078,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", + "tags": [ + "ChatV1Service" + ], "parameters": [ { "name": "Sid", @@ -3186,13 +4109,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", + "tags": [ + "ChatV1Service" + ], "parameters": [ { "name": "Sid", @@ -3213,6 +4136,140 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 500, + "user_channels": 600 + }, + "links": { + "channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": { + "added_to_channel": { + "enabled": false, + "template": "notifications.added_to_channel.template" + }, + "invited_to_channel": { + "enabled": false, + "template": "notifications.invited_to_channel.template" + }, + "new_message": { + "enabled": false, + "template": "notifications.new_message.template" + }, + "removed_from_channel": { + "enabled": false, + "template": "notifications.removed_from_channel.template" + } + }, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": { + "on_channel_add": { + "format": "webhooks.on_channel_add.format", + "method": "webhooks.on_channel_add.method", + "url": "webhooks.on_channel_add.url" + }, + "on_channel_added": { + "format": "webhooks.on_channel_added.format", + "method": "webhooks.on_channel_added.method", + "url": "webhooks.on_channel_added.url" + }, + "on_channel_destroy": { + "format": "webhooks.on_channel_destroy.format", + "method": "webhooks.on_channel_destroy.method", + "url": "webhooks.on_channel_destroy.url" + }, + "on_channel_destroyed": { + "format": "webhooks.on_channel_destroyed.format", + "method": "webhooks.on_channel_destroyed.method", + "url": "webhooks.on_channel_destroyed.url" + }, + "on_channel_update": { + "format": "webhooks.on_channel_update.format", + "method": "webhooks.on_channel_update.method", + "url": "webhooks.on_channel_update.url" + }, + "on_channel_updated": { + "format": "webhooks.on_channel_updated.format", + "method": "webhooks.on_channel_updated.method", + "url": "webhooks.on_channel_updated.url" + }, + "on_member_add": { + "format": "webhooks.on_member_add.format", + "method": "webhooks.on_member_add.method", + "url": "webhooks.on_member_add.url" + }, + "on_member_added": { + "format": "webhooks.on_member_added.format", + "method": "webhooks.on_member_added.method", + "url": "webhooks.on_member_added.url" + }, + "on_member_remove": { + "format": "webhooks.on_member_remove.format", + "method": "webhooks.on_member_remove.method", + "url": "webhooks.on_member_remove.url" + }, + "on_member_removed": { + "format": "webhooks.on_member_removed.format", + "method": "webhooks.on_member_removed.method", + "url": "webhooks.on_member_removed.url" + }, + "on_message_remove": { + "format": "webhooks.on_message_remove.format", + "method": "webhooks.on_message_remove.method", + "url": "webhooks.on_message_remove.url" + }, + "on_message_removed": { + "format": "webhooks.on_message_removed.format", + "method": "webhooks.on_message_removed.method", + "url": "webhooks.on_message_removed.url" + }, + "on_message_send": { + "format": "webhooks.on_message_send.format", + "method": "webhooks.on_message_send.method", + "url": "webhooks.on_message_send.url" + }, + "on_message_sent": { + "format": "webhooks.on_message_sent.format", + "method": "webhooks.on_message_sent.method", + "url": "webhooks.on_message_sent.url" + }, + "on_message_update": { + "format": "webhooks.on_message_update.format", + "method": "webhooks.on_message_update.method", + "url": "webhooks.on_message_update.url" + }, + "on_message_updated": { + "format": "webhooks.on_message_updated.format", + "method": "webhooks.on_message_updated.method", + "url": "webhooks.on_message_updated.url" + } + } + } + } } } }, @@ -3225,9 +4282,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3635,6 +4689,84 @@ "description": "The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000." } } + }, + "examples": { + "update": { + "value": { + "ConsumptionReportInterval": 100, + "DefaultChannelCreatorRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultChannelRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultServiceRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "Notifications.AddedToChannel.Enabled": false, + "Notifications.AddedToChannel.Template": "notifications.added_to_channel.template", + "Notifications.InvitedToChannel.Enabled": false, + "Notifications.InvitedToChannel.Template": "notifications.invited_to_channel.template", + "Notifications.NewMessage.Enabled": false, + "Notifications.NewMessage.Template": "notifications.new_message.template", + "Notifications.RemovedFromChannel.Enabled": false, + "Notifications.RemovedFromChannel.Template": "notifications.removed_from_channel.template", + "Limits.ChannelMembers": 600, + "Limits.UserChannels": 500, + "PostWebhookUrl": "post_webhook_url", + "PreWebhookUrl": "pre_webhook_url", + "ReachabilityEnabled": false, + "ReadStatusEnabled": false, + "TypingIndicatorTimeout": 100, + "WebhookFilters": [ + "webhook_filters" + ], + "WebhookMethod": "webhook_method", + "Webhooks.OnChannelAdd.Format": "webhooks.on_channel_add.format", + "Webhooks.OnChannelAdd.Method": "webhooks.on_channel_add.method", + "Webhooks.OnChannelAdd.Url": "webhooks.on_channel_add.url", + "Webhooks.OnChannelAdded.Format": "webhooks.on_channel_added.format", + "Webhooks.OnChannelAdded.Method": "webhooks.on_channel_added.method", + "Webhooks.OnChannelAdded.Url": "webhooks.on_channel_added.url", + "Webhooks.OnChannelDestroy.Format": "webhooks.on_channel_destroy.format", + "Webhooks.OnChannelDestroy.Method": "webhooks.on_channel_destroy.method", + "Webhooks.OnChannelDestroy.Url": "webhooks.on_channel_destroy.url", + "Webhooks.OnChannelDestroyed.Format": "webhooks.on_channel_destroyed.format", + "Webhooks.OnChannelDestroyed.Method": "webhooks.on_channel_destroyed.method", + "Webhooks.OnChannelDestroyed.Url": "webhooks.on_channel_destroyed.url", + "Webhooks.OnChannelUpdate.Format": "webhooks.on_channel_update.format", + "Webhooks.OnChannelUpdate.Method": "webhooks.on_channel_update.method", + "Webhooks.OnChannelUpdate.Url": "webhooks.on_channel_update.url", + "Webhooks.OnChannelUpdated.Format": "webhooks.on_channel_updated.format", + "Webhooks.OnChannelUpdated.Method": "webhooks.on_channel_updated.method", + "Webhooks.OnChannelUpdated.Url": "webhooks.on_channel_updated.url", + "Webhooks.OnMemberAdd.Format": "webhooks.on_member_add.format", + "Webhooks.OnMemberAdd.Method": "webhooks.on_member_add.method", + "Webhooks.OnMemberAdd.Url": "webhooks.on_member_add.url", + "Webhooks.OnMemberAdded.Format": "webhooks.on_member_added.format", + "Webhooks.OnMemberAdded.Method": "webhooks.on_member_added.method", + "Webhooks.OnMemberAdded.Url": "webhooks.on_member_added.url", + "Webhooks.OnMemberRemove.Format": "webhooks.on_member_remove.format", + "Webhooks.OnMemberRemove.Method": "webhooks.on_member_remove.method", + "Webhooks.OnMemberRemove.Url": "webhooks.on_member_remove.url", + "Webhooks.OnMemberRemoved.Format": "webhooks.on_member_removed.format", + "Webhooks.OnMemberRemoved.Method": "webhooks.on_member_removed.method", + "Webhooks.OnMemberRemoved.Url": "webhooks.on_member_removed.url", + "Webhooks.OnMessageRemove.Format": "webhooks.on_message_remove.format", + "Webhooks.OnMessageRemove.Method": "webhooks.on_message_remove.method", + "Webhooks.OnMessageRemove.Url": "webhooks.on_message_remove.url", + "Webhooks.OnMessageRemoved.Format": "webhooks.on_message_removed.format", + "Webhooks.OnMessageRemoved.Method": "webhooks.on_message_removed.method", + "Webhooks.OnMessageRemoved.Url": "webhooks.on_message_removed.url", + "Webhooks.OnMessageSend.Format": "webhooks.on_message_send.format", + "Webhooks.OnMessageSend.Method": "webhooks.on_message_send.method", + "Webhooks.OnMessageSend.Url": "webhooks.on_message_send.url", + "Webhooks.OnMessageSent.Format": "webhooks.on_message_sent.format", + "Webhooks.OnMessageSent.Method": "webhooks.on_message_sent.method", + "Webhooks.OnMessageSent.Url": "webhooks.on_message_sent.url", + "Webhooks.OnMessageUpdate.Format": "webhooks.on_message_update.format", + "Webhooks.OnMessageUpdate.Method": "webhooks.on_message_update.method", + "Webhooks.OnMessageUpdate.Url": "webhooks.on_message_update.url", + "Webhooks.OnMessageUpdated.Format": "webhooks.on_message_updated.format", + "Webhooks.OnMessageUpdated.Method": "webhooks.on_message_updated.method", + "Webhooks.OnMessageUpdated.Url": "webhooks.on_message_updated.url" + } + } } } } @@ -3654,21 +4786,75 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "channel": "{service_sid: sid}", - "role": "{service_sid: sid}", - "user": "{service_sid: sid}" - } + "channels": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels" + }, + "roles": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Roles" + }, + "users": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Users" + } + }, + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV1Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": {} + } + } } } }, @@ -3681,9 +4867,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3699,6 +4882,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -3706,6 +4896,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV1Service" + ], "parameters": [ { "name": "PageSize", @@ -3750,16 +4943,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3768,18 +4963,179 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://chat.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://chat.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "user_channels": 250, + "channel_members": 100, + "actions_per_second": 30 + }, + "links": { + "channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": { + "added_to_channel": { + "enabled": false, + "template": "notifications.added_to_channel.template" + }, + "invited_to_channel": { + "enabled": false, + "template": "notifications.invited_to_channel.template" + }, + "log_enabled": true, + "new_message": { + "enabled": false, + "template": "notifications.new_message.template" + }, + "removed_from_channel": { + "enabled": false, + "template": "notifications.removed_from_channel.template" + } + }, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": { + "on_channel_add": { + "format": "webhooks.on_channel_add.format", + "method": "webhooks.on_channel_add.method", + "url": "webhooks.on_channel_add.url" + }, + "on_channel_added": { + "format": "webhooks.on_channel_added.format", + "method": "webhooks.on_channel_added.method", + "url": "webhooks.on_channel_added.url" + }, + "on_channel_destroy": { + "format": "webhooks.on_channel_destroy.format", + "method": "webhooks.on_channel_destroy.method", + "url": "webhooks.on_channel_destroy.url" + }, + "on_channel_destroyed": { + "format": "webhooks.on_channel_destroyed.format", + "method": "webhooks.on_channel_destroyed.method", + "url": "webhooks.on_channel_destroyed.url" + }, + "on_channel_update": { + "format": "webhooks.on_channel_update.format", + "method": "webhooks.on_channel_update.method", + "url": "webhooks.on_channel_update.url" + }, + "on_channel_updated": { + "format": "webhooks.on_channel_updated.format", + "method": "webhooks.on_channel_updated.method", + "url": "webhooks.on_channel_updated.url" + }, + "on_member_add": { + "format": "webhooks.on_member_add.format", + "method": "webhooks.on_member_add.method", + "url": "webhooks.on_member_add.url" + }, + "on_member_added": { + "format": "webhooks.on_member_added.format", + "method": "webhooks.on_member_added.method", + "url": "webhooks.on_member_added.url" + }, + "on_member_remove": { + "format": "webhooks.on_member_remove.format", + "method": "webhooks.on_member_remove.method", + "url": "webhooks.on_member_remove.url" + }, + "on_member_removed": { + "format": "webhooks.on_member_removed.format", + "method": "webhooks.on_member_removed.method", + "url": "webhooks.on_member_removed.url" + }, + "on_message_remove": { + "format": "webhooks.on_message_remove.format", + "method": "webhooks.on_message_remove.method", + "url": "webhooks.on_message_remove.url" + }, + "on_message_removed": { + "format": "webhooks.on_message_removed.format", + "method": "webhooks.on_message_removed.method", + "url": "webhooks.on_message_removed.url" + }, + "on_message_send": { + "format": "webhooks.on_message_send.format", + "method": "webhooks.on_message_send.method", + "url": "webhooks.on_message_send.url" + }, + "on_message_sent": { + "format": "webhooks.on_message_sent.format", + "method": "webhooks.on_message_sent.method", + "url": "webhooks.on_message_sent.url" + }, + "on_message_update": { + "format": "webhooks.on_message_update.format", + "method": "webhooks.on_message_update.method", + "url": "webhooks.on_message_update.url" + }, + "on_message_updated": { + "format": "webhooks.on_message_updated.format", + "method": "webhooks.on_message_updated.method", + "url": "webhooks.on_message_updated.url" + } + } + } + ] } } } @@ -3793,10 +5149,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{ServiceSid}/Users/{Sid}": { @@ -3812,14 +5165,23 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "user_channel": "{service_sid: service_sid, user_sid: sid}" + "user_channels": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Users/{user_sid}/Channels" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV1User" + ], "parameters": [ { "name": "ServiceSid", @@ -3849,6 +5211,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3860,13 +5244,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", + "tags": [ + "ChatV1User" + ], "parameters": [ { "name": "ServiceSid", @@ -3900,13 +5284,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", + "tags": [ + "ChatV1User" + ], "parameters": [ { "name": "ServiceSid", @@ -3936,6 +5320,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3948,9 +5354,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3974,6 +5377,15 @@ "description": "A descriptive string that you create to describe the resource. It is often used for display purposes." } } + }, + "examples": { + "update": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -3993,14 +5405,23 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "user_channel": "{service_sid: service_sid, user_sid: sid}" + "user_channels": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Users/{user_sid}/Channels" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV1User" + ], "parameters": [ { "name": "ServiceSid", @@ -4021,6 +5442,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4033,9 +5476,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4066,6 +5506,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -4073,6 +5523,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV1User" + ], "parameters": [ { "name": "ServiceSid", @@ -4129,16 +5582,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4147,18 +5602,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "joined_channels_count": 0, + "links": { + "user_channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [] } } } @@ -4172,10 +5674,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -4184,18 +5683,21 @@ "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.", + "tags": [ + "ChatV1UserChannel" + ], "parameters": [ { "name": "ServiceSid", @@ -4261,16 +5763,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4279,18 +5783,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "links": { + "channel": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [] } } } @@ -4304,10 +5850,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } } }, @@ -4316,10 +5859,38 @@ "url": "https://chat.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "ChatV1Channel" + }, + { + "name": "ChatV1Credential" + }, + { + "name": "ChatV1Invite" + }, + { + "name": "ChatV1Member" + }, + { + "name": "ChatV1Message" + }, + { + "name": "ChatV1Role" + }, + { + "name": "ChatV1Service" + }, + { + "name": "ChatV1User" + }, + { + "name": "ChatV1UserChannel" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_chat_v2.json b/spec/json/twilio_chat_v2.json index c4407493..2f942c94 100644 --- a/spec/json/twilio_chat_v2.json +++ b/spec/json/twilio_chat_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "chat.v2.service.binding": { "type": "object", @@ -43,12 +49,24 @@ "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`." + "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "credential_sid": { "type": "string", @@ -124,17 +142,35 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -157,7 +193,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`." + "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "members_count": { "type": "integer", @@ -298,7 +340,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -377,7 +425,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -450,7 +504,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -492,7 +552,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } } } }, @@ -525,7 +591,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "service_sid": { "type": "string", @@ -566,7 +638,13 @@ "last_updated_by": { "type": "string", "nullable": true, - "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable." + "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "was_edited": { "type": "boolean", @@ -576,12 +654,24 @@ "from": { "type": "string", "nullable": true, - "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. The default value is `system`." + "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. The default value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "body": { "type": "string", "nullable": true, - "description": "The content of the message." + "description": "The content of the message.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "index": { "type": "integer", @@ -595,7 +685,13 @@ }, "media": { "nullable": true, - "description": "An object that describes the Message's media, if the message contains media. The object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`." + "description": "An object that describes the Message's media, if the message contains media. The object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -649,7 +745,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -714,7 +816,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -861,12 +969,24 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "role_sid": { "type": "string", @@ -879,7 +999,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This value is often a username or an email address, and is case-sensitive. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's User within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This value is often a username or an email address, and is case-sensitive. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "is_online": { "type": "boolean", @@ -971,12 +1097,24 @@ "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the User Binding. The format of the value depends on the `binding_type`." + "description": "The unique endpoint identifier for the User Binding. The format of the value depends on the `binding_type`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "user_sid": { "type": "string", @@ -1125,12 +1263,6 @@ "false" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1146,7 +1278,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1163,11 +1295,14 @@ "endpoint", "identity" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "ChatV2Binding" + ], "parameters": [ { "name": "ServiceSid", @@ -1202,6 +1337,12 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -1247,16 +1388,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1265,18 +1408,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [ + { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [] } } } @@ -1290,10 +1483,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListBinding" } }, "/v2/Services/{ServiceSid}/Bindings/{Sid}": { @@ -1309,11 +1499,14 @@ "endpoint", "identity" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV2Binding" + ], "parameters": [ { "name": "ServiceSid", @@ -1346,6 +1539,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.binding" + }, + "examples": { + "fetch": { + "value": { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser" + } + } + } } } }, @@ -1357,13 +1575,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBinding" }, "delete": { "description": "", + "tags": [ + "ChatV2Binding" + ], "parameters": [ { "name": "ServiceSid", @@ -1400,10 +1618,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteBinding" } }, "/v2/Services/{ServiceSid}/Channels/{Sid}": { @@ -1419,17 +1634,44 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "member": "{service_sid: service_sid, channel_sid: sid}", - "message": "{service_sid: service_sid, channel_sid: sid}", - "invite": "{service_sid: service_sid, channel_sid: sid}", - "webhook": "{service_sid: service_sid, channel_sid: sid}" + "members": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Members" + }, + "messages": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Messages" + }, + "invites": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Invites" + }, + "webhooks": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV2Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1459,6 +1701,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1470,13 +1738,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", + "tags": [ + "ChatV2Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1519,13 +1787,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", + "tags": [ + "ChatV2Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1564,6 +1832,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "created_by": "username", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1576,9 +1870,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1613,6 +1904,19 @@ "description": "The `identity` of the User that created the channel. Default is: `system`." } } + }, + "examples": { + "update": { + "value": { + "Type": "channel", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "CreatedBy": "username" + } + } } } } @@ -1632,17 +1936,44 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "member": "{service_sid: service_sid, channel_sid: sid}", - "message": "{service_sid: service_sid, channel_sid: sid}", - "invite": "{service_sid: service_sid, channel_sid: sid}", - "webhook": "{service_sid: service_sid, channel_sid: sid}" + "members": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Members" + }, + "messages": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Messages" + }, + "invites": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Invites" + }, + "webhooks": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV2Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1672,6 +2003,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel" + }, + "examples": { + "create": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "created_by": "username", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1684,9 +2041,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1726,6 +2080,19 @@ "description": "The `identity` of the User that created the channel. Default is: `system`." } } + }, + "examples": { + "create": { + "value": { + "Type": "public", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "CreatedBy": "username" + } + } } } } @@ -1733,6 +2100,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV2Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1801,16 +2171,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1819,17 +2191,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "channels": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + } + } + }, + "readEmpty": { + "value": { + "channels": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" } } } @@ -1844,10 +2267,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks": { @@ -1862,11 +2282,14 @@ "sid", "configuration" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "ChatV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -1932,16 +2355,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1950,18 +2375,98 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "webhook", + "configuration": { + "url": "dummy", + "method": "GET", + "filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "retry_count": 2 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "trigger", + "configuration": { + "url": "dummy", + "method": "POST", + "filters": [ + "keyword1", + "keyword2" + ], + "retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [] } } } @@ -1975,13 +2480,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannelWebhook" }, "post": { "description": "", + "tags": [ + "ChatV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -2011,6 +2516,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.channel_webhook" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "webhook", + "configuration": { + "url": "dummy", + "method": "GET", + "filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "retry_count": 2 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2023,9 +2551,6 @@ } ], "operationId": "CreateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2076,6 +2601,20 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "webhook", + "Configuration.Url": "dummy", + "Configuration.Method": "GET", + "Configuration.Filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "Configuration.RetryCount": 2 + } + } } } } @@ -2094,11 +2633,14 @@ "sid", "configuration" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -2140,6 +2682,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.channel_webhook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2151,13 +2710,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannelWebhook" }, "post": { "description": "", + "tags": [ + "ChatV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -2199,6 +2758,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.channel_webhook" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "trigger", + "configuration": { + "url": "dummy", + "method": "POST", + "filters": [ + "keyword1", + "keyword2" + ], + "retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2211,9 +2793,6 @@ } ], "operationId": "UpdateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2256,6 +2835,19 @@ "description": "The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0." } } + }, + "examples": { + "update": { + "value": { + "Configuration.Url": "dummy", + "Configuration.Method": "POST", + "Configuration.Triggers": [ + "keyword1", + "keyword2" + ], + "Configuration.RetryCount": 5 + } + } } } } @@ -2263,6 +2855,9 @@ }, "delete": { "description": "", + "tags": [ + "ChatV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -2308,10 +2903,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannelWebhook" } }, "/v2/Credentials": { @@ -2331,6 +2923,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV2Credential" + ], "parameters": [ { "name": "PageSize", @@ -2375,16 +2970,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2393,17 +2990,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -2418,19 +3054,33 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", + "tags": [ + "ChatV2Credential" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2443,9 +3093,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2486,6 +3133,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -2509,6 +3163,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV2Credential" + ], "parameters": [ { "name": "Sid", @@ -2529,6 +3186,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2540,13 +3211,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", + "tags": [ + "ChatV2Credential" + ], "parameters": [ { "name": "Sid", @@ -2567,6 +3238,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2579,9 +3264,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2614,6 +3296,13 @@ "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -2621,6 +3310,9 @@ }, "delete": { "description": "", + "tags": [ + "ChatV2Credential" + ], "parameters": [ { "name": "Sid", @@ -2645,10 +3337,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -2664,11 +3353,14 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV2Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -2710,6 +3402,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.invite" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2721,13 +3429,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", + "tags": [ + "ChatV2Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -2773,10 +3481,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -2792,11 +3497,14 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV2Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -2826,6 +3534,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.invite" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2838,9 +3562,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2863,6 +3584,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2870,6 +3599,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV2Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -2901,6 +3633,24 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -2946,16 +3696,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2964,17 +3716,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "invites": [], + "meta": { + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "invites": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" } } } @@ -2989,10 +3782,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { @@ -3008,11 +3798,14 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV2Member" + ], "parameters": [ { "name": "ServiceSid", @@ -3051,6 +3844,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.member" + }, + "examples": { + "fetch": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3062,13 +3873,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", + "tags": [ + "ChatV2Member" + ], "parameters": [ { "name": "ServiceSid", @@ -3120,13 +3931,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", + "tags": [ + "ChatV2Member" + ], "parameters": [ { "name": "ServiceSid", @@ -3174,6 +3985,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.member" + }, + "examples": { + "updateRoleSid": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": 20, + "last_consumption_timestamp": "2016-03-24T21:05:52Z", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "attributes": "{}", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3186,9 +4015,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3228,6 +4054,18 @@ "description": "A valid JSON string that contains application-specific data." } } + }, + "examples": { + "updateRoleSid": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2016-03-24T21:05:50Z", + "DateUpdated": "2016-03-24T21:05:51Z", + "LastConsumedMessageIndex": 20, + "LastConsumptionTimestamp": "2016-03-24T21:05:52Z", + "Attributes": "{}" + } + } } } } @@ -3247,11 +4085,14 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV2Member" + ], "parameters": [ { "name": "ServiceSid", @@ -3290,6 +4131,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.member" + }, + "examples": { + "create": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3302,9 +4161,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3351,6 +4207,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio", + "Attributes": "{}" + } + } } } } @@ -3358,6 +4222,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV2Member" + ], "parameters": [ { "name": "ServiceSid", @@ -3389,6 +4256,12 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -3434,16 +4307,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3452,18 +4327,61 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [ + { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [] } } } @@ -3477,10 +4395,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -3497,11 +4412,14 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV2Message" + ], "parameters": [ { "name": "ServiceSid", @@ -3543,6 +4461,53 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.message" + }, + "examples": { + "fetch": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchMedia": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "media", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3554,13 +4519,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "delete": { "description": "", + "tags": [ + "ChatV2Message" + ], "parameters": [ { "name": "ServiceSid", @@ -3615,13 +4580,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", + "tags": [ + "ChatV2Message" + ], "parameters": [ { "name": "ServiceSid", @@ -3672,6 +4637,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.message" + }, + "examples": { + "update": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"foo\": \"bar\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "last_updated_by": "username", + "was_edited": true, + "from": "fromUser", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3684,9 +4671,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3721,6 +4705,18 @@ "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author." } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "LastUpdatedBy": "username", + "From": "fromUser" + } + } } } } @@ -3741,11 +4737,14 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV2Message" + ], "parameters": [ { "name": "ServiceSid", @@ -3784,6 +4783,73 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.message" + }, + "examples": { + "create": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": "system", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithAll": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "last_updated_by": "username", + "was_edited": true, + "from": "system", + "attributes": "{\"test\": \"test\"}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createMedia": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": "system", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "type": "text", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3796,9 +4862,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3840,6 +4903,27 @@ "description": "The SID of the [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new Message." } } + }, + "examples": { + "create": { + "value": { + "Body": "Hello" + } + }, + "createWithAll": { + "value": { + "Body": "Hello", + "Attributes": "{\"test\": \"test\"}", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "LastUpdatedBy": "username" + } + }, + "createMedia": { + "value": { + "MediaSid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3847,6 +4931,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV2Message" + ], "parameters": [ { "name": "ServiceSid", @@ -3921,16 +5008,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3939,18 +5028,88 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "media", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [] } } } @@ -3964,10 +5123,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v2/Services/{ServiceSid}/Roles/{Sid}": { @@ -3983,11 +5139,14 @@ "friendly_name", "type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV2Role" + ], "parameters": [ { "name": "ServiceSid", @@ -4020,6 +5179,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4031,13 +5210,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", + "tags": [ + "ChatV2Role" + ], "parameters": [ { "name": "ServiceSid", @@ -4074,13 +5253,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", + "tags": [ + "ChatV2Role" + ], "parameters": [ { "name": "ServiceSid", @@ -4113,6 +5292,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4125,9 +5324,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4146,6 +5342,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -4165,11 +5368,14 @@ "friendly_name", "type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV2Role" + ], "parameters": [ { "name": "ServiceSid", @@ -4190,6 +5396,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4202,9 +5428,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4234,6 +5457,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -4241,6 +5473,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV2Role" + ], "parameters": [ { "name": "ServiceSid", @@ -4297,16 +5532,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4315,18 +5552,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -4340,10 +5622,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v2/Services/{Sid}": { @@ -4359,16 +5638,39 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "channel": "{service_sid: sid}", - "role": "{service_sid: sid}", - "user": "{service_sid: sid}", - "binding": "{service_sid: sid}" - } + "channels": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels" + }, + "roles": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Roles" + }, + "users": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users" + }, + "bindings": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Bindings" + } + }, + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV2Service" + ], "parameters": [ { "name": "Sid", @@ -4389,6 +5691,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + } } } }, @@ -4400,13 +5744,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", + "tags": [ + "ChatV2Service" + ], "parameters": [ { "name": "Sid", @@ -4431,13 +5775,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", + "tags": [ + "ChatV2Service" + ], "parameters": [ { "name": "Sid", @@ -4458,6 +5802,67 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 500, + "user_channels": 600 + }, + "links": { + "channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": { + "log_enabled": true, + "added_to_channel": { + "enabled": false, + "template": "notifications.added_to_channel.template" + }, + "invited_to_channel": { + "enabled": false, + "template": "notifications.invited_to_channel.template" + }, + "new_message": { + "enabled": false, + "template": "notifications.new_message.template", + "badge_count_enabled": true + }, + "removed_from_channel": { + "enabled": false, + "template": "notifications.removed_from_channel.template" + } + }, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "new media compatibility message" + } + } + } } } }, @@ -4470,9 +5875,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4628,6 +6030,41 @@ "description": "Whether to log notifications. The default is `false`." } } + }, + "examples": { + "update": { + "value": { + "ConsumptionReportInterval": 100, + "DefaultChannelCreatorRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultChannelRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultServiceRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "Notifications.AddedToChannel.Enabled": false, + "Notifications.AddedToChannel.Template": "notifications.added_to_channel.template", + "Notifications.InvitedToChannel.Enabled": false, + "Notifications.InvitedToChannel.Template": "notifications.invited_to_channel.template", + "Notifications.NewMessage.Enabled": false, + "Notifications.NewMessage.Template": "notifications.new_message.template", + "Notifications.NewMessage.BadgeCountEnabled": true, + "Notifications.RemovedFromChannel.Enabled": false, + "Notifications.RemovedFromChannel.Template": "notifications.removed_from_channel.template", + "Notifications.LogEnabled": true, + "Limits.ChannelMembers": 600, + "Limits.UserChannels": 500, + "PostWebhookUrl": "post_webhook_url", + "PreWebhookUrl": "pre_webhook_url", + "PreWebhookRetryCount": 2, + "PostWebhookRetryCount": 3, + "ReachabilityEnabled": false, + "ReadStatusEnabled": false, + "TypingIndicatorTimeout": 100, + "WebhookFilters": [ + "webhook_filters" + ], + "WebhookMethod": "webhook_method", + "Media.CompatibilityMessage": "new media compatibility message" + } + } } } } @@ -4647,22 +6084,87 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "channel": "{service_sid: sid}", - "role": "{service_sid: sid}", - "user": "{service_sid: sid}", - "binding": "{service_sid: sid}" - } + "channels": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels" + }, + "roles": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Roles" + }, + "users": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users" + }, + "bindings": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Bindings" + } + }, + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV2Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + } } } }, @@ -4675,9 +6177,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4693,6 +6192,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -4700,6 +6206,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV2Service" + ], "parameters": [ { "name": "PageSize", @@ -4744,16 +6253,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4762,18 +6273,85 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://chat.twilio.com/v2/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services?PageSize=50&Page=0" + }, + "services": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://chat.twilio.com/v2/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + ] } } } @@ -4787,10 +6365,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v2/Services/{ServiceSid}/Users/{Sid}": { @@ -4807,15 +6382,30 @@ "identity", "date_created" ], - "pathType": "instance", "dependentProperties": { - "user_channel": "{service_sid: service_sid, user_sid: sid}", - "user_binding": "{service_sid: service_sid, user_sid: sid}" + "user_channels": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Channels" + }, + "user_bindings": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Bindings" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV2User" + ], "parameters": [ { "name": "ServiceSid", @@ -4845,6 +6435,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4856,13 +6469,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", + "tags": [ + "ChatV2User" + ], "parameters": [ { "name": "ServiceSid", @@ -4896,13 +6509,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", + "tags": [ + "ChatV2User" + ], "parameters": [ { "name": "ServiceSid", @@ -4941,6 +6554,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4953,9 +6589,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4979,6 +6612,15 @@ "description": "A descriptive string that you create to describe the resource. It is often used for display purposes." } } + }, + "examples": { + "update": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -4999,15 +6641,30 @@ "identity", "date_created" ], - "pathType": "list", "dependentProperties": { - "user_channel": "{service_sid: service_sid, user_sid: sid}", - "user_binding": "{service_sid: service_sid, user_sid: sid}" + "user_channels": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Channels" + }, + "user_bindings": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Bindings" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "ChatV2User" + ], "parameters": [ { "name": "ServiceSid", @@ -5037,6 +6694,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5049,9 +6729,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5082,6 +6759,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -5089,6 +6776,9 @@ }, "get": { "description": "", + "tags": [ + "ChatV2User" + ], "parameters": [ { "name": "ServiceSid", @@ -5145,16 +6835,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5163,18 +6855,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "joined_channels_count": 0, + "links": { + "user_channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [] } } } @@ -5188,10 +6928,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings": { @@ -5208,12 +6945,15 @@ "identity", "binding_type" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "ChatV2UserBinding" + ], "parameters": [ { "name": "ServiceSid", @@ -5291,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" @@ -5309,18 +7051,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [ + { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [] } } } @@ -5334,10 +7124,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}": { @@ -5354,12 +7141,15 @@ "identity", "binding_type" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV2UserBinding" + ], "parameters": [ { "name": "ServiceSid", @@ -5401,6 +7191,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user.user_binding" + }, + "examples": { + "fetch": { + "value": { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5412,13 +7225,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserBinding" }, "delete": { "description": "", + "tags": [ + "ChatV2UserBinding" + ], "parameters": [ { "name": "ServiceSid", @@ -5464,10 +7277,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -5482,12 +7292,15 @@ "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.", + "tags": [ + "ChatV2UserChannel" + ], "parameters": [ { "name": "ServiceSid", @@ -5553,16 +7366,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5571,18 +7386,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "default", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [] } } } @@ -5596,10 +7456,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}": { @@ -5614,12 +7471,15 @@ "channel_sid", "status" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_channels" + "mountName": "user_channels", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ChatV2UserChannel" + ], "parameters": [ { "name": "ServiceSid", @@ -5658,6 +7518,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user.user_channel" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "default", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -5669,13 +7549,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserChannel" }, "delete": { "description": "Removes User from selected Channel.", + "tags": [ + "ChatV2UserChannel" + ], "parameters": [ { "name": "ServiceSid", @@ -5727,13 +7607,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserChannel" }, "post": { "description": "", + "tags": [ + "ChatV2UserChannel" + ], "parameters": [ { "name": "ServiceSid", @@ -5772,6 +7652,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user.user_channel" + }, + "examples": { + "updateNotificationLevel": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "muted", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 10, + "unread_messages_count": 5, + "notification_level": "muted", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -5784,9 +7702,6 @@ } ], "operationId": "UpdateUserChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5810,6 +7725,18 @@ "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels)." } } + }, + "examples": { + "updateNotificationLevel": { + "value": { + "NotificationLevel": "muted" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "LastConsumedMessageIndex": 10 + } + } } } } @@ -5822,10 +7749,47 @@ "url": "https://chat.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "ChatV2Binding" + }, + { + "name": "ChatV2Channel" + }, + { + "name": "ChatV2Credential" + }, + { + "name": "ChatV2Invite" + }, + { + "name": "ChatV2Member" + }, + { + "name": "ChatV2Message" + }, + { + "name": "ChatV2Role" + }, + { + "name": "ChatV2Service" + }, + { + "name": "ChatV2User" + }, + { + "name": "ChatV2UserBinding" + }, + { + "name": "ChatV2UserChannel" + }, + { + "name": "ChatV2Webhook" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_chat_v3.json b/spec/json/twilio_chat_v3.json index d285462f..7795626a 100644 --- a/spec/json/twilio_chat_v3.json +++ b/spec/json/twilio_chat_v3.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "chat.v3.channel": { "type": "object", @@ -31,17 +37,35 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -64,7 +88,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`." + "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "members_count": { "type": "integer", @@ -82,7 +112,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this channel belongs to." + "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to." }, "url": { "type": "string", @@ -106,12 +136,6 @@ "false" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -127,7 +151,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -148,6 +172,9 @@ }, "post": { "description": "Update a specific Channel.", + "tags": [ + "ChatV3Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -186,6 +213,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v3.channel" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "created_by": "username", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v3/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -198,9 +245,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -218,7 +262,15 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this channel belongs to." + "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" } } } @@ -249,10 +301,14 @@ "url": "https://chat.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "ChatV3Channel" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_content_sdk.json b/spec/json/twilio_content_sdk.json new file mode 100644 index 00000000..9194d287 --- /dev/null +++ b/spec/json/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/{Sid}/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": "Sid", + "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/{Sid}/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": "Sid", + "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/spec/json/twilio_content_v1.json b/spec/json/twilio_content_v1.json index de32f0ec..4fba59f7 100644 --- a/spec/json/twilio_content_v1.json +++ b/spec/json/twilio_content_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "content.v1.content.approval_fetch": { "type": "object", @@ -79,7 +85,7 @@ }, "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." + "description": "The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource." }, "url": { "type": "string", @@ -142,7 +148,7 @@ }, "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." + "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, @@ -197,7 +203,7 @@ }, "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." + "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", @@ -217,12 +223,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -238,7 +238,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -255,12 +255,15 @@ "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", + "tags": [ + "ContentV1ApprovalFetch" + ], "parameters": [ { "name": "Sid", @@ -281,6 +284,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/content.v1.content.approval_fetch" + }, + "examples": { + "getApproval": { + "value": { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "whatsapp": { + "type": "whatsapp", + "name": "tree_fiddy", + "category": "ACCOUNT_UPDATE", + "content_type": "twilio/location", + "status": "approved", + "rejection_reason": "", + "allow_category_change": true + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + } } } }, @@ -292,10 +313,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchApprovalFetch", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchApprovalFetch" } }, "/v1/Content/{Sid}": { @@ -316,15 +334,28 @@ "variables", "types" ], - "pathType": "instance", "dependentProperties": { - "content/v1/approval_create": "{sid: sid}", - "approval_fetch": "{sid: sid}" + "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" + "mountName": "contents", + "pathType": "instance" }, "get": { "description": "Fetch a Content resource by its unique Content Sid", + "tags": [ + "ContentV1Content" + ], "parameters": [ { "name": "Sid", @@ -345,6 +376,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/content.v1.content" + }, + "examples": { + "fetch": { + "value": { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + } + } } } }, @@ -356,13 +417,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchContent", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchContent" }, "delete": { "description": "Deletes a Content resource", + "tags": [ + "ContentV1Content" + ], "parameters": [ { "name": "Sid", @@ -387,10 +448,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteContent", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteContent" } }, "/v1/Content": { @@ -411,15 +469,28 @@ "variables", "types" ], - "pathType": "list", "dependentProperties": { - "content/v1/approval_create": "{sid: sid}", - "approval_fetch": "{sid: sid}" + "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" + "mountName": "contents", + "pathType": "list" }, "get": { "description": "Retrieve a list of Contents belonging to the account used to make the request", + "tags": [ + "ContentV1Content" + ], "parameters": [ { "name": "PageSize", @@ -464,16 +535,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -482,17 +555,124 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "contents": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://content.twilio.com/v1/Content?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/Content?PageSize=10&Page=0", + "next_page_url": null, + "key": "contents" + } + } + }, + "readResults": { + "value": { + "contents": [ + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Anotha content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Third content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://content.twilio.com/v1/Content?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/Content?PageSize=20&Page=0", + "next_page_url": null, + "key": "contents" } } } @@ -507,10 +687,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListContent", - "x-maturity": [ - "Preview" - ] + "operationId": "ListContent" } }, "/v1/ContentAndApprovals": { @@ -532,11 +709,14 @@ "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", + "tags": [ + "ContentV1ContentAndApprovals" + ], "parameters": [ { "name": "PageSize", @@ -581,16 +761,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -599,17 +781,132 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "contents": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0", + "previous_page_url": null, + "next_page_url": null, + "url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0", + "key": "contents" + } + } + }, + "readResults": { + "value": { + "contents": [ + { + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "approval_requests": { + "name": "", + "category": "", + "content_type": "", + "status": "unsubmitted", + "rejection_reason": "", + "allow_category_change": true + } + }, + { + "language": "en", + "date_updated": "2023-01-13T23:33:46Z", + "variables": { + "1": "name", + "2": "typedocument" + }, + "friendly_name": "Media Test", + "account_sid": "AC25c0d4b9093547216c460212e24e77ee", + "sid": "HX5fcd48a417c1cb59da349ad6d5da4607", + "date_created": "2023-01-13T23:33:46Z", + "types": { + "twilio/media": { + "body": "{{1}}, Congratulations {{2}}! For additional assistance, please contact us at hello@twilio.com", + "media": [ + "https://example.com/template" + ] + } + }, + "approval_requests": { + "category": "TRANSACTIONAL", + "status": "approved", + "rejection_reason": "", + "name": "Media Test", + "content_type": "twilio/media", + "allow_category_change": false + } + }, + { + "language": "en", + "date_updated": "2023-01-18T02:46:35Z", + "variables": { + "1": "name", + "2": "type_video", + "3": "small.mp4" + }, + "friendly_name": "Video Highlights", + "account_sid": "AC25c0d4b9093547216c460212e24e77ee", + "sid": "HX15c711fcc6d9ea5268d7ab77938a20ff", + "date_created": "2023-01-18T02:46:35Z", + "types": { + "twilio/media": { + "body": "Hi there, {{1}}, we have received your request to upload {{2}}, and should be uploaded shortly.", + "media": [ + "http://example.com/highlights/{{3}}" + ] + } + }, + "approval_requests": { + "category": "TRANSACTIONAL", + "status": "rejected", + "rejection_reason": "INVALID_FORMAT. Facebook is not able to create template with templateName=Video Highlights_hx15c711fcc6d9ea5268d7ab77938a20ff due to the following error: Invalid parameter. More Details: Message template 'components' param is missing expected field(s). component of type HEADER is missing expected field(s) (example)", + "name": "Video Highlights", + "content_type": "twilio/media", + "allow_category_change": true + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0", + "url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "contents" } } } @@ -624,10 +921,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListContentAndApprovals", - "x-maturity": [ - "Preview" - ] + "operationId": "ListContentAndApprovals" } }, "/v1/LegacyContent": { @@ -650,11 +944,14 @@ "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", + "tags": [ + "ContentV1LegacyContent" + ], "parameters": [ { "name": "PageSize", @@ -699,16 +996,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -717,17 +1016,118 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "contents": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0", + "next_page_url": null, + "key": "contents" + } + } + }, + "readResults": { + "value": { + "contents": [ + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "legacy_template_name": "legacy_template_1", + "legacy_body": "a body", + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/LegacyContent", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z" + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Anotha content", + "language": "en", + "variables": { + "name": "foo" + }, + "legacy_template_name": "legacy_template_2", + "legacy_body": "another body", + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/LegacyContent", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z" + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Third content", + "language": "en", + "variables": { + "name": "foo" + }, + "legacy_template_name": "legacy_template_3", + "legacy_body": "a third body", + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/LegacyContent", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0", + "next_page_url": null, + "key": "contents" } } } @@ -742,10 +1142,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListLegacyContent", - "x-maturity": [ - "Preview" - ] + "operationId": "ListLegacyContent" } } }, @@ -754,10 +1151,26 @@ "url": "https://content.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "ContentV1ApprovalCreate" + }, + { + "name": "ContentV1ApprovalFetch" + }, + { + "name": "ContentV1Content" + }, + { + "name": "ContentV1ContentAndApprovals" + }, + { + "name": "ContentV1LegacyContent" + } + ], + "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 help@twilio.com." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_conversations_v1.json b/spec/json/twilio_conversations_v1.json index e46a57db..b66473c6 100644 --- a/spec/json/twilio_conversations_v1.json +++ b/spec/json/twilio_conversations_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "conversations.v1.configuration": { "type": "object", @@ -26,7 +32,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the default [Messaging Service](https://www.twilio.com/docs/sms/services/api) used when creating a conversation." + "description": "The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) used when creating a conversation." }, "default_inactive_timer": { "type": "string", @@ -79,7 +85,13 @@ "address": { "type": "string", "nullable": true, - "description": "The unique address to be configured. The address can be a whatsapp address or phone number" + "description": "The unique address to be configured. The address can be a whatsapp address or phone number", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", @@ -121,7 +133,8 @@ "sms", "whatsapp", "messenger", - "gbm" + "gbm", + "email" ] }, "configuration_address_enum_auto_creation_type": { @@ -227,7 +240,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to." + "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to." }, "sid": { "type": "string", @@ -240,17 +253,35 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "state": { "type": "string", @@ -341,23 +372,47 @@ "author": { "type": "string", "nullable": true, - "description": "The channel specific identifier of the message's author. Defaults to `system`." + "description": "The channel specific identifier of the message's author. Defaults to `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "body": { "type": "string", "nullable": true, - "description": "The content of the message, can be up to 1,600 characters long." + "description": "The content of the message, can be up to 1,600 characters long.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "media": { "type": "array", "items": {}, "nullable": true, - "description": "An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`." + "description": "An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "participant_sid": { "type": "string", @@ -401,7 +456,7 @@ "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template." } } }, @@ -541,16 +596,34 @@ "identity": { "type": "string", "nullable": true, - "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." + "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.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "role_sid": { "type": "string", @@ -668,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": { @@ -690,7 +777,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this credential, limited to 64 characters. Optional." + "description": "The human-readable name of this credential, limited to 64 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -769,11 +862,23 @@ "participant_identity": { "type": "string", "nullable": true, - "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." + "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.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "participant_messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_sid": { "type": "string", @@ -786,17 +891,35 @@ "conversation_unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource." + "description": "An application-defined string that uniquely identifies the Conversation resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "conversation_date_created": { "type": "string", @@ -871,7 +994,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -936,7 +1065,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this service, limited to 256 characters. Optional." + "description": "The human-readable name of this service, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -1014,12 +1149,24 @@ "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`." + "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource) within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource) within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "binding_type": { "type": "string", @@ -1068,7 +1215,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The conversation-level role assigned to a conversation creator user when they join a new conversation. See the [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." + "description": "The conversation-level role assigned to a conversation creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." }, "default_conversation_role_sid": { "type": "string", @@ -1076,7 +1223,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The conversation-level role assigned to users when they are added to a conversation. See the [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." + "description": "The conversation-level role assigned to users when they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." }, "default_chat_service_role_sid": { "type": "string", @@ -1084,7 +1231,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The service-level role assigned to users when they are added to the service. See the [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." + "description": "The service-level role assigned to users when they are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." }, "url": { "type": "string", @@ -1101,7 +1248,7 @@ "reachability_enabled": { "type": "boolean", "nullable": true, - "description": "Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) is enabled for this Conversations Service. The default is `false`." + "description": "Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`." } } }, @@ -1130,7 +1277,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to." + "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to." }, "sid": { "type": "string", @@ -1143,17 +1290,35 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "state": { "type": "string", @@ -1252,23 +1417,47 @@ "author": { "type": "string", "nullable": true, - "description": "The channel specific identifier of the message's author. Defaults to `system`." + "description": "The channel specific identifier of the message's author. Defaults to `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "body": { "type": "string", "nullable": true, - "description": "The content of the message, can be up to 1,600 characters long." + "description": "The content of the message, can be up to 1,600 characters long.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "media": { "type": "array", "items": {}, "nullable": true, - "description": "An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`." + "description": "An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "participant_sid": { "type": "string", @@ -1312,7 +1501,7 @@ "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template." } } }, @@ -1468,16 +1657,34 @@ "identity": { "type": "string", "nullable": true, - "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 Conversation SDK to communicate. Limited to 256 characters." + "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 [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "role_sid": { "type": "string", @@ -1491,13 +1698,13 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this resource was created." + "description": "The date on which this resource was created." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this resource was last updated." + "description": "The date on which this resource was last updated." }, "url": { "type": "string", @@ -1685,11 +1892,23 @@ "participant_identity": { "type": "string", "nullable": true, - "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." + "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.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "participant_messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_sid": { "type": "string", @@ -1702,17 +1921,35 @@ "conversation_unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource." + "description": "An application-defined string that uniquely identifies the Conversation resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "conversation_date_created": { "type": "string", @@ -1787,7 +2024,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -1868,17 +2111,35 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive." + "description": "The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "is_online": { "type": "boolean", @@ -1978,7 +2239,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_state": { "type": "string", @@ -1993,7 +2260,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -2021,7 +2294,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL." + "description": "An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -2149,17 +2428,35 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive." + "description": "The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "is_online": { "type": "boolean", @@ -2259,7 +2556,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_state": { "type": "string", @@ -2274,7 +2577,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -2302,7 +2611,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL." + "description": "An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -2332,12 +2647,6 @@ "closed" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -2353,7 +2662,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -2374,12 +2683,31 @@ }, "get": { "description": "Fetch the global configuration of conversations on your account", + "tags": [ + "ConversationsV1Configuration" + ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_inactive_timer": "PT1M", + "default_closed_timer": "PT10M", + "url": "https://conversations.twilio.com/v1/Configuration", + "links": { + "service": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "webhooks": "https://conversations.twilio.com/v1/Configuration/Webhooks" + } + } + } } } }, @@ -2391,19 +2719,35 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConfiguration" }, "post": { "description": "Update the global configuration of conversations on your account", + "tags": [ + "ConversationsV1Configuration" + ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_inactive_timer": "PT1M", + "default_closed_timer": "PT10M", + "url": "https://conversations.twilio.com/v1/Configuration", + "links": { + "service": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "webhooks": "https://conversations.twilio.com/v1/Configuration/Webhooks" + } + } + } } } }, @@ -2416,9 +2760,6 @@ } ], "operationId": "UpdateConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2438,7 +2779,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The SID of the default [Messaging Service](https://www.twilio.com/docs/sms/services/api) to use when creating a conversation." + "description": "The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation." }, "DefaultInactiveTimer": { "type": "string", @@ -2449,6 +2790,16 @@ "description": "Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes." } } + }, + "examples": { + "update": { + "value": { + "DefaultChatServiceSid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultMessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultInactiveTimer": "PT1M", + "DefaultClosedTimer": "PT10M" + } + } } } } @@ -2469,11 +2820,14 @@ "address", "friendly_name" ], - "pathType": "list", - "mountName": "address_configurations" + "mountName": "address_configurations", + "pathType": "list" }, "get": { "description": "Retrieve a list of address configurations for an account", + "tags": [ + "ConversationsV1AddressConfiguration" + ], "parameters": [ { "name": "Type", @@ -2481,6 +2835,11 @@ "description": "Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.", "schema": { "type": "string" + }, + "examples": { + "readByAddressType": { + "value": "sms" + } } }, { @@ -2526,16 +2885,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2544,18 +2905,172 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readAll": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0", + "next_page_url": null, + "key": "address_configurations" + }, + "address_configurations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "+37256123457", + "type": "sms", + "friendly_name": "My Test Configuration", + "address_country": "CA", + "auto_creation": { + "enabled": true, + "type": "webhook", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "https://example.com", + "webhook_method": "POST", + "webhook_filters": [ + "onParticipantAdded", + "onMessageAdded" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "address": "+37256123458", + "type": "sms", + "friendly_name": "Studio Test Configuration", + "address_country": "US", + "auto_creation": { + "enabled": false, + "type": "studio", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "address": "+37256123459", + "type": "sms", + "friendly_name": "Default Test Configuration", + "address_country": "NG", + "auto_creation": { + "enabled": true, + "type": "default" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac" + } + ] + } + }, + "readBlank": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "address_configurations" + }, + "address_configurations": [] + } + }, + "readByAddressType": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0", + "next_page_url": null, + "key": "address_configurations" + }, + "address_configurations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "+37256123457", + "type": "sms", + "friendly_name": "My Test Configuration", + "address_country": "CA", + "auto_creation": { + "enabled": true, + "type": "webhook", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "https://example.com", + "webhook_method": "POST", + "webhook_filters": [ + "onParticipantAdded", + "onMessageAdded" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "address": "+37256123458", + "type": "sms", + "friendly_name": "Studio Test Configuration", + "address_country": "US", + "auto_creation": { + "enabled": false, + "type": "studio", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "address": "+37256123459", + "type": "sms", + "friendly_name": "Default Test Configuration", + "address_country": "NG", + "auto_creation": { + "enabled": true, + "type": "default" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac" + } + ] } } } @@ -2569,19 +3084,62 @@ "accountSid_authToken": [] } ], - "operationId": "ListConfigurationAddress", - "x-maturity": [ - "GA" - ] + "operationId": "ListConfigurationAddress" }, "post": { "description": "Create a new address configuration", + "tags": [ + "ConversationsV1AddressConfiguration" + ], "responses": { "201": { "content": { "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" + } + } } } }, @@ -2594,9 +3152,6 @@ } ], "operationId": "CreateConfigurationAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2624,7 +3179,7 @@ "AutoCreation.Type": { "type": "string", "$ref": "#/components/schemas/configuration_address_enum_auto_creation_type", - "description": "Type of Auto Creation. Value can be one of `webhook`, `studio` or `default`." + "description": "Type of Auto Creation. Value can be one of `webhook`, `studio` or `default`. `default` creates a new Conversation under the default Conversation service, without a webhook or Studio integration." }, "AutoCreation.ConversationServiceSid": { "type": "string", @@ -2669,6 +3224,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" + } + } } } } @@ -2689,11 +3272,14 @@ "address", "friendly_name" ], - "pathType": "instance", - "mountName": "address_configurations" + "mountName": "address_configurations", + "pathType": "instance" }, "get": { "description": "Fetch an address configuration ", + "tags": [ + "ConversationsV1AddressConfiguration" + ], "parameters": [ { "name": "Sid", @@ -2711,6 +3297,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration_address" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "+37256123457", + "type": "sms", + "friendly_name": "My Test Configuration", + "address_country": "CA", + "auto_creation": { + "enabled": true, + "type": "webhook", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "https://example.com", + "webhook_method": "POST", + "webhook_filters": [ + "onParticipantAdded", + "onMessageAdded" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2722,13 +3334,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfigurationAddress", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConfigurationAddress" }, "post": { "description": "Update an existing address configuration", + "tags": [ + "ConversationsV1AddressConfiguration" + ], "parameters": [ { "name": "Sid", @@ -2746,6 +3358,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration_address" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "+37256123457", + "type": "sms", + "friendly_name": "My Test Configuration Updated", + "address_country": "CA", + "auto_creation": { + "enabled": false, + "type": "studio", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2758,9 +3392,6 @@ } ], "operationId": "UpdateConfigurationAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2816,6 +3447,17 @@ "description": "For type `studio`, number of times to retry the webhook request" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "My Test Configuration Updated", + "AutoCreation.Enabled": false, + "AutoCreation.Type": "studio", + "AutoCreation.StudioFlowSid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AutoCreation.StudioRetryCount": 3 + } + } } } } @@ -2823,6 +3465,9 @@ }, "delete": { "description": "Remove an existing address configuration", + "tags": [ + "ConversationsV1AddressConfiguration" + ], "parameters": [ { "name": "Sid", @@ -2844,10 +3489,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConfigurationAddress", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConfigurationAddress" } }, "/v1/Configuration/Webhooks": { @@ -2864,17 +3506,36 @@ "pre_webhook_url", "post_webhook_url" ], - "pathType": "instance", - "parent": "/Configuration" + "parent": "/Configuration", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "ConversationsV1Webhook" + ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration.configuration_webhook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "pre_webhook_url": "https://example.com/pre", + "post_webhook_url": "https://example.com/post", + "method": "GET", + "filters": [ + "onMessageSend", + "onConversationUpdated" + ], + "target": "webhook", + "url": "https://conversations.twilio.com/v1/Configuration/Webhooks" + } + } } } }, @@ -2886,19 +3547,34 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfigurationWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConfigurationWebhook" }, "post": { "description": "", + "tags": [ + "ConversationsV1Webhook" + ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration.configuration_webhook" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "pre_webhook_url": "https://example.com/pre", + "post_webhook_url": "http://example.com/post", + "method": "GET", + "filters": [ + "onConversationUpdated" + ], + "target": "webhook", + "url": "https://conversations.twilio.com/v1/Configuration/Webhooks" + } + } } } }, @@ -2911,9 +3587,6 @@ } ], "operationId": "UpdateConfigurationWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2946,6 +3619,19 @@ "description": "The routing target of the webhook." } } + }, + "examples": { + "update": { + "value": { + "PreWebhookUrl": "https://example.com/pre", + "PostWebhookUrl": "https://example.com/post", + "Method": "GET", + "Filters": [ + "onConversationUpdated" + ], + "Target": "webhook" + } + } } } } @@ -2966,15 +3652,33 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "participant": "{conversation_sid: sid}", - "message": "{conversation_sid: sid}", - "webhook": "{conversation_sid: sid}" - } + "participants": { + "mapping": { + "conversation_sid": "sid" + }, + "resource_url": "/v1/Conversations/{conversation_sid}/Participants" + }, + "messages": { + "mapping": { + "conversation_sid": "sid" + }, + "resource_url": "/v1/Conversations/{conversation_sid}/Messages" + }, + "webhooks": { + "mapping": { + "conversation_sid": "sid" + }, + "resource_url": "/v1/Conversations/{conversation_sid}/Webhooks" + } + }, + "pathType": "list" }, "post": { "description": "Create a new conversation in your account's default service", + "tags": [ + "ConversationsV1Conversation" + ], "parameters": [ { "name": "X-Twilio-Webhook-Enabled", @@ -2992,6 +3696,82 @@ "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" + } + } + } } } }, @@ -3004,9 +3784,6 @@ } ], "operationId": "CreateConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3037,7 +3814,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to." + "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to." }, "Attributes": { "type": "string", @@ -3055,6 +3832,47 @@ "Timers.Closed": { "type": "string", "description": "ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes." + }, + "Bindings.Email.Address": { + "type": "string", + "description": "The default email address that will be used when sending outbound emails in this conversation." + }, + "Bindings.Email.Name": { + "type": "string", + "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" } } } @@ -3064,6 +3882,9 @@ }, "get": { "description": "Retrieve a list of conversations in your account's default service", + "tags": [ + "ConversationsV1Conversation" + ], "parameters": [ { "name": "StartDate", @@ -3133,16 +3954,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3151,17 +3974,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "conversations": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Home Repair Visit", + "unique_name": null, + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "active", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -3176,10 +4037,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversation" } }, "/v1/Conversations/{Sid}": { @@ -3196,17 +4054,35 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "participant": "{conversation_sid: sid}", - "message": "{conversation_sid: sid}", - "webhook": "{conversation_sid: sid}" - } - }, - "post": { - "description": "Update an existing conversation in your account's default service", - "parameters": [ - { + "participants": { + "mapping": { + "conversation_sid": "sid" + }, + "resource_url": "/v1/Conversations/{conversation_sid}/Participants" + }, + "messages": { + "mapping": { + "conversation_sid": "sid" + }, + "resource_url": "/v1/Conversations/{conversation_sid}/Messages" + }, + "webhooks": { + "mapping": { + "conversation_sid": "sid" + }, + "resource_url": "/v1/Conversations/{conversation_sid}/Webhooks" + } + }, + "pathType": "instance" + }, + "post": { + "description": "Update an existing conversation in your account's default service", + "tags": [ + "ConversationsV1Conversation" + ], + "parameters": [ + { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.", @@ -3231,6 +4107,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + } } } }, @@ -3243,9 +4146,6 @@ } ], "operationId": "UpdateConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3276,7 +4176,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to." + "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to." }, "State": { "type": "string", @@ -3294,6 +4194,29 @@ "UniqueName": { "type": "string", "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + }, + "Bindings.Email.Address": { + "type": "string", + "description": "The default email address that will be used when sending outbound emails in this conversation." + }, + "Bindings.Email.Name": { + "type": "string", + "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" } } } @@ -3303,6 +4226,9 @@ }, "delete": { "description": "Remove a conversation from your account's default service", + "tags": [ + "ConversationsV1Conversation" + ], "parameters": [ { "name": "Sid", @@ -3333,13 +4259,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversation" }, "get": { "description": "Fetch a conversation from your account's default service", + "tags": [ + "ConversationsV1Conversation" + ], "parameters": [ { "name": "Sid", @@ -3357,6 +4283,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My First Conversation", + "unique_name": "first_conversation", + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "active", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + } } } }, @@ -3368,10 +4321,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversation" } }, "/v1/Conversations/{ConversationSid}/Messages": { @@ -3388,14 +4338,30 @@ "author", "date_created" ], - "pathType": "list", "dependentProperties": { - "delivery_receipt": "{conversation_sid: conversation_sid, message_sid: sid}" + "delivery_receipts": { + "mapping": { + "conversation_sid": "conversation_sid", + "message_sid": "sid" + }, + "resource_url": "/v1/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts" + }, + "channel_metadata": { + "mapping": { + "conversation_sid": "conversation_sid", + "message_sid": "sid" + }, + "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", + "tags": [ + "ConversationsV1Message" + ], "parameters": [ { "name": "ConversationSid", @@ -3422,6 +4388,160 @@ "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" + } + } + } } } }, @@ -3434,9 +4554,6 @@ } ], "operationId": "CreateConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3478,11 +4595,61 @@ "minLength": 34, "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", - "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." }, "ContentVariables": { "type": "string", "description": "A structurally valid JSON string that contains values to resolve Rich Content template variables." + }, + "Subject": { + "type": "string", + "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" } } } @@ -3492,6 +4659,9 @@ }, "get": { "description": "Retrieve a list of all messages in the conversation", + "tags": [ + "ConversationsV1Message" + ], "parameters": [ { "name": "ConversationSid", @@ -3509,6 +4679,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/conversation_message_enum_order_type" + }, + "examples": { + "readLastMessage": { + "value": "desc" + } } }, { @@ -3554,16 +4729,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3572,18 +4749,170 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/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" + } + } + ] } } } @@ -3597,10 +4926,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationMessage" } }, "/v1/Conversations/{ConversationSid}/Messages/{Sid}": { @@ -3617,14 +4943,30 @@ "author", "date_created" ], - "pathType": "instance", "dependentProperties": { - "delivery_receipt": "{conversation_sid: conversation_sid, message_sid: sid}" + "delivery_receipts": { + "mapping": { + "conversation_sid": "conversation_sid", + "message_sid": "sid" + }, + "resource_url": "/v1/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts" + }, + "channel_metadata": { + "mapping": { + "conversation_sid": "conversation_sid", + "message_sid": "sid" + }, + "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", + "tags": [ + "ConversationsV1Message" + ], "parameters": [ { "name": "ConversationSid", @@ -3663,6 +5005,37 @@ "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" + } + } + } } } }, @@ -3675,9 +5048,6 @@ } ], "operationId": "UpdateConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3706,6 +5076,21 @@ "Attributes": { "type": "string", "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + }, + "Subject": { + "type": "string", + "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" } } } @@ -3715,6 +5100,9 @@ }, "delete": { "description": "Remove a message from the conversation", + "tags": [ + "ConversationsV1Message" + ], "parameters": [ { "name": "ConversationSid", @@ -3757,13 +5145,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversationMessage" }, "get": { "description": "Fetch a message from the conversation", + "tags": [ + "ConversationsV1Message" + ], "parameters": [ { "name": "ConversationSid", @@ -3793,6 +5181,37 @@ "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" + } + } + } } } }, @@ -3804,10 +5223,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationMessage" } }, "/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}": { @@ -3824,12 +5240,15 @@ "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", + "tags": [ + "ConversationsV1DeliveryReceipt" + ], "parameters": [ { "name": "ConversationSid", @@ -3871,6 +5290,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_message.conversation_message_receipt" + }, + "examples": { + "fetch": { + "value": { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3882,10 +5318,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationMessageReceipt" } }, "/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts": { @@ -3902,12 +5335,15 @@ "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", + "tags": [ + "ConversationsV1DeliveryReceipt" + ], "parameters": [ { "name": "ConversationSid", @@ -3973,16 +5409,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3991,18 +5429,72 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0", + "next_page_url": null, + "key": "delivery_receipts" + }, + "delivery_receipts": [ + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -4016,10 +5508,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationMessageReceipt" } }, "/v1/Conversations/{ConversationSid}/Participants": { @@ -4034,11 +5523,14 @@ "sid", "messaging_binding" ], - "pathType": "list", - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "list" }, "post": { "description": "Add a new participant to the conversation", + "tags": [ + "ConversationsV1Participant" + ], "parameters": [ { "name": "ConversationSid", @@ -4065,6 +5557,101 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_participant" + }, + "examples": { + "createSms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createChat": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": null, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "projected_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmmsChatNoAttributes": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{}", + "messaging_binding": { + "type": "sms", + "projected_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmmsSmsNoAttributes": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{}", + "messaging_binding": { + "type": "sms", + "address": "+15017122661" + }, + "role_sid": null, + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + } } } }, @@ -4077,9 +5664,6 @@ } ], "operationId": "CreateConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4125,6 +5709,53 @@ "description": "The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant." } } + }, + "examples": { + "createSms": { + "value": { + "Attributes": "{ \"role\": \"driver\" }", + "MessagingBinding.Address": "+15558675310", + "MessagingBinding.ProxyAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createChat": { + "value": { + "Identity": "IDENTITY", + "Attributes": "{ \"role\": \"driver\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createGmms": { + "value": { + "Identity": "IDENTITY", + "Attributes": "{ \"role\": \"driver\" }", + "MessagingBinding.ProjectedAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createGmmsChatNoAttributes": { + "value": { + "Identity": "IDENTITY", + "MessagingBinding.ProjectedAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z" + } + }, + "createGmmsSmsNoAttributes": { + "value": { + "MessagingBinding.Address": "+15017122661", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z" + } + } } } } @@ -4132,6 +5763,9 @@ }, "get": { "description": "Retrieve a list of all participants of the conversation", + "tags": [ + "ConversationsV1Participant" + ], "parameters": [ { "name": "ConversationSid", @@ -4185,16 +5819,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4203,18 +5839,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "next_page_url": null, + "key": "participants" + }, + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": null, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + ] } } } @@ -4228,10 +5911,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationParticipant" } }, "/v1/Conversations/{ConversationSid}/Participants/{Sid}": { @@ -4246,11 +5926,14 @@ "sid", "messaging_binding" ], - "pathType": "instance", - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing participant in the conversation", + "tags": [ + "ConversationsV1Participant" + ], "parameters": [ { "name": "ConversationSid", @@ -4286,6 +5969,47 @@ "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 + } + } } } }, @@ -4298,9 +6022,6 @@ } ], "operationId": "UpdateConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4351,6 +6072,21 @@ "description": "Timestamp of last \u201cread\u201d message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant." } } + }, + "examples": { + "update": { + "value": { + "Attributes": "{ \"role\": \"driver\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "updateGmms": { + "value": { + "MessagingBinding.ProjectedAddress": "+15017122661" + } + } } } } @@ -4358,6 +6094,9 @@ }, "delete": { "description": "Remove a participant from the conversation", + "tags": [ + "ConversationsV1Participant" + ], "parameters": [ { "name": "ConversationSid", @@ -4397,13 +6136,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversationParticipant" }, "get": { "description": "Fetch a participant of the conversation", + "tags": [ + "ConversationsV1Participant" + ], "parameters": [ { "name": "ConversationSid", @@ -4417,7 +6156,7 @@ { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's `identity` rather than the SID.", "schema": { "type": "string" }, @@ -4430,6 +6169,48 @@ "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 + } + } } } }, @@ -4441,10 +6222,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationParticipant" } }, "/v1/Conversations/{ConversationSid}/Webhooks": { @@ -4459,11 +6237,14 @@ "sid", "target" ], - "pathType": "list", - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all webhooks scoped to the conversation", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ConversationSid", @@ -4517,16 +6298,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4535,18 +6318,93 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "webhook", + "configuration": { + "url": "https://example.com", + "method": "get", + "filters": [ + "onMessageSent", + "onConversationDestroyed" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "trigger", + "configuration": { + "url": "https://example.com", + "method": "post", + "filters": [ + "keyword1", + "keyword2" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [] } } } @@ -4560,13 +6418,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationScopedWebhook" }, "post": { "description": "Create a new webhook scoped to the conversation", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ConversationSid", @@ -4584,6 +6442,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "webhook", + "configuration": { + "url": "https://example.com", + "method": "get", + "filters": [ + "onMessageSent", + "onConversationDestroyed" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4596,9 +6475,6 @@ } ], "operationId": "CreateConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4649,6 +6525,20 @@ "required": [ "Target" ] + }, + "examples": { + "create": { + "value": { + "Target": "webhook", + "Configuration.Url": "https://example.com", + "Configuration.Method": "get", + "Configuration.Filters": [ + "onMessageSent", + "onConversationDestroyed" + ], + "Configuration.ReplayAfter": 7 + } + } } } } @@ -4667,11 +6557,14 @@ "sid", "target" ], - "pathType": "instance", - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch the configuration of a conversation-scoped webhook", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ConversationSid", @@ -4701,6 +6594,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4712,13 +6621,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationScopedWebhook" }, "post": { "description": "Update an existing conversation-scoped webhook", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ConversationSid", @@ -4748,6 +6657,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "trigger", + "configuration": { + "url": "https://example.com", + "method": "post", + "filters": [ + "keyword1", + "keyword2" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4760,9 +6690,6 @@ } ], "operationId": "UpdateConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4801,6 +6728,18 @@ "description": "The studio flow SID, where the webhook should be sent to." } } + }, + "examples": { + "update": { + "value": { + "Configuration.Url": "https://example.com", + "Configuration.Method": "post", + "Configuration.Triggers": [ + "keyword1", + "keyword2" + ] + } + } } } } @@ -4808,6 +6747,9 @@ }, "delete": { "description": "Remove an existing webhook scoped to the conversation", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ConversationSid", @@ -4841,10 +6783,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversationScopedWebhook" } }, "/v1/Credentials": { @@ -4864,12 +6803,29 @@ }, "post": { "description": "Add a new push notification credential to your account", + "tags": [ + "ConversationsV1Credential" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4882,9 +6838,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4925,6 +6878,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -4932,6 +6892,9 @@ }, "get": { "description": "Retrieve a list of all push notification credentials on your account", + "tags": [ + "ConversationsV1Credential" + ], "parameters": [ { "name": "PageSize", @@ -4976,16 +6939,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4994,17 +6959,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -5019,10 +7023,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" } }, "/v1/Credentials/{Sid}": { @@ -5042,6 +7043,9 @@ }, "post": { "description": "Update an existing push notification credential on your account", + "tags": [ + "ConversationsV1Credential" + ], "parameters": [ { "name": "Sid", @@ -5062,6 +7066,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5074,9 +7092,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5114,6 +7129,13 @@ "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -5121,6 +7143,9 @@ }, "delete": { "description": "Remove a push notification credential from your account", + "tags": [ + "ConversationsV1Credential" + ], "parameters": [ { "name": "Sid", @@ -5145,13 +7170,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" }, "get": { "description": "Fetch a push notification credential from your account", + "tags": [ + "ConversationsV1Credential" + ], "parameters": [ { "name": "Sid", @@ -5172,6 +7197,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5183,10 +7222,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" } }, "/v1/ParticipantConversations": { @@ -5206,6 +7242,9 @@ }, "get": { "description": "Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.", + "tags": [ + "ConversationsV1ParticipantConversation" + ], "parameters": [ { "name": "Identity", @@ -5213,6 +7252,14 @@ "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "identity" + }, + "readFullByIdentity": { + "value": "identity" + } } }, { @@ -5221,6 +7268,11 @@ "description": "A unique string identifier for the conversation participant who's not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded.", "schema": { "type": "string" + }, + "examples": { + "readFullByAddress": { + "value": "+375255555555" + } } }, { @@ -5266,16 +7318,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5284,17 +7338,116 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "conversations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFullByIdentity": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_friendly_name": "friendly_name", + "conversation_state": "inactive", + "conversation_timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "conversation_attributes": "{}", + "conversation_date_created": "2015-07-30T20:00:00Z", + "conversation_date_updated": "2015-07-30T20:00:00Z", + "conversation_created_by": "created_by", + "conversation_unique_name": "unique_name", + "participant_user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_identity": "identity", + "participant_messaging_binding": null, + "links": { + "participant": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFullByAddress": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_friendly_name": "friendly_name", + "conversation_state": "inactive", + "conversation_timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "conversation_attributes": "{}", + "conversation_date_created": "2015-07-30T20:00:00Z", + "conversation_date_updated": "2015-07-30T20:00:00Z", + "conversation_created_by": "created_by", + "conversation_unique_name": "unique_name", + "participant_user_sid": null, + "participant_identity": null, + "participant_messaging_binding": { + "address": "+375255555555", + "proxy_address": "+12345678910", + "type": "sms", + "level": null, + "name": null, + "projected_address": null + }, + "links": { + "participant": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -5309,10 +7462,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListParticipantConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListParticipantConversation" } }, "/v1/Roles": { @@ -5332,12 +7482,35 @@ }, "post": { "description": "Create a new user role in your account's default service", + "tags": [ + "ConversationsV1Role" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5350,9 +7523,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5382,6 +7552,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Conversation Role", + "Type": "conversation", + "Permission": "sendMessage" + } + } } } } @@ -5389,6 +7568,9 @@ }, "get": { "description": "Retrieve a list of all user roles in your account's default service", + "tags": [ + "ConversationsV1Role" + ], "parameters": [ { "name": "PageSize", @@ -5433,16 +7615,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5451,18 +7635,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -5476,10 +7705,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v1/Roles/{Sid}": { @@ -5499,6 +7725,9 @@ }, "post": { "description": "Update an existing user role in your account's default service", + "tags": [ + "ConversationsV1Role" + ], "parameters": [ { "name": "Sid", @@ -5519,6 +7748,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5531,9 +7780,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5552,6 +7798,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -5559,6 +7812,9 @@ }, "delete": { "description": "Remove a user role from your account's default service", + "tags": [ + "ConversationsV1Role" + ], "parameters": [ { "name": "Sid", @@ -5583,13 +7839,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "get": { "description": "Fetch a user role from your account's default service", + "tags": [ + "ConversationsV1Role" + ], "parameters": [ { "name": "Sid", @@ -5610,6 +7866,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5621,10 +7897,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" } }, "/v1/Services": { @@ -5639,24 +7912,77 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "conversation": "{chat_service_sid: sid}", - "binding": "{chat_service_sid: sid}", - "user": "{chat_service_sid: sid}", - "role": "{chat_service_sid: sid}", - "configuration": "{chat_service_sid: sid}", - "participant_conversation": "{chat_service_sid: sid}" - } + "conversations": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Conversations" + }, + "bindings": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Bindings" + }, + "users": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Users" + }, + "roles": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Roles" + }, + "configuration": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Configuration" + }, + "participant_conversations": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/ParticipantConversations" + } + }, + "pathType": "list" }, "post": { "description": "Create a new conversation service on your account", + "tags": [ + "ConversationsV1Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service" + }, + "examples": { + "create": { + "value": { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations", + "users": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "configuration": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "participant_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations" + } + } + } } } }, @@ -5669,9 +7995,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5687,6 +8010,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -5694,6 +8024,9 @@ }, "get": { "description": "Retrieve a list of all conversation services on your account", + "tags": [ + "ConversationsV1Service" + ], "parameters": [ { "name": "PageSize", @@ -5738,16 +8071,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5756,17 +8091,48 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "services": [ + { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Home Service", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations", + "users": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "configuration": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "participant_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services?PageSize=50&Page=0", + "next_page_url": null, + "key": "services" } } } @@ -5781,10 +8147,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{Sid}": { @@ -5799,18 +8162,51 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "conversation": "{chat_service_sid: sid}", - "binding": "{chat_service_sid: sid}", - "user": "{chat_service_sid: sid}", - "role": "{chat_service_sid: sid}", - "configuration": "{chat_service_sid: sid}", - "participant_conversation": "{chat_service_sid: sid}" - } + "conversations": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Conversations" + }, + "bindings": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Bindings" + }, + "users": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Users" + }, + "roles": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Roles" + }, + "configuration": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Configuration" + }, + "participant_conversations": { + "mapping": { + "chat_service_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/ParticipantConversations" + } + }, + "pathType": "instance" }, "delete": { "description": "Remove a conversation service with all its nested resources from your account", + "tags": [ + "ConversationsV1Service" + ], "parameters": [ { "name": "Sid", @@ -5835,13 +8231,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "get": { "description": "Fetch a conversation service from your account", + "tags": [ + "ConversationsV1Service" + ], "parameters": [ { "name": "Sid", @@ -5862,6 +8258,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service" + }, + "examples": { + "fetch": { + "value": { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My First Service", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations", + "users": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "configuration": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "participant_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations" + } + } + } } } }, @@ -5873,10 +8289,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" } }, "/v1/Services/{ChatServiceSid}/Bindings/{Sid}": { @@ -5892,11 +8305,14 @@ "endpoint", "identity" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "Remove a push notification binding from the conversation service", + "tags": [ + "ConversationsV1Binding" + ], "parameters": [ { "name": "ChatServiceSid", @@ -5933,13 +8349,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceBinding" }, "get": { "description": "Fetch a push notification binding from the conversation service", + "tags": [ + "ConversationsV1Binding" + ], "parameters": [ { "name": "ChatServiceSid", @@ -5972,6 +8388,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_binding" + }, + "examples": { + "fetch": { + "value": { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_conversation", + "new_message", + "added_to_conversation" + ], + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5983,10 +8420,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceBinding" } }, "/v1/Services/{ChatServiceSid}/Bindings": { @@ -6002,11 +8436,14 @@ "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", + "tags": [ + "ConversationsV1Binding" + ], "parameters": [ { "name": "ChatServiceSid", @@ -6041,6 +8478,12 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -6086,16 +8529,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6104,18 +8549,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [ + { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_conversation", + "new_message", + "added_to_conversation" + ], + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [] } } } @@ -6129,10 +8620,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceBinding" } }, "/v1/Services/{ChatServiceSid}/Configuration": { @@ -6146,11 +8634,14 @@ "defaultOutputProperties": [ "chat_service_sid" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch the configuration of a conversation service", + "tags": [ + "ConversationsV1Configuration" + ], "parameters": [ { "name": "ChatServiceSid", @@ -6171,6 +8662,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration" + }, + "examples": { + "fetch": { + "value": { + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_conversation_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_conversation_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_chat_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reachability_enabled": false, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "links": { + "notifications": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks" + } + } + } } } }, @@ -6182,13 +8689,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConfiguration" }, "post": { "description": "Update configuration settings of a conversation service", + "tags": [ + "ConversationsV1Configuration" + ], "parameters": [ { "name": "ChatServiceSid", @@ -6209,6 +8716,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration" + }, + "examples": { + "update": { + "value": { + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_conversation_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_conversation_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_chat_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reachability_enabled": false, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "links": { + "notifications": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks" + } + } + } } } }, @@ -6221,9 +8744,6 @@ } ], "operationId": "UpdateServiceConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6236,25 +8756,35 @@ "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", - "description": "The conversation-level role assigned to a conversation creator when they join a new conversation. See the [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." + "description": "The conversation-level role assigned to a conversation creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." }, "DefaultConversationRoleSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", - "description": "The conversation-level role assigned to users when they are added to a conversation. See the [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." + "description": "The conversation-level role assigned to users when they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." }, "DefaultChatServiceRoleSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", - "description": "The service-level role assigned to users when they are added to the service. See the [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." + "description": "The service-level role assigned to users when they are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles." }, "ReachabilityEnabled": { "type": "boolean", - "description": "Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) is enabled for this Conversations Service. The default is `false`." + "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 } } } @@ -6277,16 +8807,37 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "participant": "{chat_service_sid: chat_service_sid, conversation_sid: sid}", - "message": "{chat_service_sid: chat_service_sid, conversation_sid: sid}", - "webhook": "{chat_service_sid: chat_service_sid, conversation_sid: sid}" + "participants": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "conversation_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Participants" + }, + "messages": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "conversation_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages" + }, + "webhooks": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "conversation_sid": "sid" + }, + "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", + "tags": [ + "ConversationsV1Conversation" + ], "parameters": [ { "name": "ChatServiceSid", @@ -6316,6 +8867,55 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation" + }, + "examples": { + "create": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + }, + "createNoTimersNoAttributes": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": null, + "attributes": "{}", + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "state": "active", + "timers": {}, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + } } } }, @@ -6328,9 +8928,6 @@ } ], "operationId": "CreateServiceConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6355,7 +8952,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to." + "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to." }, "DateCreated": { "type": "string", @@ -6379,6 +8976,38 @@ "Timers.Closed": { "type": "string", "description": "ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes." + }, + "Bindings.Email.Address": { + "type": "string", + "description": "The default email address that will be used when sending outbound emails in this conversation." + }, + "Bindings.Email.Name": { + "type": "string", + "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" } } } @@ -6388,6 +9017,9 @@ }, "get": { "description": "Retrieve a list of conversations in your service", + "tags": [ + "ConversationsV1Conversation" + ], "parameters": [ { "name": "ChatServiceSid", @@ -6469,16 +9101,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6487,17 +9121,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "conversations": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Home Repair Visit", + "unique_name": null, + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "active", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -6512,10 +9184,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversation" } }, "/v1/Services/{ChatServiceSid}/Conversations/{Sid}": { @@ -6532,16 +9201,37 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "participant": "{chat_service_sid: chat_service_sid, conversation_sid: sid}", - "message": "{chat_service_sid: chat_service_sid, conversation_sid: sid}", - "webhook": "{chat_service_sid: chat_service_sid, conversation_sid: sid}" + "participants": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "conversation_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Participants" + }, + "messages": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "conversation_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages" + }, + "webhooks": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "conversation_sid": "sid" + }, + "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", + "tags": [ + "ConversationsV1Conversation" + ], "parameters": [ { "name": "ChatServiceSid", @@ -6580,6 +9270,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + } } } }, @@ -6592,9 +9309,6 @@ } ], "operationId": "UpdateServiceConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6625,7 +9339,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to." + "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to." }, "State": { "type": "string", @@ -6643,6 +9357,29 @@ "UniqueName": { "type": "string", "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + }, + "Bindings.Email.Address": { + "type": "string", + "description": "The default email address that will be used when sending outbound emails in this conversation." + }, + "Bindings.Email.Name": { + "type": "string", + "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" } } } @@ -6652,6 +9389,9 @@ }, "delete": { "description": "Remove a conversation from your service", + "tags": [ + "ConversationsV1Conversation" + ], "parameters": [ { "name": "ChatServiceSid", @@ -6694,13 +9434,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversation" }, "get": { "description": "Fetch a conversation from your service", + "tags": [ + "ConversationsV1Conversation" + ], "parameters": [ { "name": "ChatServiceSid", @@ -6730,6 +9470,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My First Conversation", + "unique_name": "first_conversation", + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "active", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + } } } }, @@ -6741,10 +9508,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversation" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages": { @@ -6761,14 +9525,32 @@ "author", "date_created" ], - "pathType": "list", "dependentProperties": { - "delivery_receipt": "{chat_service_sid: chat_service_sid, conversation_sid: conversation_sid, message_sid: sid}" + "delivery_receipts": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "conversation_sid": "conversation_sid", + "message_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts" + }, + "channel_metadata": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "conversation_sid": "conversation_sid", + "message_sid": "sid" + }, + "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", + "tags": [ + "ConversationsV1Message" + ], "parameters": [ { "name": "ChatServiceSid", @@ -6807,6 +9589,165 @@ "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" + } + } + } } } }, @@ -6819,9 +9760,6 @@ } ], "operationId": "CreateServiceConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6863,11 +9801,61 @@ "minLength": 34, "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", - "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." }, "ContentVariables": { "type": "string", "description": "A structurally valid JSON string that contains values to resolve Rich Content template variables." + }, + "Subject": { + "type": "string", + "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" } } } @@ -6877,6 +9865,9 @@ }, "get": { "description": "Retrieve a list of all messages in the conversation", + "tags": [ + "ConversationsV1Message" + ], "parameters": [ { "name": "ChatServiceSid", @@ -6906,6 +9897,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/service_conversation_message_enum_order_type" + }, + "examples": { + "readLastMessage": { + "value": "desc" + } } }, { @@ -6951,16 +9947,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6969,18 +9967,174 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "I like pie.", + "media": null, + "author": "pie_preferrer", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts", + "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" + } + } + ] } } } @@ -6994,10 +10148,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationMessage" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}": { @@ -7014,14 +10165,32 @@ "author", "date_created" ], - "pathType": "instance", "dependentProperties": { - "delivery_receipt": "{chat_service_sid: chat_service_sid, conversation_sid: conversation_sid, message_sid: sid}" + "delivery_receipts": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "conversation_sid": "conversation_sid", + "message_sid": "sid" + }, + "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts" + }, + "channel_metadata": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "conversation_sid": "conversation_sid", + "message_sid": "sid" + }, + "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", + "tags": [ + "ConversationsV1Message" + ], "parameters": [ { "name": "ChatServiceSid", @@ -7072,6 +10241,38 @@ "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" + } + } + } } } }, @@ -7084,9 +10285,6 @@ } ], "operationId": "UpdateServiceConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7115,6 +10313,21 @@ "Attributes": { "type": "string", "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + }, + "Subject": { + "type": "string", + "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" } } } @@ -7124,6 +10337,9 @@ }, "delete": { "description": "Remove a message from the conversation", + "tags": [ + "ConversationsV1Message" + ], "parameters": [ { "name": "ChatServiceSid", @@ -7178,13 +10394,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversationMessage" }, "get": { "description": "Fetch a message from the conversation", + "tags": [ + "ConversationsV1Message" + ], "parameters": [ { "name": "ChatServiceSid", @@ -7226,6 +10442,38 @@ "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" + } + } + } } } }, @@ -7237,10 +10485,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversationMessage" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}": { @@ -7257,12 +10502,15 @@ "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", + "tags": [ + "ConversationsV1DeliveryReceipt" + ], "parameters": [ { "name": "ChatServiceSid", @@ -7316,6 +10564,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt" + }, + "examples": { + "fetch": { + "value": { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7327,10 +10593,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversationMessageReceipt" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts": { @@ -7347,12 +10610,15 @@ "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", + "tags": [ + "ConversationsV1DeliveryReceipt" + ], "parameters": [ { "name": "ChatServiceSid", @@ -7430,16 +10696,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7448,18 +10716,75 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0", + "next_page_url": null, + "key": "delivery_receipts" + }, + "delivery_receipts": [ + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -7473,10 +10798,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationMessageReceipt" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants": { @@ -7491,11 +10813,14 @@ "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", + "tags": [ + "ConversationsV1Participant" + ], "parameters": [ { "name": "ChatServiceSid", @@ -7534,6 +10859,106 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant" + }, + "examples": { + "createSms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "null", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createChat": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": null, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "projected_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmmsChatNoAttributes": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{}", + "messaging_binding": { + "type": "sms", + "projected_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmmsSmsNoAttributes": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{}", + "messaging_binding": { + "type": "sms", + "address": "+15017122661" + }, + "role_sid": null, + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + } } } }, @@ -7546,9 +10971,6 @@ } ], "operationId": "CreateServiceConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7558,33 +10980,33 @@ "properties": { "Identity": { "type": "string", - "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 Conversation SDK to communicate. Limited to 256 characters." + "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 [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters." }, "MessagingBinding.Address": { "type": "string", - "description": "The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from an SDK endpoint (see the 'identity' field)." + "description": "The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with `proxy_address`) is only null when the participant is interacting from an SDK endpoint (see the `identity` field)." }, "MessagingBinding.ProxyAddress": { "type": "string", - "description": "The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the 'identity' field)." + "description": "The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the `identity` field)." }, "DateCreated": { "type": "string", "format": "date-time", - "description": "The date that this resource was created." + "description": "The date on which this resource was created." }, "DateUpdated": { "type": "string", "format": "date-time", - "description": "The date that this resource was last updated." + "description": "The date on which this resource was last updated." }, "Attributes": { "type": "string", - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned." }, "MessagingBinding.ProjectedAddress": { "type": "string", - "description": "The address of the Twilio phone number that is used in Group MMS. Communication mask for the Conversation participant with Identity." + "description": "The address of the Twilio phone number that is used in Group MMS." }, "RoleSid": { "type": "string", @@ -7594,6 +11016,53 @@ "description": "The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant." } } + }, + "examples": { + "createSms": { + "value": { + "Attributes": "{ \"role\": \"driver\" }", + "MessagingBinding.Address": "+15558675310", + "MessagingBinding.ProxyAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createChat": { + "value": { + "Identity": "IDENTITY", + "Attributes": "{ \"role\": \"driver\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createGmms": { + "value": { + "Identity": "IDENTITY", + "Attributes": "{ \"role\": \"driver\" }", + "MessagingBinding.ProjectedAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createGmmsChatNoAttributes": { + "value": { + "Identity": "IDENTITY", + "MessagingBinding.ProjectedAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z" + } + }, + "createGmmsSmsNoAttributes": { + "value": { + "MessagingBinding.Address": "+15017122661", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z" + } + } } } } @@ -7601,6 +11070,9 @@ }, "get": { "description": "Retrieve a list of all participants of the conversation", + "tags": [ + "ConversationsV1Participant" + ], "parameters": [ { "name": "ChatServiceSid", @@ -7666,16 +11138,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7684,18 +11158,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "next_page_url": null, + "key": "participants" + }, + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": null, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + ] } } } @@ -7709,10 +11232,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationParticipant" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}": { @@ -7727,11 +11247,14 @@ "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", + "tags": [ + "ConversationsV1Participant" + ], "parameters": [ { "name": "ChatServiceSid", @@ -7779,6 +11302,49 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "updateGmms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "id", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "projected_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + } } } }, @@ -7791,9 +11357,6 @@ } ], "operationId": "UpdateServiceConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7804,20 +11367,20 @@ "DateCreated": { "type": "string", "format": "date-time", - "description": "The date that this resource was created." + "description": "The date on which this resource was created." }, "DateUpdated": { "type": "string", "format": "date-time", - "description": "The date that this resource was last updated." + "description": "The date on which this resource was last updated." }, "Identity": { "type": "string", - "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 Conversation SDK to communicate. Limited to 256 characters." + "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 [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters." }, "Attributes": { "type": "string", - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned." }, "RoleSid": { "type": "string", @@ -7844,6 +11407,21 @@ "description": "Timestamp of last \u201cread\u201d message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant." } } + }, + "examples": { + "update": { + "value": { + "Attributes": "{ \"role\": \"driver\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "updateGmms": { + "value": { + "MessagingBinding.ProjectedAddress": "+15017122661" + } + } } } } @@ -7851,6 +11429,9 @@ }, "delete": { "description": "Remove a participant from the conversation", + "tags": [ + "ConversationsV1Participant" + ], "parameters": [ { "name": "ChatServiceSid", @@ -7902,13 +11483,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversationParticipant" }, "get": { "description": "Fetch a participant of the conversation", + "tags": [ + "ConversationsV1Participant" + ], "parameters": [ { "name": "ChatServiceSid", @@ -7934,7 +11515,7 @@ { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's `identity` rather than the SID.", "schema": { "type": "string" }, @@ -7947,6 +11528,50 @@ "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 + } + } } } }, @@ -7958,10 +11583,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversationParticipant" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks": { @@ -7976,11 +11598,14 @@ "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", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ChatServiceSid", @@ -8010,6 +11635,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "webhook", + "configuration": { + "url": "https://example.com", + "method": "get", + "filters": [ + "onMessageSent", + "onConversationDestroyed" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8022,9 +11669,6 @@ } ], "operationId": "CreateServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8075,6 +11719,20 @@ "required": [ "Target" ] + }, + "examples": { + "create": { + "value": { + "Target": "webhook", + "Configuration.Url": "https://example.com", + "Configuration.Method": "get", + "Configuration.Filters": [ + "onMessageSent", + "onConversationDestroyed" + ], + "Configuration.ReplayAfter": 7 + } + } } } } @@ -8082,6 +11740,9 @@ }, "get": { "description": "Retrieve a list of all webhooks scoped to the conversation", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ChatServiceSid", @@ -8147,16 +11808,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8165,18 +11828,96 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "webhook", + "configuration": { + "url": "https://example.com", + "method": "get", + "filters": [ + "onMessageSent", + "onConversationDestroyed" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "trigger", + "configuration": { + "url": "https://example.com", + "method": "post", + "filters": [ + "keyword1", + "keyword2" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [] } } } @@ -8190,10 +11931,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationScopedWebhook" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}": { @@ -8208,11 +11946,14 @@ "sid", "target" ], - "pathType": "instance", - "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}" + "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing conversation-scoped webhook", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ChatServiceSid", @@ -8254,6 +11995,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "trigger", + "configuration": { + "url": "https://example.com", + "method": "post", + "filters": [ + "keyword1", + "keyword2" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8266,9 +12029,6 @@ } ], "operationId": "UpdateServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8307,6 +12067,18 @@ "description": "The studio flow SID, where the webhook should be sent to." } } + }, + "examples": { + "update": { + "value": { + "Configuration.Url": "https://example.com", + "Configuration.Method": "post", + "Configuration.Triggers": [ + "keyword1", + "keyword2" + ] + } + } } } } @@ -8314,6 +12086,9 @@ }, "delete": { "description": "Remove an existing webhook scoped to the conversation", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ChatServiceSid", @@ -8359,13 +12134,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversationScopedWebhook" }, "get": { "description": "Fetch the configuration of a conversation-scoped webhook", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ChatServiceSid", @@ -8407,6 +12182,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8418,10 +12210,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversationScopedWebhook" } }, "/v1/Services/{ChatServiceSid}/Configuration/Notifications": { @@ -8435,11 +12224,14 @@ "defaultOutputProperties": [ "chat_service_sid" ], - "pathType": "instance", - "parent": "/Services/{ChatServiceSid}/Configuration" + "parent": "/Services/{ChatServiceSid}/Configuration", + "pathType": "instance" }, "post": { "description": "Update push notification service settings", + "tags": [ + "ConversationsV1Notification" + ], "parameters": [ { "name": "ChatServiceSid", @@ -8460,6 +12252,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration.service_notification" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "log_enabled": true, + "added_to_conversation": { + "enabled": false, + "template": "You have been added to a Conversation: ${CONVERSATION}", + "sound": "ring" + }, + "new_message": { + "enabled": false, + "template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}", + "badge_count_enabled": true, + "sound": "ring", + "with_media": { + "enabled": false, + "template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}" + } + }, + "removed_from_conversation": { + "enabled": false, + "template": "You have been removed from a Conversation: ${CONVERSATION}", + "sound": "ring" + }, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications" + } + } } } }, @@ -8472,9 +12294,6 @@ } ], "operationId": "UpdateServiceNotification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8535,6 +12354,25 @@ "description": "The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`." } } + }, + "examples": { + "update": { + "value": { + "NewMessage.Enabled": false, + "NewMessage.Template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}", + "NewMessage.Sound": "ring", + "NewMessage.BadgeCountEnabled": true, + "NewMessage.WithMedia.Enabled": false, + "NewMessage.WithMedia.Template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}", + "AddedToConversation.Enabled": false, + "AddedToConversation.Template": "You have been added to a Conversation: ${CONVERSATION}", + "AddedToConversation.Sound": "ring", + "RemovedFromConversation.Enabled": false, + "RemovedFromConversation.Template": "You have been removed from a Conversation: ${CONVERSATION}", + "RemovedFromConversation.Sound": "ring", + "LogEnabled": true + } + } } } } @@ -8542,6 +12380,9 @@ }, "get": { "description": "Fetch push notification service settings", + "tags": [ + "ConversationsV1Notification" + ], "parameters": [ { "name": "ChatServiceSid", @@ -8562,6 +12403,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration.service_notification" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "log_enabled": false, + "added_to_conversation": { + "enabled": true, + "template": "You have been added to a Conversation: ${CONVERSATION}", + "sound": "ring" + }, + "new_message": { + "enabled": true, + "template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}", + "badge_count_enabled": false, + "sound": "ring", + "with_media": { + "enabled": false, + "template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}" + } + }, + "removed_from_conversation": { + "enabled": true, + "template": "You have been removed from a Conversation: ${CONVERSATION}", + "sound": "ring" + }, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications" + } + } } } }, @@ -8573,10 +12444,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceNotification", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceNotification" } }, "/v1/Services/{ChatServiceSid}/ParticipantConversations": { @@ -8592,11 +12460,14 @@ "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.", + "tags": [ + "ConversationsV1ParticipantConversation" + ], "parameters": [ { "name": "ChatServiceSid", @@ -8616,6 +12487,14 @@ "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "identity" + }, + "readFullByIdentity": { + "value": "identity" + } } }, { @@ -8624,6 +12503,11 @@ "description": "A unique string identifier for the conversation participant who's not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded.", "schema": { "type": "string" + }, + "examples": { + "readFullByAddress": { + "value": "+375255555555" + } } }, { @@ -8669,16 +12553,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8687,17 +12573,116 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "conversations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFullByIdentity": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_friendly_name": "friendly_name", + "conversation_state": "inactive", + "conversation_timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "conversation_attributes": "{}", + "conversation_date_created": "2015-07-30T20:00:00Z", + "conversation_date_updated": "2015-07-30T20:00:00Z", + "conversation_created_by": "created_by", + "conversation_unique_name": "unique_name", + "participant_user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_identity": "identity", + "participant_messaging_binding": null, + "links": { + "participant": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFullByAddress": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_friendly_name": "friendly_name", + "conversation_state": "inactive", + "conversation_timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "conversation_attributes": "{}", + "conversation_date_created": "2015-07-30T20:00:00Z", + "conversation_date_updated": "2015-07-30T20:00:00Z", + "conversation_created_by": "created_by", + "conversation_unique_name": "unique_name", + "participant_user_sid": null, + "participant_identity": null, + "participant_messaging_binding": { + "address": "+375255555555", + "proxy_address": "+12345678910", + "type": "sms", + "level": null, + "name": null, + "projected_address": null + }, + "links": { + "participant": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -8712,10 +12697,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceParticipantConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceParticipantConversation" } }, "/v1/Services/{ChatServiceSid}/Roles": { @@ -8731,11 +12713,14 @@ "friendly_name", "type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new user role in your service", + "tags": [ + "ConversationsV1Role" + ], "parameters": [ { "name": "ChatServiceSid", @@ -8756,6 +12741,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8768,9 +12773,6 @@ } ], "operationId": "CreateServiceRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8800,6 +12802,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Conversation Role", + "Type": "conversation", + "Permission": "sendMessage" + } + } } } } @@ -8807,6 +12818,9 @@ }, "get": { "description": "Retrieve a list of all user roles in your service", + "tags": [ + "ConversationsV1Role" + ], "parameters": [ { "name": "ChatServiceSid", @@ -8863,16 +12877,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8881,18 +12897,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -8906,10 +12967,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceRole" } }, "/v1/Services/{ChatServiceSid}/Roles/{Sid}": { @@ -8925,11 +12983,14 @@ "friendly_name", "type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing user role in your service", + "tags": [ + "ConversationsV1Role" + ], "parameters": [ { "name": "ChatServiceSid", @@ -8962,6 +13023,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8974,9 +13055,6 @@ } ], "operationId": "UpdateServiceRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8995,6 +13073,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -9002,6 +13087,9 @@ }, "delete": { "description": "Remove a user role from your service", + "tags": [ + "ConversationsV1Role" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9038,13 +13126,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceRole" }, "get": { "description": "Fetch a user role from your service", + "tags": [ + "ConversationsV1Role" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9077,6 +13165,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -9088,10 +13196,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceRole" } }, "/v1/Services/{ChatServiceSid}/Users": { @@ -9106,14 +13211,23 @@ "sid", "identity" ], - "pathType": "list", "dependentProperties": { - "user_conversation": "{chat_service_sid: chat_service_sid, user_sid: sid}" + "user_conversations": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "user_sid": "sid" + }, + "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", + "tags": [ + "ConversationsV1User" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9143,6 +13257,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -9155,9 +13290,6 @@ } ], "operationId": "CreateServiceUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9188,6 +13320,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "admin", + "FriendlyName": "name", + "Attributes": "{ \"duty\": \"tech\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -9195,6 +13337,9 @@ }, "get": { "description": "Retrieve a list of all conversation users in your service", + "tags": [ + "ConversationsV1User" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9251,16 +13396,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9269,18 +13416,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + }, + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "agent0034", + "friendly_name": "John from customs", + "attributes": "{ \"duty\": \"agent\" }", + "is_online": false, + "is_notifiable": null, + "date_created": "2020-03-24T20:38:21Z", + "date_updated": "2020-03-24T20:38:21Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + ] } } } @@ -9294,10 +13490,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceUser" } }, "/v1/Services/{ChatServiceSid}/Users/{Sid}": { @@ -9312,14 +13505,23 @@ "sid", "identity" ], - "pathType": "instance", "dependentProperties": { - "user_conversation": "{chat_service_sid: chat_service_sid, user_sid: sid}" + "user_conversations": { + "mapping": { + "chat_service_sid": "chat_service_sid", + "user_sid": "sid" + }, + "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", + "tags": [ + "ConversationsV1User" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9358,6 +13560,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "new name", + "attributes": "{ \"duty\": \"tech\", \"team\": \"internals\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -9370,9 +13593,6 @@ } ], "operationId": "UpdateServiceUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9396,6 +13616,15 @@ "description": "The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "new name", + "Attributes": "{ \"duty\": \"tech\", \"team\": \"internals\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -9403,6 +13632,9 @@ }, "delete": { "description": "Remove a conversation user from your service", + "tags": [ + "ConversationsV1User" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9445,13 +13677,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceUser" }, "get": { "description": "Fetch a conversation user from your service", + "tags": [ + "ConversationsV1User" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9481,6 +13713,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -9492,10 +13745,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceUser" } }, "/v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}": { @@ -9513,12 +13763,15 @@ "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.", + "tags": [ + "ConversationsV1UserConversation" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9557,6 +13810,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_user.service_user_conversation" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -9569,9 +13852,6 @@ } ], "operationId": "UpdateServiceUserConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9595,6 +13875,15 @@ "description": "The index of the last Message in the Conversation that the Participant has read." } } + }, + "examples": { + "update": { + "value": { + "NotificationLevel": "default", + "LastReadTimestamp": "2015-07-30T20:00:00Z", + "LastReadMessageIndex": 100 + } + } } } } @@ -9602,6 +13891,9 @@ }, "delete": { "description": "Delete a specific User Conversation.", + "tags": [ + "ConversationsV1UserConversation" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9644,13 +13936,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceUserConversation" }, "get": { "description": "Fetch a specific User Conversation.", + "tags": [ + "ConversationsV1UserConversation" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9689,6 +13981,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_user.service_user_conversation" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -9700,10 +14022,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceUserConversation" } }, "/v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations": { @@ -9721,12 +14040,15 @@ "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.", + "tags": [ + "ConversationsV1UserConversation" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9792,16 +14114,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9810,17 +14134,72 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "conversations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFull": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -9835,10 +14214,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceUserConversation" } }, "/v1/Services/{ChatServiceSid}/Configuration/Webhooks": { @@ -9852,11 +14228,14 @@ "defaultOutputProperties": [ "chat_service_sid" ], - "pathType": "instance", - "parent": "/Services/{ChatServiceSid}/Configuration" + "parent": "/Services/{ChatServiceSid}/Configuration", + "pathType": "instance" }, "post": { "description": "Update a specific Webhook.", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9877,6 +14256,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "pre_webhook_url": "https://www.example.com/pre", + "post_webhook_url": "https://www.example.com/post", + "filters": [ + "onMessageRemoved", + "onParticipantAdded" + ], + "method": "GET", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks" + } + } } } }, @@ -9889,9 +14284,6 @@ } ], "operationId": "UpdateServiceWebhookConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9921,6 +14313,19 @@ "description": "The HTTP method to be used when sending a webhook request. One of `GET` or `POST`." } } + }, + "examples": { + "update": { + "value": { + "PreWebhookUrl": "https://www.example.com/pre", + "PostWebhookUrl": "https://www.example.com/post", + "Filters": [ + "onMessageRemoved", + "onParticipantAdded" + ], + "Method": "GET" + } + } } } } @@ -9928,6 +14333,9 @@ }, "get": { "description": "Fetch a specific service webhook configuration.", + "tags": [ + "ConversationsV1Webhook" + ], "parameters": [ { "name": "ChatServiceSid", @@ -9948,6 +14356,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "pre_webhook_url": "https://www.example.com/pre", + "post_webhook_url": "https://www.example.com/post", + "filters": [ + "onMessageRemove", + "onParticipantAdd" + ], + "method": "POST", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks" + } + }, + "fetchEmpty": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks", + "pre_webhook_url": null, + "post_webhook_url": null, + "filters": null, + "method": null + } + } } } }, @@ -9959,10 +14394,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceWebhookConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceWebhookConfiguration" } }, "/v1/Users": { @@ -9977,13 +14409,21 @@ "sid", "identity" ], - "pathType": "list", "dependentProperties": { - "user_conversation": "{user_sid: sid}" - } + "user_conversations": { + "mapping": { + "user_sid": "sid" + }, + "resource_url": "/v1/Users/{user_sid}/Conversations" + } + }, + "pathType": "list" }, "post": { "description": "Add a new conversation user to your account's default service", + "tags": [ + "ConversationsV1User" + ], "parameters": [ { "name": "X-Twilio-Webhook-Enabled", @@ -10001,6 +14441,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -10013,9 +14474,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10046,6 +14504,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "admin", + "FriendlyName": "name", + "Attributes": "{ \"duty\": \"tech\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -10053,6 +14521,9 @@ }, "get": { "description": "Retrieve a list of all conversation users in your account's default service", + "tags": [ + "ConversationsV1User" + ], "parameters": [ { "name": "PageSize", @@ -10097,16 +14568,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10115,18 +14588,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + }, + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "agent0034", + "friendly_name": "John from customs", + "attributes": "{ \"duty\": \"agent\" }", + "is_online": false, + "is_notifiable": null, + "date_created": "2020-03-24T20:38:21Z", + "date_updated": "2020-03-24T20:38:21Z", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + ] } } } @@ -10140,10 +14662,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v1/Users/{Sid}": { @@ -10158,13 +14677,21 @@ "sid", "identity" ], - "pathType": "instance", "dependentProperties": { - "user_conversation": "{user_sid: sid}" - } + "user_conversations": { + "mapping": { + "user_sid": "sid" + }, + "resource_url": "/v1/Users/{user_sid}/Conversations" + } + }, + "pathType": "instance" }, "post": { "description": "Update an existing conversation user in your account's default service", + "tags": [ + "ConversationsV1User" + ], "parameters": [ { "name": "Sid", @@ -10191,6 +14718,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "new name", + "attributes": "{ \"duty\": \"tech\", \"team\": \"internals\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -10203,9 +14751,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10229,6 +14774,15 @@ "description": "The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "new name", + "Attributes": "{ \"duty\": \"tech\", \"team\": \"internals\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -10236,6 +14790,9 @@ }, "delete": { "description": "Remove a conversation user from your account's default service", + "tags": [ + "ConversationsV1User" + ], "parameters": [ { "name": "Sid", @@ -10266,13 +14823,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "get": { "description": "Fetch a conversation user from your account's default service", + "tags": [ + "ConversationsV1User" + ], "parameters": [ { "name": "Sid", @@ -10290,6 +14847,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -10301,10 +14879,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" } }, "/v1/Users/{UserSid}/Conversations/{ConversationSid}": { @@ -10322,12 +14897,15 @@ "friendly_name", "date_created" ], - "pathType": "instance", "parent": "/Users/{Sid}", - "mountName": "user_conversations" + "mountName": "user_conversations", + "pathType": "instance" }, "post": { "description": "Update a specific User Conversation.", + "tags": [ + "ConversationsV1UserConversation" + ], "parameters": [ { "name": "UserSid", @@ -10354,6 +14932,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.user.user_conversation" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -10366,9 +14974,6 @@ } ], "operationId": "UpdateUserConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10392,6 +14997,15 @@ "description": "The index of the last Message in the Conversation that the Participant has read." } } + }, + "examples": { + "update": { + "value": { + "NotificationLevel": "default", + "LastReadTimestamp": "2015-07-30T20:00:00Z", + "LastReadMessageIndex": 100 + } + } } } } @@ -10399,6 +15013,9 @@ }, "delete": { "description": "Delete a specific User Conversation.", + "tags": [ + "ConversationsV1UserConversation" + ], "parameters": [ { "name": "UserSid", @@ -10429,13 +15046,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserConversation" }, "get": { "description": "Fetch a specific User Conversation.", + "tags": [ + "ConversationsV1UserConversation" + ], "parameters": [ { "name": "UserSid", @@ -10462,6 +15079,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.user.user_conversation" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -10473,10 +15120,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserConversation" } }, "/v1/Users/{UserSid}/Conversations": { @@ -10494,12 +15138,15 @@ "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.", + "tags": [ + "ConversationsV1UserConversation" + ], "parameters": [ { "name": "UserSid", @@ -10553,16 +15200,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10571,17 +15220,72 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "conversations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFull": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -10596,10 +15300,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserConversation" } } }, @@ -10608,10 +15309,59 @@ "url": "https://conversations.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "ConversationsV1AddressConfiguration" + }, + { + "name": "ConversationsV1Binding" + }, + { + "name": "ConversationsV1ChannelMetadata" + }, + { + "name": "ConversationsV1Configuration" + }, + { + "name": "ConversationsV1Conversation" + }, + { + "name": "ConversationsV1Credential" + }, + { + "name": "ConversationsV1DeliveryReceipt" + }, + { + "name": "ConversationsV1Message" + }, + { + "name": "ConversationsV1Notification" + }, + { + "name": "ConversationsV1Participant" + }, + { + "name": "ConversationsV1ParticipantConversation" + }, + { + "name": "ConversationsV1Role" + }, + { + "name": "ConversationsV1Service" + }, + { + "name": "ConversationsV1User" + }, + { + "name": "ConversationsV1UserConversation" + }, + { + "name": "ConversationsV1Webhook" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_events_v1.json b/spec/json/twilio_events_v1.json index 9d361215..b53c9bd5 100644 --- a/spec/json/twilio_events_v1.json +++ b/spec/json/twilio_events_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "events.v1.event_type": { "type": "object", @@ -223,7 +229,7 @@ "schema_version": { "type": "integer", "nullable": true, - "description": "The schema version that the subscription should use." + "description": "The schema version that the Subscription should use." }, "subscription_sid": { "type": "string", @@ -299,12 +305,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -320,7 +320,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -337,11 +337,14 @@ "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.", + "tags": [ + "EventsV1EventType" + ], "parameters": [ { "name": "SchemaId", @@ -349,6 +352,11 @@ "description": "A string parameter filtering the results to return only the Event Types using a given schema.", "schema": { "type": "string" + }, + "examples": { + "readResultsWithSchemaId": { + "value": "Messaging.MessageStatus" + } } }, { @@ -394,16 +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" @@ -412,17 +422,109 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "types": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Types?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Types?PageSize=10&Page=0", + "next_page_url": null, + "key": "types" + } + } + }, + "readResults": { + "value": { + "types": [ + { + "date_created": "2020-08-13T13:28:20Z", + "date_updated": "2020-08-13T13:28:20Z", + "type": "com.twilio.messaging.message.delivered", + "schema_id": "Messaging.MessageStatus", + "public": true, + "description": "Messaging- delivered message", + "url": "https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered", + "links": { + "schema": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + }, + { + "date_created": "2020-08-13T13:28:19Z", + "date_updated": "2020-08-13T13:28:19Z", + "type": "com.twilio.messaging.message.failed", + "schema_id": "Messaging.MessageStatus", + "public": true, + "description": "Messaging- failed message", + "url": "https://events.twilio.com/v1/Types/com.twilio.messaging.message.failed", + "links": { + "schema": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Types?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Types?PageSize=20&Page=0", + "next_page_url": null, + "key": "types" + } + } + }, + "readResultsWithSchemaId": { + "value": { + "types": [ + { + "date_created": "2020-08-13T13:28:20Z", + "date_updated": "2020-08-13T13:28:20Z", + "type": "com.twilio.messaging.message.delivered", + "schema_id": "Messaging.MessageStatus", + "public": true, + "description": "Messaging- delivered message", + "url": "https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered", + "links": { + "schema": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + }, + { + "date_created": "2020-08-13T13:28:19Z", + "date_updated": "2020-08-13T13:28:19Z", + "type": "com.twilio.messaging.message.failed", + "schema_id": "Messaging.MessageStatus", + "public": true, + "description": "Messaging- failed message", + "url": "https://events.twilio.com/v1/Types/com.twilio.messaging.message.failed", + "links": { + "schema": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Types?SchemaId=Messaging.MessageStatus&PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Types?SchemaId=Messaging.MessageStatus&PageSize=20&Page=0", + "next_page_url": null, + "key": "types" } } } @@ -437,10 +539,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEventType", - "x-maturity": [ - "Beta" - ] + "operationId": "ListEventType" } }, "/v1/Types/{Type}": { @@ -456,11 +555,14 @@ "schema_id", "description" ], - "pathType": "instance", - "mountName": "event_types" + "mountName": "event_types", + "pathType": "instance" }, "get": { "description": "Fetch a specific Event Type.", + "tags": [ + "EventsV1EventType" + ], "parameters": [ { "name": "Type", @@ -478,6 +580,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.event_type" + }, + "examples": { + "fetch": { + "value": { + "date_created": "2020-08-13T13:28:20Z", + "date_updated": "2020-08-13T13:28:20Z", + "type": "com.twilio.messaging.message.delivered", + "schema_id": "Messaging.MessageStatus", + "public": true, + "description": "Messaging- delivered message", + "url": "https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered", + "links": { + "schema": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + } + } } } }, @@ -489,10 +607,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEventType", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchEventType" } }, "/v1/Schemas/{Id}": { @@ -506,13 +621,21 @@ "defaultOutputProperties": [ "id" ], - "pathType": "instance", "dependentProperties": { - "schema_version": "{id: id}" - } + "versions": { + "mapping": { + "id": "id" + }, + "resource_url": "/v1/Schemas/{id}/Versions" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific schema with its nested versions.", + "tags": [ + "EventsV1Schema" + ], "parameters": [ { "name": "Id", @@ -530,6 +653,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.schema" + }, + "examples": { + "fetch": { + "value": { + "id": "Messaging.MessageStatus", + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus", + "latest_version_date_created": "2020-07-30T20:00:00Z", + "latest_version": 1, + "links": { + "versions": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + } + } } } }, @@ -541,10 +677,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSchema", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSchema" } }, "/v1/Schemas": { @@ -558,10 +691,15 @@ "defaultOutputProperties": [ "id" ], - "pathType": "list", "dependentProperties": { - "schema_version": "{id: id}" - } + "versions": { + "mapping": { + "id": "id" + }, + "resource_url": "/v1/Schemas/{id}/Versions" + } + }, + "pathType": "list" } }, "/v1/Schemas/{Id}/Versions": { @@ -577,12 +715,15 @@ "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.", + "tags": [ + "EventsV1SchemaVersion" + ], "parameters": [ { "name": "Id", @@ -636,16 +777,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -654,17 +797,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "schema_versions": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=10&Page=0", + "next_page_url": null, + "key": "schema_versions" + } + } + }, + "readResults": { + "value": { + "schema_versions": [ + { + "id": "Messaging.MessageStatus", + "schema_version": 1, + "public": true, + "date_created": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/1", + "raw": "https://events-schemas.twilio.com/Messaging.MessageStatus/1" + }, + { + "id": "Messaging.MessageStatus", + "schema_version": 2, + "public": true, + "date_created": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/2", + "raw": "https://events-schemas.twilio.com/Messaging.MessageStatus/2" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=50&Page=0", + "next_page_url": null, + "key": "schema_versions" } } } @@ -679,10 +867,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSchemaVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSchemaVersion" } }, "/v1/Schemas/{Id}/Versions/{SchemaVersion}": { @@ -698,12 +883,15 @@ "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.", + "tags": [ + "EventsV1SchemaVersion" + ], "parameters": [ { "name": "Id", @@ -730,6 +918,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.schema.schema_version" + }, + "examples": { + "fetch": { + "value": { + "id": "Messaging.MessageStatus", + "schema_version": 1, + "public": true, + "date_created": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/1", + "raw": "https://events-schemas.twilio.com/Messaging.MessageStatus/1" + } + } } } }, @@ -741,10 +941,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSchemaVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSchemaVersion" } }, "/v1/Sinks/{Sid}": { @@ -764,14 +961,27 @@ "sink_type", "status" ], - "pathType": "instance", "dependentProperties": { - "sink_test": "{sid: sid}", - "sink_validate": "{sid: sid}" - } + "sink_test": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v1/Sinks/{sid}/Test" + }, + "sink_validate": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v1/Sinks/{sid}/Validate" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Sink.", + "tags": [ + "EventsV1Sink" + ], "parameters": [ { "name": "Sid", @@ -792,6 +1002,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink" + }, + "examples": { + "fetch": { + "value": { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "A Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + } + } } } }, @@ -803,13 +1035,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSink", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSink" }, "delete": { "description": "Delete a specific Sink.", + "tags": [ + "EventsV1Sink" + ], "parameters": [ { "name": "Sid", @@ -834,13 +1066,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSink", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSink" }, "post": { "description": "Update a specific Sink", + "tags": [ + "EventsV1Sink" + ], "parameters": [ { "name": "Sid", @@ -861,6 +1093,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink" + }, + "examples": { + "update": { + "value": { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "My Kinesis Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + } + } } } }, @@ -873,9 +1127,6 @@ } ], "operationId": "UpdateSink", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -891,6 +1142,13 @@ "required": [ "Description" ] + }, + "examples": { + "update": { + "value": { + "Description": "My Kinesis Sink" + } + } } } } @@ -914,20 +1172,73 @@ "sink_type", "status" ], - "pathType": "list", "dependentProperties": { - "sink_test": "{sid: sid}", - "sink_validate": "{sid: sid}" - } + "sink_test": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v1/Sinks/{sid}/Test" + }, + "sink_validate": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v1/Sinks/{sid}/Validate" + } + }, + "pathType": "list" }, "post": { "description": "Create a new Sink", + "tags": [ + "EventsV1Sink" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink" + }, + "examples": { + "create": { + "value": { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "My Kinesis Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + } + }, + "createSegment": { + "value": { + "status": "initialized", + "sink_configuration": { + "write_key": "MY_WRITEKEY" + }, + "description": "My segment Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "segment", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + } + } } } }, @@ -940,9 +1251,6 @@ } ], "operationId": "CreateSink", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -968,6 +1276,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\"}" + } + } } } } @@ -975,6 +1299,9 @@ }, "get": { "description": "Retrieve a paginated list of Sinks belonging to the account used to make the request.", + "tags": [ + "EventsV1Sink" + ], "parameters": [ { "name": "InUse", @@ -982,6 +1309,11 @@ "description": "A boolean query parameter filtering the results to return sinks used/not used by a subscription.", "schema": { "type": "boolean" + }, + "examples": { + "readResultsInUse": { + "value": true + } } }, { @@ -990,6 +1322,11 @@ "description": "A String query parameter filtering the results by status `initialized`, `validating`, `active` or `failed`.", "schema": { "type": "string" + }, + "examples": { + "readResultsStatus": { + "value": "active" + } } }, { @@ -1035,16 +1372,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1053,17 +1392,202 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sinks": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Sinks?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Sinks?PageSize=10&Page=0", + "next_page_url": null, + "key": "sinks" + } + } + }, + "readResults": { + "value": { + "sinks": [ + { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "A Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T19:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + }, + { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:222222222:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "ANOTHER Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Validate" + } + }, + { + "status": "active", + "sink_configuration": { + "destination": "http://example.org/webhook", + "method": "POST", + "batch_events": true + }, + "description": "A webhook Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "date_created": "2015-07-30T21:00:00Z", + "sink_type": "webhook", + "date_updated": "2015-07-30T21:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Sinks?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Sinks?PageSize=20&Page=0", + "next_page_url": null, + "key": "sinks" + } + } + }, + "readResultsInUse": { + "value": { + "sinks": [ + { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "A Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T19:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + }, + { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:222222222:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "ANOTHER Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Validate" + } + }, + { + "status": "active", + "sink_configuration": { + "destination": "http://example.org/webhook", + "method": "POST", + "batch_events": true + }, + "description": "A webhook Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "date_created": "2015-07-30T21:00:00Z", + "sink_type": "webhook", + "date_updated": "2015-07-30T21:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Sinks?InUse=True&PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Sinks?InUse=True&PageSize=20&Page=0", + "next_page_url": null, + "key": "sinks" + } + } + }, + "readResultsStatus": { + "value": { + "sinks": [ + { + "status": "active", + "sink_configuration": { + "destination": "http://example.org/webhook", + "method": "POST", + "batch_events": true + }, + "description": "A webhook Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "date_created": "2015-07-30T21:00:00Z", + "sink_type": "webhook", + "date_updated": "2015-07-30T21:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Sinks?Status=active&PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Sinks?Status=active&PageSize=20&Page=0", + "next_page_url": null, + "key": "sinks" } } } @@ -1078,10 +1602,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSink", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSink" } }, "/v1/Sinks/{Sid}/Test": { @@ -1095,12 +1616,15 @@ "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.", + "tags": [ + "EventsV1SinkTest" + ], "parameters": [ { "name": "Sid", @@ -1121,6 +1645,13 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink.sink_test" + }, + "examples": { + "create": { + "value": { + "result": "submitted" + } + } } } }, @@ -1132,10 +1663,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSinkTest", - "x-maturity": [ - "Beta" - ] + "operationId": "CreateSinkTest" } }, "/v1/Sinks/{Sid}/Validate": { @@ -1149,12 +1677,15 @@ "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.", + "tags": [ + "EventsV1SinkValidate" + ], "parameters": [ { "name": "Sid", @@ -1175,6 +1706,13 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink.sink_validate" + }, + "examples": { + "create": { + "value": { + "result": "valid" + } + } } } }, @@ -1187,9 +1725,6 @@ } ], "operationId": "CreateSinkValidate", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1205,6 +1740,13 @@ "required": [ "TestId" ] + }, + "examples": { + "create": { + "value": { + "TestId": "TestID" + } + } } } } @@ -1217,7 +1759,7 @@ "url": "https://events.twilio.com" } ], - "description": "Event subscribed to in the parent subscription", + "description": "Event subscribed to in the parent Subscription", "x-twilio": { "defaultOutputProperties": [ "type", @@ -1225,11 +1767,14 @@ "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.", + "tags": [ + "EventsV1SubscribedEvent" + ], "parameters": [ { "name": "SubscriptionSid", @@ -1286,16 +1831,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1304,17 +1851,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "types": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=10&Page=0", + "next_page_url": null, + "key": "types" + } + } + }, + "readResults": { + "value": { + "types": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "com.twilio.messaging.message.delivered", + "schema_version": 2, + "subscription_sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "com.twilio.messaging.message.failed", + "schema_version": 15, + "subscription_sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.failed" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=50&Page=0", + "next_page_url": null, + "key": "types" } } } @@ -1329,13 +1919,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListSubscribedEvent", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSubscribedEvent" }, "post": { - "description": "Create a new Subscribed Event type for the subscription", + "description": "Add an event type to a Subscription.", + "tags": [ + "EventsV1SubscribedEvent" + ], "parameters": [ { "name": "SubscriptionSid", @@ -1356,6 +1946,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.subscription.subscribed_event" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subscription_sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "com.twilio.messaging.message.delivered", + "schema_version": 2, + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered" + } + } } } }, @@ -1368,9 +1969,6 @@ } ], "operationId": "CreateSubscribedEvent", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1384,12 +1982,20 @@ }, "SchemaVersion": { "type": "integer", - "description": "The schema version that the subscription should use." + "description": "The schema version that the Subscription should use." } }, "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "com.twilio.messaging.message.delivered", + "SchemaVersion": 2 + } + } } } } @@ -1402,7 +2008,7 @@ "url": "https://events.twilio.com" } ], - "description": "Event subscribed to in the parent subscription", + "description": "Event subscribed to in the parent Subscription", "x-twilio": { "defaultOutputProperties": [ "type", @@ -1410,11 +2016,14 @@ "account_sid", "subscription_sid" ], - "pathType": "instance", - "parent": "/Subscriptions/{Sid}" + "parent": "/Subscriptions/{Sid}", + "pathType": "instance" }, "get": { "description": "Read an Event for a Subscription.", + "tags": [ + "EventsV1SubscribedEvent" + ], "parameters": [ { "name": "SubscriptionSid", @@ -1444,6 +2053,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.subscription.subscribed_event" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subscription_sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "com.twilio.messaging.message.delivered", + "schema_version": 2, + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered" + } + } } } }, @@ -1455,13 +2075,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSubscribedEvent", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSubscribedEvent" }, "post": { "description": "Update an Event for a Subscription.", + "tags": [ + "EventsV1SubscribedEvent" + ], "parameters": [ { "name": "SubscriptionSid", @@ -1491,6 +2111,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.subscription.subscribed_event" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subscription_sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "com.twilio.messaging.message.delivered", + "schema_version": 2, + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered" + } + } } } }, @@ -1503,9 +2134,6 @@ } ], "operationId": "UpdateSubscribedEvent", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1515,7 +2143,14 @@ "properties": { "SchemaVersion": { "type": "integer", - "description": "The schema version that the subscription should use." + "description": "The schema version that the Subscription should use." + } + } + }, + "examples": { + "update": { + "value": { + "SchemaVersion": 2 } } } @@ -1524,7 +2159,10 @@ } }, "delete": { - "description": "Remove an event type from a subscription.", + "description": "Remove an event type from a Subscription.", + "tags": [ + "EventsV1SubscribedEvent" + ], "parameters": [ { "name": "SubscriptionSid", @@ -1558,10 +2196,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSubscribedEvent", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSubscribedEvent" } }, "/v1/Subscriptions": { @@ -1579,13 +2214,21 @@ "date_created", "date_updated" ], - "pathType": "list", "dependentProperties": { - "subscribed_event": "{subscription_sid: sid}" - } + "subscribed_events": { + "mapping": { + "subscription_sid": "sid" + }, + "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.", + "tags": [ + "EventsV1Subscription" + ], "parameters": [ { "name": "SinkSid", @@ -1596,6 +2239,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^DG[0-9a-fA-F]{32}$" + }, + "examples": { + "readResultsFilteredBySinkSid": { + "value": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1641,16 +2289,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1659,17 +2309,109 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "subscriptions": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Subscriptions?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Subscriptions?PageSize=10&Page=0", + "next_page_url": null, + "key": "subscriptions" + } + } + }, + "readResults": { + "value": { + "subscriptions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "A subscription", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents" + } + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Another subscription", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/SubscribedEvents" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Subscriptions?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Subscriptions?PageSize=20&Page=0", + "next_page_url": null, + "key": "subscriptions" + } + } + }, + "readResultsFilteredBySinkSid": { + "value": { + "subscriptions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "A subscription", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents" + } + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Another subscription", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/SubscribedEvents" + } + } + ], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Subscriptions?SinkSid=DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Subscriptions?SinkSid=DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=10&Page=0", + "next_page_url": null, + "key": "subscriptions" } } } @@ -1684,19 +2426,36 @@ "accountSid_authToken": [] } ], - "operationId": "ListSubscription", - "x-maturity": [ - "Beta" - ] + "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" + } + } + } } } }, @@ -1709,9 +2468,6 @@ } ], "operationId": "CreateSubscription", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1741,6 +2497,18 @@ "SinkSid", "Types" ] + }, + "examples": { + "create": { + "value": { + "SinkSid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Description": "A subscription", + "Types": [ + "{\"type\": \"com.twilio.messaging.message.delivered\",\"schema_version\": 1}", + "{\"type\": \"com.twilio.messaging.message.failed\",\"schema_version\": 12}" + ] + } + } } } } @@ -1762,13 +2530,21 @@ "date_created", "date_updated" ], - "pathType": "instance", "dependentProperties": { - "subscribed_event": "{subscription_sid: sid}" - } + "subscribed_events": { + "mapping": { + "subscription_sid": "sid" + }, + "resource_url": "/v1/Subscriptions/{subscription_sid}/SubscribedEvents" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Subscription.", + "tags": [ + "EventsV1Subscription" + ], "parameters": [ { "name": "Sid", @@ -1789,6 +2565,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.subscription" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "A subscription", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents" + } + } + } } } }, @@ -1800,13 +2592,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSubscription", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSubscription" }, "post": { "description": "Update a Subscription.", + "tags": [ + "EventsV1Subscription" + ], "parameters": [ { "name": "Sid", @@ -1827,6 +2619,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.subscription" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2020-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "description": "Updated description", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents" + } + } + } } } }, @@ -1839,9 +2647,6 @@ } ], "operationId": "UpdateSubscription", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1861,6 +2666,14 @@ "description": "The SID of the sink that events selected by this subscription should be sent to. Sink must be active for the subscription to be created." } } + }, + "examples": { + "update": { + "value": { + "SinkSid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "Description": "Updated description" + } + } } } } @@ -1868,6 +2681,9 @@ }, "delete": { "description": "Delete a specific Subscription.", + "tags": [ + "EventsV1Subscription" + ], "parameters": [ { "name": "Sid", @@ -1892,10 +2708,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSubscription", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSubscription" } } }, @@ -1904,10 +2717,35 @@ "url": "https://events.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "EventsV1EventType" + }, + { + "name": "EventsV1Schema" + }, + { + "name": "EventsV1SchemaVersion" + }, + { + "name": "EventsV1Sink" + }, + { + "name": "EventsV1SinkTest" + }, + { + "name": "EventsV1SinkValidate" + }, + { + "name": "EventsV1SubscribedEvent" + }, + { + "name": "EventsV1Subscription" + } + ], + "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/spec/json/twilio_flex_v1.json b/spec/json/twilio_flex_v1.json index 90ccb85d..8ebb7900 100644 --- a/spec/json/twilio_flex_v1.json +++ b/spec/json/twilio_flex_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "flex.v1.channel": { "type": "object", @@ -179,6 +185,14 @@ "nullable": true, "description": "The SID of the Flex service instance." }, + "flex_instance_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GO[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex instance." + }, "ui_language": { "type": "string", "nullable": true, @@ -319,6 +333,18 @@ "flex_ui_status_report": { "nullable": true, "description": "Configurable parameters for Flex UI Status report." + }, + "agent_conv_end_methods": { + "nullable": true, + "description": "Agent conversation end methods." + }, + "citrix_voice_vdi": { + "nullable": true, + "description": "Citrix voice vdi configuration and settings." + }, + "offline_config": { + "nullable": true, + "description": "Presence and presence ttl configuration" } } }, @@ -330,6 +356,117 @@ "notstarted" ] }, + "flex.v1.plugin_configuration.configured_plugin": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Flex Plugin resource is installed for." + }, + "configuration_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FJ[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Plugin Configuration that this Flex Plugin belongs to." + }, + "plugin_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FP[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Plugin." + }, + "plugin_version_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FV[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Plugin Version." + }, + "phase": { + "type": "integer", + "nullable": true, + "description": "The phase this Flex Plugin would initialize at runtime." + }, + "plugin_url": { + "type": "string", + "nullable": true, + "description": "The URL of where the Flex Plugin Version JavaScript bundle is hosted on.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "The name that uniquely identifies this Flex Plugin resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The friendly name of this Flex Plugin resource." + }, + "description": { + "type": "string", + "nullable": true, + "description": "A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long" + }, + "plugin_archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin is archived. The default value is false." + }, + "version": { + "type": "string", + "nullable": true, + "description": "The latest version of this Flex Plugin Version." + }, + "changelog": { + "type": "string", + "nullable": true, + "description": "A changelog that describes the changes this Flex Plugin Version brings." + }, + "plugin_version_archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin Version is archived. The default value is false." + }, + "private": { + "type": "boolean", + "nullable": true, + "description": "Whether to validate the request is authorized to access the Flex Plugin Version." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin was installed 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 Flex Plugin resource." + } + } + }, "flex.v1.flex_flow": { "type": "object", "properties": { @@ -364,7 +501,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "chat_service_sid": { "type": "string", @@ -586,6 +729,52 @@ } } }, + "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" + ] + }, + "insights_conversational_ai_enum_type": { + "type": "string", + "enum": [ + "metrics", + "summary" + ] + }, + "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", + "mean_trend", + "scored_mean_trend", + "total_trend" + ] + }, "flex.v1.insights_conversations": { "type": "object", "properties": { @@ -987,6 +1176,13 @@ "type": "object", "format": "uri-map", "nullable": true + }, + "interaction_context_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HQ[0-9a-fA-F]{32}$", + "nullable": true } } }, @@ -1013,7 +1209,7 @@ "type": "string", "$ref": "#/components/schemas/interaction_channel_enum_type", "nullable": true, - "description": "The Interaction Channel's type. Can be: `sms`, `email`, `chat`, `whatsapp`, `web`. \n **Note:** These can be different from the task channel type specified in the Routing attributes. Task channel type corresponds to channel capacity while this channel type is the actual media type" + "description": "The Interaction Channel's type. Can be: `sms`, `email`, `chat`, `whatsapp`, `web`, `messenger`, or `gbm`. \n **Note:** These can be different from the task channel type specified in the Routing attributes. Task channel type corresponds to channel capacity while this channel type is the actual media type" }, "status": { "type": "string", @@ -1069,7 +1265,35 @@ "setup", "active", "failed", - "closed" + "closed", + "inactive" + ] + }, + "interaction_channel_enum_update_channel_status": { + "type": "string", + "enum": [ + "closed", + "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": { @@ -1160,6 +1384,10 @@ "type": "string", "format": "uri", "nullable": true + }, + "routing_properties": { + "nullable": true, + "description": "The Participant's routing properties." } } }, @@ -1180,104 +1408,2610 @@ "unknown" ] }, - "flex.v1.web_channel": { + "flex.v1.plugin": { "type": "object", "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FP[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Flex Plugin 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/iam/api/account) that created the WebChannel resource and owns this Workflow." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin resource and owns this resource." }, - "flex_flow_sid": { + "unique_name": { + "type": "string", + "nullable": true, + "description": "The name that uniquely identifies this Flex Plugin resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The friendly name this Flex Plugin resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "description": { + "type": "string", + "nullable": true, + "description": "A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin is archived. The default value is false." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT-7 when the Flex Plugin 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-7 when the Flex Plugin 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 Flex Plugin resource." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true + } + } + }, + "flex.v1.plugin_archive": { + "type": "object", + "properties": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$", + "pattern": "^FP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flex Flow." + "description": "The unique string that we created to identify the Flex Plugin resource." }, - "sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that we created to identify the WebChannel resource." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin resource and owns this resource." }, - "url": { + "unique_name": { "type": "string", - "format": "uri", "nullable": true, - "description": "The absolute URL of the WebChannel resource." + "description": "The name that uniquely identifies this Flex Plugin resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The friendly name this Flex Plugin resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "description": { + "type": "string", + "nullable": true, + "description": "A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin is archived. The default value is false." }, "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." + "description": "The date and time in GMT when the Flex Plugin 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." + "description": "The date and time in GMT when the Flex Plugin 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 Flex Plugin resource." } } }, - "web_channel_enum_chat_status": { - "type": "string", - "enum": [ - "inactive" - ] - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } - } - }, - "info": { - "title": "Twilio - Flex", - "description": "This is the public Twilio REST API.", - "termsOfService": "https://www.twilio.com/legal/tos", - "contact": { - "name": "Twilio Support", - "url": "https://support.twilio.com", - "email": "support@twilio.com" - }, - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "version": "1.43.2" - }, - "openapi": "3.0.1", - "paths": { - "/v1/Channels": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "Flex chat channels", + "flex.v1.plugin_configuration": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FJ[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Flex Plugin Configuration 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/iam/api/account) that created the Flex Plugin Configuration resource and owns this resource." + }, + "name": { + "type": "string", + "nullable": true, + "description": "The name of this Flex Plugin Configuration." + }, + "description": { + "type": "string", + "nullable": true, + "description": "The description of the Flex Plugin Configuration resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin Configuration is archived. The default value is false." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin Configuration was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Flex Plugin Configuration resource." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true + } + } + }, + "flex.v1.plugin_configuration_archive": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FJ[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Flex Plugin Configuration 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/iam/api/account) that created the Flex Plugin Configuration resource and owns this resource." + }, + "name": { + "type": "string", + "nullable": true, + "description": "The name of this Flex Plugin Configuration." + }, + "description": { + "type": "string", + "nullable": true, + "description": "The description of the Flex Plugin Configuration resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin Configuration is archived. The default value is false." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin Configuration was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Flex Plugin Configuration resource." + } + } + }, + "flex.v1.plugin_release": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FK[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Plugin Release 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/iam/api/account) that created the Plugin Release resource and owns this resource." + }, + "configuration_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FJ[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Plugin Configuration resource to release." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin Release was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Plugin Release resource." + } + } + }, + "flex.v1.plugin.plugin_version": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FV[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Flex Plugin Version resource." + }, + "plugin_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FP[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Plugin resource this Flex Plugin Version belongs to." + }, + "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 Flex Plugin Version resource and owns this resource." + }, + "version": { + "type": "string", + "nullable": true, + "description": "The unique version of this Flex Plugin Version." + }, + "plugin_url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of where the Flex Plugin Version JavaScript bundle is hosted on.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "changelog": { + "type": "string", + "nullable": true, + "description": "A changelog that describes the changes this Flex Plugin Version brings.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "private": { + "type": "boolean", + "nullable": true, + "description": "Whether to inject credentials while accessing this Plugin Version. The default value is false." + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin Version is archived. The default value is false." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin Version was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Flex Plugin Version resource." + } + } + }, + "flex.v1.plugin_version_archive": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FV[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Flex Plugin Version resource." + }, + "plugin_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FP[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Plugin resource this Flex Plugin Version belongs to." + }, + "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 Flex Plugin Version resource and owns this resource." + }, + "version": { + "type": "string", + "nullable": true, + "description": "The unique version of this Flex Plugin Version." + }, + "plugin_url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of where the Flex Plugin Version JavaScript bundle is hosted on.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "changelog": { + "type": "string", + "nullable": true, + "description": "A changelog that describes the changes this Flex Plugin Version brings.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "private": { + "type": "boolean", + "nullable": true, + "description": "Whether to inject credentials while accessing this Plugin Version. The default value is false." + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin Version is archived. The default value is false." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin Version was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Flex Plugin Version resource." + } + } + }, + "flex.v1.provisioning_status": { + "type": "object", + "properties": { + "status": { + "type": "string", + "$ref": "#/components/schemas/provisioning_status_enum_status", + "nullable": true, + "description": "Email Provisioning Status" + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the resource." + } + } + }, + "provisioning_status_enum_status": { + "type": "string", + "enum": [ + "active", + "in-progress", + "not-configured", + "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": { + "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 WebChannel resource and owns this Workflow." + }, + "flex_flow_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Flow." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the WebChannel resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the WebChannel 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." + } + } + }, + "web_channel_enum_chat_status": { + "type": "string", + "enum": [ + "inactive" + ] + } + } + }, + "info": { + "title": "Twilio - Flex", + "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/Channels": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Flex chat channels", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "flex_flow_sid", + "user_sid", + "task_sid" + ], + "mountName": "channel", + "pathType": "list" + }, + "get": { + "description": "", + "tags": [ + "FlexV1Channel" + ], + "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": "ListChannelResponse", + "properties": { + "flex_chat_channels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.channel" + } + }, + "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": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_chat_channels" + }, + "flex_chat_channels": [ + { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_chat_channels" + }, + "flex_chat_channels": [] + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListChannel" + }, + "post": { + "description": "", + "tags": [ + "FlexV1Channel" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.channel" + }, + "examples": { + "create": { + "value": { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateChannel", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateChannelRequest", + "properties": { + "FlexFlowSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$", + "description": "The SID of the Flex Flow." + }, + "Identity": { + "type": "string", + "description": "The `identity` value that uniquely identifies the new resource's chat User." + }, + "ChatUserFriendlyName": { + "type": "string", + "description": "The chat participant's friendly name." + }, + "ChatFriendlyName": { + "type": "string", + "description": "The chat channel's friendly name." + }, + "Target": { + "type": "string", + "description": "The Target Contact Identity, for example the phone number of an SMS." + }, + "ChatUniqueName": { + "type": "string", + "description": "The chat channel's unique name." + }, + "PreEngagementData": { + "type": "string", + "description": "The pre-engagement data." + }, + "TaskSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WT[0-9a-fA-F]{32}$", + "description": "The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external`" + }, + "TaskAttributes": { + "type": "string", + "description": "The Task attributes to be added for the TaskRouter Task." + }, + "LongLived": { + "type": "boolean", + "description": "Whether to create the channel as long-lived." + } + }, + "required": [ + "FlexFlowSid", + "Identity", + "ChatUserFriendlyName", + "ChatFriendlyName" + ] + }, + "examples": { + "create": { + "value": { + "FlexFlowSid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Target": "def", + "Identity": "abc", + "ChatUserFriendlyName": "friendly2", + "ChatFriendlyName": "friendly1", + "ChatUniqueName": "unique", + "PreEngagementData": "{}", + "TaskSid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TaskAttributes": "{}", + "LongLived": true + } + } + } + } + } + } + } + }, + "/v1/Channels/{Sid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Flex chat channels", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "flex_flow_sid", + "user_sid", + "task_sid" + ], + "mountName": "channel", + "pathType": "instance" + }, + "get": { + "description": "", + "tags": [ + "FlexV1Channel" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the Flex chat channel resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.channel" + }, + "examples": { + "fetch": { + "value": { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchChannel" + }, + "delete": { + "description": "", + "tags": [ + "FlexV1Channel" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the Flex chat channel resource to delete.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteChannel" + } + }, + "/v1/Configuration": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Configuration for a Flex instance", + "x-twilio": { + "defaultOutputProperties": [ + "status", + "ui_language", + "ui_version", + "service_version" + ], + "pathType": "instance" + }, + "get": { + "description": "", + "tags": [ + "FlexV1Configuration" + ], + "parameters": [ + { + "name": "UiVersion", + "in": "query", + "description": "The Pinned UI version of the Configuration resource to fetch.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "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 + } + } + } + } + } + }, + "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 + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateConfiguration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "UpdateConfigurationRequest", + "properties": {} + } + } + } + } + } + }, + "/v1/PluginService/Configurations/{ConfigurationSid}/Plugins": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "plugin_sid", + "plugin_version_sid", + "plugin_url", + "phase" + ], + "parent": "/PluginService/Configurations/{Sid}", + "className": "configured_plugin", + "pathType": "list" + }, + "get": { + "description": "", + "tags": [ + "FlexV1ConfiguredPlugin" + ], + "parameters": [ + { + "name": "ConfigurationSid", + "in": "path", + "description": "The SID of the Flex Plugin Configuration the resource to belongs to.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", + "schema": { + "type": "string" + } + }, + { + "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": "ListConfiguredPluginResponse", + "properties": { + "plugins": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.plugin_configuration.configured_plugin" + } + }, + "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": { + "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" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListConfiguredPlugin" + } + }, + "/v1/PluginService/Configurations/{ConfigurationSid}/Plugins/{PluginSid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "plugin_sid", + "plugin_version_sid", + "plugin_url", + "phase" + ], + "parent": "/PluginService/Configurations/{Sid}", + "className": "configured_plugin", + "pathType": "instance" + }, + "get": { + "description": "", + "tags": [ + "FlexV1ConfiguredPlugin" + ], + "parameters": [ + { + "name": "ConfigurationSid", + "in": "path", + "description": "The SID of the Flex Plugin Configuration the resource to belongs to.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "PluginSid", + "in": "path", + "description": "The unique string that we created to identify the Flex Plugin resource.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "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" + } + }, + "/v1/FlexFlows": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Flex Flow", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "friendly_name", + "channel_type", + "integration_type" + ], + "mountName": "flex_flow", + "pathType": "list" + }, + "get": { + "description": "", + "tags": [ + "FlexV1FlexFlow" + ], + "parameters": [ + { + "name": "FriendlyName", + "in": "query", + "description": "The `friendly_name` of the Flex Flow resources to read.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + { + "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": "ListFlexFlowResponse", + "properties": { + "flex_flows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.flex_flow" + } + }, + "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": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_flows" + }, + "flex_flows": [ + { + "sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "friendly_name": "friendly_name", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_type": "sms", + "contact_identity": "12345", + "enabled": true, + "integration_type": "studio", + "integration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "retry_count": 1 + }, + "long_lived": true, + "janitor_enabled": true, + "url": "https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_flows" + }, + "flex_flows": [] + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListFlexFlow" + }, + "post": { + "description": "", + "tags": [ + "FlexV1FlexFlow" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.flex_flow" + }, + "examples": { + "create": { + "value": { + "sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "friendly_name": "friendly_name", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_type": "sms", + "contact_identity": "12345", + "enabled": true, + "integration_type": "studio", + "integration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "retry_count": 1 + }, + "long_lived": true, + "janitor_enabled": true, + "url": "https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateFlexFlow", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateFlexFlowRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A descriptive string that you create to describe the Flex Flow resource." + }, + "ChatServiceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "description": "The SID of the chat service." + }, + "ChannelType": { + "type": "string", + "$ref": "#/components/schemas/flex_flow_enum_channel_type", + "description": "The channel type. One of `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex widget should set the Task Channel to Programmable Chat." + }, + "ContactIdentity": { + "type": "string", + "description": "The channel contact's Identity." + }, + "Enabled": { + "type": "boolean", + "description": "Whether the new Flex Flow is enabled." + }, + "IntegrationType": { + "type": "string", + "$ref": "#/components/schemas/flex_flow_enum_integration_type", + "description": "The software that will handle inbound messages. [Integration Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) can be: `studio`, `external`, or `task`." + }, + "Integration.FlowSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "description": "The SID of the Studio Flow. Required when `integrationType` is `studio`." + }, + "Integration.Url": { + "type": "string", + "format": "uri", + "description": "The URL of the external webhook. Required when `integrationType` is `external`." + }, + "Integration.WorkspaceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", + "description": "The Workspace SID for a new Task. Required when `integrationType` is `task`." + }, + "Integration.WorkflowSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WW[0-9a-fA-F]{32}$", + "description": "The Workflow SID for a new Task. Required when `integrationType` is `task`." + }, + "Integration.Channel": { + "type": "string", + "description": "The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`." + }, + "Integration.Timeout": { + "type": "integer", + "description": "The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise." + }, + "Integration.Priority": { + "type": "integer", + "description": "The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise." + }, + "Integration.CreationOnMessage": { + "type": "boolean", + "description": "In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging." + }, + "LongLived": { + "type": "boolean", + "description": "When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`." + }, + "JanitorEnabled": { + "type": "boolean", + "description": "When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`." + }, + "Integration.RetryCount": { + "type": "integer", + "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." + } + }, + "required": [ + "FriendlyName", + "ChatServiceSid", + "ChannelType" + ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "ChatServiceSid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChannelType": "sms", + "ContactIdentity": "12345", + "Enabled": true, + "IntegrationType": "studio", + "Integration.FlowSid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "LongLived": true, + "JanitorEnabled": true, + "Integration.RetryCount": 1 + } + } + } + } + } + } + } + }, + "/v1/FlexFlows/{Sid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Flex Flow", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "friendly_name", + "channel_type", + "integration_type" + ], + "mountName": "flex_flow", + "pathType": "instance" + }, + "get": { + "description": "", + "tags": [ + "FlexV1FlexFlow" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Flow resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.flex_flow" + }, + "examples": { + "fetch": { + "value": { + "sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "friendly_name": "friendly_name", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_type": "sms", + "contact_identity": "12345", + "enabled": true, + "integration_type": "studio", + "integration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "retry_count": 1 + }, + "long_lived": true, + "janitor_enabled": true, + "url": "https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchFlexFlow" + }, + "post": { + "description": "", + "tags": [ + "FlexV1FlexFlow" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Flow resource to update.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.flex_flow" + }, + "examples": { + "update": { + "value": { + "sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "friendly_name": "friendly_name", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_type": "sms", + "contact_identity": "12345", + "enabled": true, + "integration_type": "studio", + "integration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "retry_count": 1 + }, + "long_lived": true, + "janitor_enabled": true, + "url": "https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateFlexFlow", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateFlexFlowRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A descriptive string that you create to describe the Flex Flow resource." + }, + "ChatServiceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "description": "The SID of the chat service." + }, + "ChannelType": { + "type": "string", + "$ref": "#/components/schemas/flex_flow_enum_channel_type", + "description": "The channel type. One of `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex widget should set the Task Channel to Programmable Chat." + }, + "ContactIdentity": { + "type": "string", + "description": "The channel contact's Identity." + }, + "Enabled": { + "type": "boolean", + "description": "Whether the new Flex Flow is enabled." + }, + "IntegrationType": { + "type": "string", + "$ref": "#/components/schemas/flex_flow_enum_integration_type", + "description": "The software that will handle inbound messages. [Integration Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) can be: `studio`, `external`, or `task`." + }, + "Integration.FlowSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "description": "The SID of the Studio Flow. Required when `integrationType` is `studio`." + }, + "Integration.Url": { + "type": "string", + "format": "uri", + "description": "The URL of the external webhook. Required when `integrationType` is `external`." + }, + "Integration.WorkspaceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", + "description": "The Workspace SID for a new Task. Required when `integrationType` is `task`." + }, + "Integration.WorkflowSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WW[0-9a-fA-F]{32}$", + "description": "The Workflow SID for a new Task. Required when `integrationType` is `task`." + }, + "Integration.Channel": { + "type": "string", + "description": "The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`." + }, + "Integration.Timeout": { + "type": "integer", + "description": "The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise." + }, + "Integration.Priority": { + "type": "integer", + "description": "The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise." + }, + "Integration.CreationOnMessage": { + "type": "boolean", + "description": "In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging." + }, + "LongLived": { + "type": "boolean", + "description": "When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`." + }, + "JanitorEnabled": { + "type": "boolean", + "description": "When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`." + }, + "Integration.RetryCount": { + "type": "integer", + "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 + } + } + } + } + } + } + }, + "delete": { + "description": "", + "tags": [ + "FlexV1FlexFlow" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Flow resource to delete.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteFlexFlow" + } + }, + "/v1/Insights/QualityManagement/Assessments": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid", - "flex_flow_sid", - "user_sid", - "task_sid" + "account_sid", + "assessment_sid", + "assessment" ], - "pathType": "list", - "mountName": "channel" + "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.", + "tags": [ + "FlexV1Assessments" + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_assessments" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offset": "0.0", + "report": true, + "weight": "1", + "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831", + "segment_id": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc", + "user_name": "Supervisor", + "user_email": "supervisor@example.com", + "answer_id": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3", + "answer_text": "Fair", + "timestamp": "1657329694199", + "assessment": { + "questionnaire": { + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Customer Experience", + "question": { + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Active listening", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Good for Training" + } + } + } + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateInsightsAssessments", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateInsightsAssessmentsRequest", + "properties": { + "CategorySid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FY[0-9a-fA-F]{32}$", + "description": "The SID of the category " + }, + "CategoryName": { + "type": "string", + "description": "The name of the category" + }, + "SegmentId": { + "type": "string", + "description": "Segment Id of the conversation" + }, + "AgentId": { + "type": "string", + "description": "The id of the Agent" + }, + "Offset": { + "type": "number", + "description": "The offset of the conversation." + }, + "MetricId": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GE[0-9a-fA-F]{32}$", + "description": "The question SID selected for assessment" + }, + "MetricName": { + "type": "string", + "description": "The question name of the assessment" + }, + "AnswerText": { + "type": "string", + "description": "The answer text selected by user" + }, + "AnswerId": { + "type": "string", + "description": "The id of the answer selected by user" + }, + "QuestionnaireSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GM[0-9a-fA-F]{32}$", + "description": "Questionnaire SID of the associated question" + } + }, + "required": [ + "CategorySid", + "CategoryName", + "SegmentId", + "AgentId", + "Offset", + "MetricId", + "MetricName", + "AnswerText", + "AnswerId", + "QuestionnaireSid" + ] + }, + "examples": { + "create": { + "value": { + "CategorySid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CategoryName": "Good for Training", + "SegmentId": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc", + "AgentId": "583fcaa6-a4ef-5447-9077-900421e37a61", + "Offset": "6.985619", + "MetricId": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "MetricName": "Active listening", + "AnswerId": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3", + "AnswerText": "Fair", + "QuestionnaireSid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + } }, "get": { - "description": "", + "description": "Get assessments done for a conversation by logged in user", + "tags": [ + "FlexV1Assessments" + ], "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + }, + { + "name": "SegmentId", + "in": "query", + "description": "The id of the segment.", + "schema": { + "type": "string" + }, + "examples": { + "readBySegmentId": { + "value": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc" + }, + "readEmpty": { + "value": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc" + } + } + }, { "name": "PageSize", "in": "query", @@ -1312,25 +4046,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListChannelResponse", + "title": "ListInsightsAssessmentsResponse", "properties": { - "flex_chat_channels": { + "assessments": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.channel" + "$ref": "#/components/schemas/flex.v1.insights_assessments" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1339,17 +4075,75 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readBySegmentId": { + "value": { + "assessments": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offset": "0.0", + "report": true, + "weight": "1", + "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831", + "segment_id": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc", + "user_name": "Supervisor", + "user_email": "supervisor@example.com", + "answer_id": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3", + "answer_text": "Fair", + "timestamp": "1657329694199", + "assessment": { + "questionnaire": { + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Customer Experience", + "question": { + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Active listening", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Good for Training" + } + } + } + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0", + "key": "assessments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "assessments": [], + "meta": { + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0", + "key": "assessments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0" } } } @@ -1364,23 +4158,95 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", + "operationId": "ListInsightsAssessments" + } + }, + "/v1/Insights/QualityManagement/Assessments/{AssessmentSid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "account_sid", + "assessment_sid", + "assessment" + ], + "className": "assessments", + "pathType": "instance" + }, + "post": { + "description": "Update a specific Assessment assessed earlier", + "tags": [ + "FlexV1Assessments" + ], + "parameters": [ + { + "name": "AssessmentSid", + "in": "path", + "description": "The SID of the assessment to be modified", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FM[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.channel" + "$ref": "#/components/schemas/flex.v1.insights_assessments" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offset": "0.0", + "report": true, + "weight": "1", + "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831", + "segment_id": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7", + "user_name": "Supervisor", + "user_email": "supervisor@example.com", + "answer_id": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3", + "answer_text": "Fair", + "timestamp": "1657329694199", + "assessment": { + "questionnaire": { + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Customer Experience", + "question": { + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Active listening", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Good for Training" + } + } + } + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -1388,119 +4254,112 @@ "accountSid_authToken": [] } ], - "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], + "operationId": "UpdateInsightsAssessments", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateChannelRequest", + "title": "UpdateInsightsAssessmentsRequest", "properties": { - "FlexFlowSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$", - "description": "The SID of the Flex Flow." - }, - "Identity": { - "type": "string", - "description": "The `identity` value that uniquely identifies the new resource's chat User." - }, - "ChatUserFriendlyName": { - "type": "string", - "description": "The chat participant's friendly name." - }, - "ChatFriendlyName": { - "type": "string", - "description": "The chat channel's friendly name." - }, - "Target": { - "type": "string", - "description": "The Target Contact Identity, for example the phone number of an SMS." - }, - "ChatUniqueName": { - "type": "string", - "description": "The chat channel's unique name." - }, - "PreEngagementData": { - "type": "string", - "description": "The pre-engagement data." + "Offset": { + "type": "number", + "description": "The offset of the conversation" }, - "TaskSid": { + "AnswerText": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WT[0-9a-fA-F]{32}$", - "description": "The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external`" + "description": "The answer text selected by user" }, - "TaskAttributes": { + "AnswerId": { "type": "string", - "description": "The Task attributes to be added for the TaskRouter Task." - }, - "LongLived": { - "type": "boolean", - "description": "Whether to create the channel as long-lived." + "description": "The id of the answer selected by user" } }, "required": [ - "FlexFlowSid", - "Identity", - "ChatUserFriendlyName", - "ChatFriendlyName" + "Offset", + "AnswerText", + "AnswerId" ] + }, + "examples": { + "update": { + "value": { + "Offset": "6.985619", + "AnswerId": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3", + "AnswerText": "Fair" + } + } } } } } } }, - "/v1/Channels/{Sid}": { + "/v1/Insights/QualityManagement/Assessments/Comments": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "Flex chat channels", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid", - "flex_flow_sid", - "user_sid", - "task_sid" + "account_sid", + "assessment_sid", + "comment" ], - "pathType": "instance", - "mountName": "channel" + "mountName": "insights_assessments_comment", + "pathType": "list" }, - "get": { - "description": "", + "post": { + "description": "To create a comment assessment for a conversation", + "tags": [ + "FlexV1InsightsAssessmentsComment" + ], "parameters": [ { - "name": "Sid", - "in": "path", - "description": "The SID of the Flex chat channel resource to fetch.", + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.channel" + "$ref": "#/components/schemas/flex.v1.insights_assessments_comment" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offset": "0.0", + "report": true, + "weight": "1", + "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831", + "segment_id": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7", + "user_name": "Linda Houghton", + "user_email": "linda.houghton@vacasa.com", + "timestamp": "1657329694199", + "comment": { + "comment": "log0zu0268", + "category": { + "category_id": "c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e", + "name": "Good for Training" + } + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -1508,66 +4367,130 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "CreateInsightsAssessmentsComment", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateInsightsAssessmentsCommentRequest", + "properties": { + "CategoryId": { + "type": "string", + "description": "The ID of the category" + }, + "CategoryName": { + "type": "string", + "description": "The name of the category" + }, + "Comment": { + "type": "string", + "description": "The Assessment comment." + }, + "SegmentId": { + "type": "string", + "description": "The id of the segment." + }, + "AgentId": { + "type": "string", + "description": "The id of the agent." + }, + "Offset": { + "type": "number", + "description": "The offset" + } + }, + "required": [ + "CategoryId", + "CategoryName", + "Comment", + "SegmentId", + "AgentId", + "Offset" + ] + }, + "examples": { + "create": { + "value": { + "CategoryId": "4b4e78e4-4f05-49e2-bf52-0973c5cde418", + "CategoryName": "Good for Training", + "Comment": "log0zu0268", + "SegmentId": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc", + "AgentId": "583fcaa6-a4ef-5447-9077-900421e37a61", + "Offset": "6.985619" + } + } + } + } + } + } }, - "delete": { - "description": "", + "get": { + "description": "To create a comment assessment for a conversation", + "tags": [ + "FlexV1InsightsAssessmentsComment" + ], "parameters": [ { - "name": "Sid", - "in": "path", - "description": "The SID of the Flex chat channel resource to delete.", + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$" + "type": "string" + } + }, + { + "name": "SegmentId", + "in": "query", + "description": "The id of the segment.", + "schema": { + "type": "string" }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ + "examples": { + "readBySegmentId": { + "value": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7" + }, + "readEmpty": { + "value": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7" + } + } + }, { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] - } - }, - "/v1/Configuration": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "Configuration for a Flex instance", - "x-twilio": { - "defaultOutputProperties": [ - "status", - "ui_language", - "ui_version", - "service_version" - ], - "pathType": "instance" - }, - "get": { - "description": "", - "parameters": [ + "name": "AgentId", + "in": "query", + "description": "The id of the agent.", + "schema": { + "type": "string" + }, + "examples": { + "readByAgentId": { + "value": "5d80ee80-7608-55df-b2b2-5ab5608b9831" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 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": "UiVersion", + "name": "PageToken", "in": "query", - "description": "The Pinned UI version of the Configuration resource to fetch.", + "description": "The page token. This is provided by the API.", "schema": { "type": "string" } @@ -1578,7 +4501,134 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.configuration" + "type": "object", + "title": "ListInsightsAssessmentsCommentResponse", + "properties": { + "comments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.insights_assessments_comment" + } + }, + "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": { + "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" + } + } + } } } }, @@ -1590,38 +4640,55 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "ListInsightsAssessmentsComment" } }, - "/v1/FlexFlows": { + "/v1/Insights/Conversations": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "Flex Flow", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid", - "friendly_name", - "channel_type", - "integration_type" + "conversation_id", + "account_id", + "segment_count", + "segments" ], - "pathType": "list", - "mountName": "flex_flow" + "mountName": "insights_conversations", + "className": "insights_conversations", + "pathType": "list" }, "get": { - "description": "", + "description": "To get conversation with segment id", + "tags": [ + "FlexV1InsightsConversations" + ], "parameters": [ { - "name": "FriendlyName", + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + }, + { + "name": "SegmentId", "in": "query", - "description": "The `friendly_name` of the Flex Flow resources to read.", + "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" + } } }, { @@ -1658,25 +4725,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListFlexFlowResponse", + "title": "ListInsightsConversationsResponse", "properties": { - "flex_flows": { + "conversations": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.flex_flow" + "$ref": "#/components/schemas/flex.v1.insights_conversations" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1685,17 +4754,69 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "conversations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFull": { + "value": { + "conversations": [ + { + "account_id": "76e4c1c3-6f93-5d08-ae66-aad4b9092f2d", + "conversation_id": "2cb2452a-c6d9-564d-b285-b5404f073031", + "segment_count": 2, + "segments": [ + { + "segment_id": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a4", + "order": 0, + "offset": 1.542, + "talk_time": 18, + "timestamp": "2022-05-11T16:02:27.659Z", + "agent_name": "First Agent" + }, + { + "segment_id": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a5", + "order": 0, + "offset": 1.211, + "talk_time": 10, + "timestamp": "2022-05-21T16:02:27.659Z", + "agent_name": "Second Agent" + } + ] + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -1710,19 +4831,85 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlexFlow", - "x-maturity": [ - "GA" - ] + "operationId": "ListInsightsConversations" + } + }, + "/v1/Insights/QualityManagement/Questionnaires": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "account_sid", + "questionnaire_sid", + "name" + ], + "mountName": "insights_questionnaires", + "className": "insights_questionnaires", + "pathType": "list" }, "post": { - "description": "", + "description": "To create a Questionnaire", + "tags": [ + "FlexV1InsightsQuestionnaires" + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.flex_flow" + "$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" + } + } } } }, @@ -1734,143 +4921,114 @@ "accountSid_authToken": [] } ], - "operationId": "CreateFlexFlow", - "x-maturity": [ - "GA" - ], + "operationId": "CreateInsightsQuestionnaires", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateFlexFlowRequest", + "title": "CreateInsightsQuestionnairesRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "A descriptive string that you create to describe the Flex Flow resource." - }, - "ChatServiceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "description": "The SID of the chat service." - }, - "ChannelType": { - "type": "string", - "$ref": "#/components/schemas/flex_flow_enum_channel_type", - "description": "The channel type. One of `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex widget should set the Task Channel to Programmable Chat." - }, - "ContactIdentity": { - "type": "string", - "description": "The channel contact's Identity." - }, - "Enabled": { - "type": "boolean", - "description": "Whether the new Flex Flow is enabled." - }, - "IntegrationType": { - "type": "string", - "$ref": "#/components/schemas/flex_flow_enum_integration_type", - "description": "The software that will handle inbound messages. [Integration Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) can be: `studio`, `external`, or `task`." - }, - "Integration.FlowSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "description": "The SID of the Studio Flow. Required when `integrationType` is `studio`." - }, - "Integration.Url": { - "type": "string", - "format": "uri", - "description": "The URL of the external webhook. Required when `integrationType` is `external`." - }, - "Integration.WorkspaceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "description": "The Workspace SID for a new Task. Required when `integrationType` is `task`." - }, - "Integration.WorkflowSid": { + "Name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WW[0-9a-fA-F]{32}$", - "description": "The Workflow SID for a new Task. Required when `integrationType` is `task`." + "description": "The name of this questionnaire" }, - "Integration.Channel": { + "Description": { "type": "string", - "description": "The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`." - }, - "Integration.Timeout": { - "type": "integer", - "description": "The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise." - }, - "Integration.Priority": { - "type": "integer", - "description": "The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise." - }, - "Integration.CreationOnMessage": { - "type": "boolean", - "description": "In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging." - }, - "LongLived": { - "type": "boolean", - "description": "When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`." + "description": "The description of this questionnaire" }, - "JanitorEnabled": { + "Active": { "type": "boolean", - "description": "When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`." + "description": "The flag to enable or disable questionnaire" }, - "Integration.RetryCount": { - "type": "integer", - "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." + "QuestionSids": { + "type": "array", + "items": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GE[0-9a-fA-F]{32}$" + }, + "description": "The list of questions sids under a questionnaire" } }, "required": [ - "FriendlyName", - "ChatServiceSid", - "ChannelType" + "Name" ] - } - } - } - } - } - }, - "/v1/FlexFlows/{Sid}": { - "servers": [ - { - "url": "https://flex-api.twilio.com" + }, + "examples": { + "create": { + "value": { + "Name": "abc", + "Description": "description", + "Active": false, + "QuestionSids": [ + "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] + } + } + } + } + } } - ], - "description": "Flex Flow", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "friendly_name", - "channel_type", - "integration_type" - ], - "pathType": "instance", - "mountName": "flex_flow" }, "get": { - "description": "", + "description": "To get all questionnaires with questions", + "tags": [ + "FlexV1InsightsQuestionnaires" + ], "parameters": [ { - "name": "Sid", - "in": "path", - "description": "The SID of the Flex Flow resource to fetch.", + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$" + "type": "string" + } + }, + { + "name": "IncludeInactive", + "in": "query", + "description": "Flag indicating whether to include inactive questionnaires or not", + "schema": { + "type": "boolean" }, - "required": true + "examples": { + "readEmpty": { + "value": true + }, + "readFull": { + "value": 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": { @@ -1878,7 +5036,196 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.flex_flow" + "type": "object", + "title": "ListInsightsQuestionnairesResponse", + "properties": { + "questionnaires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + } + }, + "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": { + "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" + } + } + } } } }, @@ -1890,25 +5237,51 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlexFlow", - "x-maturity": [ - "GA" - ] + "operationId": "ListInsightsQuestionnaires" + } + }, + "/v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "account_sid", + "questionnaire_sid", + "name" + ], + "mountName": "insights_questionnaires", + "className": "insights_questionnaires", + "pathType": "instance" }, "post": { - "description": "", + "description": "To update the questionnaire", + "tags": [ + "FlexV1InsightsQuestionnaires" + ], "parameters": [ { - "name": "Sid", + "name": "QuestionnaireSid", "in": "path", - "description": "The SID of the Flex Flow resource to update.", + "description": "The SID of the questionnaire", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$" + "pattern": "^GM[0-9a-fA-F]{32}$" }, "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } } ], "responses": { @@ -1916,7 +5289,45 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.flex_flow" + "$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" + } + } } } }, @@ -1928,99 +5339,51 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateFlexFlow", - "x-maturity": [ - "GA" - ], + "operationId": "UpdateInsightsQuestionnaires", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateFlexFlowRequest", + "title": "UpdateInsightsQuestionnairesRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "A descriptive string that you create to describe the Flex Flow resource." - }, - "ChatServiceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "description": "The SID of the chat service." - }, - "ChannelType": { - "type": "string", - "$ref": "#/components/schemas/flex_flow_enum_channel_type", - "description": "The channel type. One of `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex widget should set the Task Channel to Programmable Chat." - }, - "ContactIdentity": { - "type": "string", - "description": "The channel contact's Identity." - }, - "Enabled": { + "Active": { "type": "boolean", - "description": "Whether the new Flex Flow is enabled." - }, - "IntegrationType": { - "type": "string", - "$ref": "#/components/schemas/flex_flow_enum_integration_type", - "description": "The software that will handle inbound messages. [Integration Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) can be: `studio`, `external`, or `task`." - }, - "Integration.FlowSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "description": "The SID of the Studio Flow. Required when `integrationType` is `studio`." - }, - "Integration.Url": { - "type": "string", - "format": "uri", - "description": "The URL of the external webhook. Required when `integrationType` is `external`." - }, - "Integration.WorkspaceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "description": "The Workspace SID for a new Task. Required when `integrationType` is `task`." + "description": "The flag to enable or disable questionnaire" }, - "Integration.WorkflowSid": { + "Name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WW[0-9a-fA-F]{32}$", - "description": "The Workflow SID for a new Task. Required when `integrationType` is `task`." + "description": "The name of this questionnaire" }, - "Integration.Channel": { + "Description": { "type": "string", - "description": "The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`." - }, - "Integration.Timeout": { - "type": "integer", - "description": "The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise." - }, - "Integration.Priority": { - "type": "integer", - "description": "The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise." - }, - "Integration.CreationOnMessage": { - "type": "boolean", - "description": "In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging." - }, - "LongLived": { - "type": "boolean", - "description": "When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`." - }, - "JanitorEnabled": { - "type": "boolean", - "description": "When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`." + "description": "The description of this questionnaire" }, - "Integration.RetryCount": { - "type": "integer", - "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." + "QuestionSids": { + "type": "array", + "items": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GE[0-9a-fA-F]{32}$" + }, + "description": "The list of questions sids under a questionnaire" + } + }, + "required": [ + "Active" + ] + }, + "examples": { + "update": { + "value": { + "Name": "abc", + "Description": "description", + "Active": true, + "QuestionSids": [ + "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] } } } @@ -2029,19 +5392,30 @@ } }, "delete": { - "description": "", + "description": "To delete the questionnaire", + "tags": [ + "FlexV1InsightsQuestionnaires" + ], "parameters": [ { - "name": "Sid", + "name": "QuestionnaireSid", "in": "path", - "description": "The SID of the Flex Flow resource to delete.", + "description": "The SID of the questionnaire", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$" + "pattern": "^GM[0-9a-fA-F]{32}$" }, "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } } ], "responses": { @@ -2054,30 +5428,114 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFlexFlow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInsightsQuestionnaires" + }, + "get": { + "description": "To get the Questionnaire Detail", + "tags": [ + "FlexV1InsightsQuestionnaires" + ], + "parameters": [ + { + "name": "QuestionnaireSid", + "in": "path", + "description": "The SID of the questionnaire", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GM[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "efg", + "description": "description", + "active": true, + "questions": [ + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + }, + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + } + ], + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchInsightsQuestionnaires" } }, - "/v1/Insights/QualityManagement/Assessments": { + "/v1/Insights/QualityManagement/Categories": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", - "assessment_sid", - "assessment" + "category_sid", + "name" ], - "pathType": "list", - "className": "assessments" + "mountName": "insights_questionnaires_category", + "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.", + "description": "To create a category for Questions", + "tags": [ + "FlexV1InsightsQuestionnairesCategory" + ], "parameters": [ { "name": "Authorization", @@ -2093,7 +5551,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_assessments" + "$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" + } + } } } }, @@ -2105,86 +5573,39 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsAssessments", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateInsightsQuestionnairesCategory", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInsightsAssessmentsRequest", + "title": "CreateInsightsQuestionnairesCategoryRequest", "properties": { - "CategorySid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FY[0-9a-fA-F]{32}$", - "description": "The SID of the category " - }, - "CategoryName": { - "type": "string", - "description": "The name of the category" - }, - "SegmentId": { - "type": "string", - "description": "Segment Id of the conversation" - }, - "AgentId": { - "type": "string", - "description": "The id of the Agent" - }, - "Offset": { - "type": "number", - "description": "The offset of the conversation." - }, - "MetricId": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^GE[0-9a-fA-F]{32}$", - "description": "The question SID selected for assessment" - }, - "MetricName": { - "type": "string", - "description": "The question name of the assessment" - }, - "AnswerText": { - "type": "string", - "description": "The answer text selected by user" - }, - "AnswerId": { - "type": "string", - "description": "The id of the answer selected by user" - }, - "QuestionnaireSid": { + "Name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^GM[0-9a-fA-F]{32}$", - "description": "Questionnaire SID of the associated question" + "description": "The name of this category." } }, "required": [ - "CategorySid", - "CategoryName", - "SegmentId", - "AgentId", - "Offset", - "MetricId", - "MetricName", - "AnswerText", - "AnswerId", - "QuestionnaireSid" + "Name" ] + }, + "examples": { + "create": { + "value": { + "Name": "abc" + } + } } } } } }, "get": { - "description": "Get assessments done for a conversation by logged in user", + "description": "To get all the categories", + "tags": [ + "FlexV1InsightsQuestionnairesCategory" + ], "parameters": [ { "name": "Authorization", @@ -2194,14 +5615,6 @@ "type": "string" } }, - { - "name": "SegmentId", - "in": "query", - "description": "The id of the segment.", - "schema": { - "type": "string" - } - }, { "name": "PageSize", "in": "query", @@ -2236,25 +5649,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListInsightsAssessmentsResponse", + "title": "ListInsightsQuestionnairesCategoryResponse", "properties": { - "assessments": { + "categories": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.insights_assessments" + "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2263,17 +5678,52 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "categories": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0", + "next_page_url": null, + "key": "categories" + } + } + }, + "readFull": { + "value": { + "categories": [ + { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Test1", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0", + "next_page_url": null, + "key": "categories" } } } @@ -2288,40 +5738,40 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsAssessments", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsQuestionnairesCategory" } }, - "/v1/Insights/QualityManagement/Assessments/{AssessmentSid}": { + "/v1/Insights/QualityManagement/Categories/{CategorySid}": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", - "assessment_sid", - "assessment" + "category_sid", + "name" ], - "pathType": "instance", - "className": "assessments" + "mountName": "insights_questionnaires_category", + "pathType": "instance" }, "post": { - "description": "Update a specific Assessment assessed earlier", + "description": "To update the category for Questions", + "tags": [ + "FlexV1InsightsQuestionnairesCategory" + ], "parameters": [ { - "name": "AssessmentSid", + "name": "CategorySid", "in": "path", - "description": "The SID of the assessment to be modified", + "description": "The SID of the category to be updated", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^FM[0-9a-fA-F]{32}$" + "pattern": "^FY[0-9a-fA-F]{32}$" }, "required": true }, @@ -2339,7 +5789,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_assessments" + "$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" + } + } } } }, @@ -2351,59 +5811,95 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInsightsAssessments", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateInsightsQuestionnairesCategory", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateInsightsAssessmentsRequest", + "title": "UpdateInsightsQuestionnairesCategoryRequest", "properties": { - "Offset": { - "type": "number", - "description": "The offset of the conversation" - }, - "AnswerText": { - "type": "string", - "description": "The answer text selected by user" - }, - "AnswerId": { + "Name": { "type": "string", - "description": "The id of the answer selected by user" + "description": "The name of this category." } }, "required": [ - "Offset", - "AnswerText", - "AnswerId" + "Name" ] + }, + "examples": { + "update": { + "value": { + "Name": "abcd" + } + } } } } - } + } + }, + "delete": { + "description": "", + "tags": [ + "FlexV1InsightsQuestionnairesCategory" + ], + "parameters": [ + { + "name": "CategorySid", + "in": "path", + "description": "The SID of the category to be deleted", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FY[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteInsightsQuestionnairesCategory" } }, - "/v1/Insights/QualityManagement/Assessments/Comments": { + "/v1/Insights/QualityManagement/Questions": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", - "assessment_sid", - "comment" + "question_sid", + "question" ], - "pathType": "list", - "mountName": "insights_assessments_comment" + "mountName": "insights_questionnaires_question", + "pathType": "list" }, "post": { - "description": "To create a comment assessment for a conversation", + "description": "To create a question for a Category", + "tags": [ + "FlexV1InsightsQuestionnairesQuestion" + ], "parameters": [ { "name": "Authorization", @@ -2419,7 +5915,48 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_assessments_comment" + "$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" + } + } } } }, @@ -2431,57 +5968,65 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsAssessmentsComment", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateInsightsQuestionnairesQuestion", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInsightsAssessmentsCommentRequest", + "title": "CreateInsightsQuestionnairesQuestionRequest", "properties": { - "CategoryId": { + "CategorySid": { "type": "string", - "description": "The ID of the category" + "minLength": 34, + "maxLength": 34, + "pattern": "^FY[0-9a-fA-F]{32}$", + "description": "The SID of the category" }, - "CategoryName": { + "Question": { "type": "string", - "description": "The name of the category" + "description": "The question." }, - "Comment": { + "AnswerSetId": { "type": "string", - "description": "The Assessment comment." + "description": "The answer_set for the question." }, - "SegmentId": { - "type": "string", - "description": "The id of the segment." + "AllowNa": { + "type": "boolean", + "description": "The flag to enable for disable NA for answer." }, - "AgentId": { + "Description": { "type": "string", - "description": "The id of the agent." - }, - "Offset": { - "type": "number", - "description": "The offset" + "description": "The description for the question." } }, "required": [ - "CategoryId", - "CategoryName", - "Comment", - "SegmentId", - "AgentId", - "Offset" + "CategorySid", + "Question", + "AnswerSetId", + "AllowNa" ] + }, + "examples": { + "create": { + "value": { + "CategorySid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Question": "What is the total time", + "Description": "time spent", + "AnswerSetId": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "AllowNa": false + } + } } } } } }, "get": { - "description": "To create a comment assessment for a conversation", + "description": "To get all the question for the given categories", + "tags": [ + "FlexV1InsightsQuestionnairesQuestion" + ], "parameters": [ { "name": "Authorization", @@ -2492,19 +6037,31 @@ } }, { - "name": "SegmentId", - "in": "query", - "description": "The id of the segment.", - "schema": { - "type": "string" - } - }, - { - "name": "AgentId", + "name": "CategorySid", "in": "query", - "description": "The id of the agent.", + "description": "The list of category SIDs", "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FY[0-9a-fA-F]{32}$" + } + }, + "examples": { + "readEmpty": { + "value": [ + "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] + }, + "readFull": { + "value": [ + "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] + } } }, { @@ -2541,25 +6098,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListInsightsAssessmentsCommentResponse", + "title": "ListInsightsQuestionnairesQuestionResponse", "properties": { - "comments": { + "questions": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.insights_assessments_comment" + "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2568,17 +6127,83 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "questions": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "questions" + } + } + }, + "readFull": { + "value": { + "questions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "question": "What is the total time", + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "time spent", + "category": { + "category_name": "test cat", + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0, + "answer_set": { + "sort": 0, + "name": "Yes, No", + "answers": [ + { + "sort": 0, + "score": 100, + "description": "Yes.", + "name": "Yes", + "id": "4e34f701-8206-4670-b376-c9fe26bb3ca3" + }, + { + "sort": 1, + "score": 0, + "description": "No or a very poor.", + "name": "No", + "id": "5e926651-fa5d-4aba-86e1-8440bb8faa6c" + } + ], + "category_id": "1a8cac56-826c-4f85-ac14-9104811cf184", + "type": "select", + "id": "a6a8a54f-5305-4aec-b92c-a6e429932f58" + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "questions" } } } @@ -2593,32 +6218,224 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsAssessmentsComment", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsQuestionnairesQuestion" + } + }, + "/v1/Insights/QualityManagement/Questions/{QuestionSid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "account_sid", + "question_sid", + "question" + ], + "mountName": "insights_questionnaires_question", + "pathType": "instance" + }, + "post": { + "description": "To update the question", + "tags": [ + "FlexV1InsightsQuestionnairesQuestion" + ], + "parameters": [ + { + "name": "QuestionSid", + "in": "path", + "description": "The SID of the question", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GE[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "question": "What is the total time", + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "time spent", + "category": { + "category_name": "test cat", + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0, + "answer_set": { + "sort": 0, + "name": "Yes, No", + "answers": [ + { + "sort": 0, + "score": 100, + "description": "Yes.", + "name": "Yes", + "id": "4e34f701-8206-4670-b376-c9fe26bb3ca3" + }, + { + "sort": 1, + "score": 0, + "description": "No or a very poor.", + "name": "No", + "id": "5e926651-fa5d-4aba-86e1-8440bb8faa6c" + } + ], + "category_id": "1a8cac56-826c-4f85-ac14-9104811cf184", + "type": "select", + "id": "a6a8a54f-5305-4aec-b92c-a6e429932f58" + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateInsightsQuestionnairesQuestion", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateInsightsQuestionnairesQuestionRequest", + "properties": { + "AllowNa": { + "type": "boolean", + "description": "The flag to enable for disable NA for answer." + }, + "CategorySid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FY[0-9a-fA-F]{32}$", + "description": "The SID of the category" + }, + "Question": { + "type": "string", + "description": "The question." + }, + "Description": { + "type": "string", + "description": "The description for the question." + }, + "AnswerSetId": { + "type": "string", + "description": "The answer_set for the question." + } + }, + "required": [ + "AllowNa" + ] + }, + "examples": { + "update": { + "value": { + "Question": "What is the total time", + "Description": "time spent", + "AnswerSetId": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "AllowNa": false + } + } + } + } + } + } + }, + "delete": { + "description": "", + "tags": [ + "FlexV1InsightsQuestionnairesQuestion" + ], + "parameters": [ + { + "name": "QuestionSid", + "in": "path", + "description": "The SID of the question", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GE[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteInsightsQuestionnairesQuestion" } }, - "/v1/Insights/Conversations": { + "/v1/Insights/Segments": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "conversation_id", + "segment_id", + "external_id", "account_id", - "segment_count", - "segments" + "agent_id", + "queue" ], - "pathType": "list", - "mountName": "insights_conversations", - "className": "insights_conversations" + "mountName": "insights_segments", + "className": "insights_segments", + "pathType": "list" }, "get": { - "description": "To get conversation with segment id", + "description": "To get segments for given reservation Ids", + "tags": [ + "FlexV1InsightsSegments" + ], "parameters": [ { "name": "Authorization", @@ -2631,9 +6448,42 @@ { "name": "SegmentId", "in": "query", - "description": "Unique Id of the segment for which conversation details needs to be fetched", + "description": "To unique id of the segment", "schema": { "type": "string" + }, + "examples": { + "readBySegmentId": { + "value": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a5" + } + } + }, + { + "name": "ReservationId", + "in": "query", + "description": "The list of reservation Ids", + "schema": { + "type": "array", + "items": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WR[0-9a-fA-F]{32}$" + } + }, + "examples": { + "readEmpty": { + "value": [ + "WReeeff42d5326cfdaa0f7a1181d00f1b1", + "WReeeff42d5326cfdaa0f7a1181d00f1b2" + ] + }, + "readByReservationIds": { + "value": [ + "WReeeff42d5326cfdaa0f7a1181d00f1b1", + "WReeeff42d5326cfdaa0f7a1181d00f1b2" + ] + } } }, { @@ -2670,25 +6520,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListInsightsConversationsResponse", + "title": "ListInsightsSegmentsResponse", "properties": { - "conversations": { + "segments": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.insights_conversations" + "$ref": "#/components/schemas/flex.v1.insights_segments" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2697,17 +6549,117 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "segments": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0", + "next_page_url": null, + "key": "segments" + } + } + }, + "readByReservationIds": { + "value": { + "segments": [ + { + "segment_id": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a5", + "external_id": "EV4ab3c50aeeb9dc48c96f7290cf626a37", + "queue": "Everyone", + "external_contact": "+13051515226", + "external_segment_link_id": null, + "date": "2022-02-08T08:00:00Z", + "account_id": "76e4c1c3-6f93-5d08-ae66-aad4b9092f2d", + "external_segment_link": null, + "agent_id": "0e4a8059-18a3-5e48-9efb-29ae3213e7fe", + "agent_phone": "+13051515226", + "agent_name": "Flex Insights", + "agent_team_name": "Everyone", + "agent_team_name_in_hierarchy": "Everyone", + "agent_link": null, + "customer_phone": "+420606078007", + "customer_name": "+420606078007", + "customer_link": null, + "segment_recording_offset": null, + "media": null, + "assessment_type": [ + null + ], + "assessment_percentage": [ + null + ], + "url": "https://flex-api.twilio.com/v1/Insights/Segments/02dd8a65-c9e3-550b-9e98-5b11abb9b3a5" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0", + "next_page_url": null, + "key": "segments" + } + } + }, + "readBySegmentId": { + "value": { + "segments": [ + { + "segment_id": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a5", + "external_id": "EV4ab3c50aeeb9dc48c96f7290cf626a37", + "queue": "Everyone", + "external_contact": "+13051515226", + "external_segment_link_id": null, + "date": "2022-02-08T08:00:00Z", + "account_id": "76e4c1c3-6f93-5d08-ae66-aad4b9092f2d", + "external_segment_link": null, + "agent_id": "0e4a8059-18a3-5e48-9efb-29ae3213e7fe", + "agent_phone": "+13051515226", + "agent_name": "Flex Insights", + "agent_team_name": "Everyone", + "agent_team_name_in_hierarchy": "Everyone", + "agent_link": null, + "customer_phone": "+420606078007", + "customer_name": "+420606078007", + "customer_link": null, + "segment_recording_offset": null, + "media": null, + "assessment_type": [ + null + ], + "assessment_percentage": [ + null + ], + "url": "https://flex-api.twilio.com/v1/Insights/Segments/02dd8a65-c9e3-550b-9e98-5b11abb9b3a5" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/Segments?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a5&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/Segments?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a5&PageSize=50&Page=0", + "next_page_url": null, + "key": "segments" } } } @@ -2722,31 +6674,31 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsConversations", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsSegments" } }, - "/v1/Insights/QualityManagement/Questionnaires": { + "/v1/Insights/Session": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "account_sid", - "questionnaire_sid", - "name" + "workspace_id", + "session_expiry", + "session_id", + "base_url" ], - "pathType": "list", - "mountName": "insights_questionnaires", - "className": "insights_questionnaires" + "mountName": "insights_session", + "pathType": "instance" }, "post": { - "description": "To create a Questionnaire", + "description": "To obtain session details for fetching reports and dashboards", + "tags": [ + "FlexV1InsightsSession" + ], "parameters": [ { "name": "Authorization", @@ -2762,7 +6714,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + "$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" + } + } } } }, @@ -2774,50 +6737,31 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateInsightsQuestionnairesRequest", - "properties": { - "Name": { - "type": "string", - "description": "The name of this questionnaire" - }, - "Description": { - "type": "string", - "description": "The description of this questionnaire" - }, - "Active": { - "type": "boolean", - "description": "The flag to enable or disable questionnaire" - }, - "QuestionSids": { - "type": "array", - "items": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^GE[0-9a-fA-F]{32}$" - }, - "description": "The list of questions sids under a questionnaire" - } - }, - "required": [ - "Name" - ] - } - } - } + "operationId": "CreateInsightsSession" + } + }, + "/v1/Insights/QualityManagement/Settings/AnswerSets": { + "servers": [ + { + "url": "https://flex-api.twilio.com" } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "answer_sets", + "answer_set_categories", + "not_applicable" + ], + "mountName": "insights_settings_answer_sets", + "className": "insights_settings_answer_sets", + "pathType": "list" }, "get": { - "description": "To get all questionnaires with questions", + "description": "To get the Answer Set Settings for an Account", + "tags": [ + "FlexV1InsightsSettingsAnswerSets" + ], "parameters": [ { "name": "Authorization", @@ -2826,38 +6770,198 @@ "schema": { "type": "string" } - }, - { - "name": "IncludeInactive", - "in": "query", - "description": "Flag indicating whether to include inactive questionnaires or not", - "schema": { - "type": "boolean" - } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_settings_answersets" + }, + "examples": { + "read": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Settings/AnswerSets", + "answer_sets": [ + { + "category_id": "1a8cac56-826c-4f85-ac14-9104811cf184", + "id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "name": "Yes, No", + "sort": 0, + "type": "select", + "answers": [ + { + "description": "Yes.", + "id": "4e34f701-8206-4670-b376-c9fe26bb3ca3", + "name": "Yes", + "score": 100, + "sort": 0 + }, + { + "description": "No or a very poor.", + "id": "5e926651-fa5d-4aba-86e1-8440bb8faa6c", + "name": "No", + "score": 0, + "sort": 1 + } + ] + }, + { + "category_id": "1a8cac56-826c-4f85-ac14-9104811cf184", + "id": "675e8803-e7ca-4002-97f6-a29490450b1b", + "name": "Good, Poor", + "sort": 1, + "type": "select", + "answers": [ + { + "description": "Good.", + "id": "5aa6c6c0-05cf-4952-b9f9-9fdbe18cc79d", + "name": "Good", + "score": 100, + "sort": 0 + }, + { + "description": "Poor.", + "id": "d19f1c36-8331-44cc-9944-e94cb39e35e9", + "name": "Poor", + "score": 0, + "sort": 1 + } + ] + } + ], + "answer_set_categories": [ + { + "id": "1a8cac56-826c-4f85-ac14-9104811cf184", + "name": "Two Options", + "sort": 1 + }, + { + "id": "10c44902-0e6e-46b6-9378-d4665348b4b7", + "name": "Three Options", + "sort": 2 + }, + { + "id": "10c44902-0e6e-46b6-9378-d4665348b4b8", + "name": "Rating", + "sort": 3 + } + ], + "not_applicable": { + "description": "Not applicable for this call", + "id": "8dc58ae1-16ae-4e17-a357-799d06230fa3", + "name": "N/A", + "score": 0, + "sort": 0 + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ { - "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 - } - }, + "accountSid_authToken": [] + } + ], + "operationId": "FetchInsightsSettingsAnswersets" + } + }, + "/v1/Insights/QualityManagement/Settings/CommentTags": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "comments" + ], + "mountName": "insights_settings_comment", + "pathType": "list" + }, + "get": { + "description": "To get the Comment Settings for an Account", + "tags": [ + "FlexV1InsightsSettingsComment" + ], + "parameters": [ { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", "schema": { - "type": "integer", - "minimum": 0 + "type": "string" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_settings_comment" + }, + "examples": { + "read": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "comments": [ + { + "default": false, + "id": "4c5ba39a-e192-4c5d-a41c-b765a833665b", + "name": "Good", + "sort": 0 + } + ], + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Settings/CommentTags" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", + "accountSid_authToken": [] + } + ], + "operationId": "FetchInsightsSettingsComment" + } + }, + "/v1/Insights/UserRoles": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "roles" + ], + "mountName": "insights_user_roles", + "className": "insights_user_roles", + "pathType": "instance" + }, + "get": { + "description": "This is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user", + "tags": [ + "FlexV1InsightsUserRoles" + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", "schema": { "type": "string" } @@ -2868,46 +6972,15 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListInsightsQuestionnairesResponse", - "properties": { - "questionnaires": { - "type": "array", - "items": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } + "$ref": "#/components/schemas/flex.v1.insights_user_roles" + }, + "examples": { + "fetch": { + "value": { + "roles": [ + "wfo.full_access" + ], + "url": "https://flex-api.twilio.com/v1/Insights/UserRoles" } } } @@ -2921,51 +6994,48 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchInsightsUserRoles" } }, - "/v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}": { + "/v1/Interactions/{Sid}": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "account_sid", - "questionnaire_sid", - "name" + "sid" ], - "pathType": "instance", - "mountName": "insights_questionnaires", - "className": "insights_questionnaires" + "dependentProperties": { + "channels": { + "mapping": { + "interaction_sid": "sid" + }, + "resource_url": "/v1/Interactions/{interaction_sid}/Channels" + } + }, + "mountName": "interaction", + "pathType": "instance" }, - "post": { - "description": "To update the questionnaire", + "get": { + "description": "", + "tags": [ + "FlexV1Interaction" + ], "parameters": [ { - "name": "QuestionnaireSid", + "name": "Sid", "in": "path", - "description": "The SID of the questionnaire", + "description": "The SID of the Interaction resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^GM[0-9a-fA-F]{32}$" + "pattern": "^KD[0-9a-fA-F]{32}$" }, "required": true - }, - { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { @@ -2973,7 +7043,32 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + "$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" + } + } + } } } }, @@ -2985,109 +7080,197 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInsightsQuestionnaires", - "x-maturity": [ - "Preview" + "operationId": "FetchInteraction" + } + }, + "/v1/Interactions": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid" + ], + "dependentProperties": { + "channels": { + "mapping": { + "interaction_sid": "sid" + }, + "resource_url": "/v1/Interactions/{interaction_sid}/Channels" + } + }, + "mountName": "interaction", + "pathType": "list" + }, + "post": { + "description": "Create a new Interaction.", + "tags": [ + "FlexV1Interaction" + ], + "responses": { + "201": { + "content": { + "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" + } + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } ], + "operationId": "CreateInteraction", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateInsightsQuestionnairesRequest", + "title": "CreateInteractionRequest", "properties": { - "Active": { - "type": "boolean", - "description": "The flag to enable or disable questionnaire" + "Channel": { + "description": "The Interaction's channel." }, - "Name": { - "type": "string", - "description": "The name of this questionnaire" + "Routing": { + "description": "The Interaction's routing logic." }, - "Description": { + "InteractionContextSid": { "type": "string", - "description": "The description of this questionnaire" - }, - "QuestionSids": { - "type": "array", - "items": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^GE[0-9a-fA-F]{32}$" - }, - "description": "The list of questions sids under a questionnaire" + "minLength": 34, + "maxLength": 34, + "pattern": "^HQ[0-9a-fA-F]{32}$", + "description": "The Interaction context sid is used for adding a context lookup sid" } }, "required": [ - "Active" + "Channel", + "Routing" ] + }, + "examples": { + "create": { + "value": { + "Channel": "{\"type\":\"sms\",\"initiated_by\":\"customer\"}", + "Routing": "{}", + "InteractionContextSid": "interaction_context_sid" + } + } } } } } + } + }, + "/v1/Interactions/{InteractionSid}/Channels/{Sid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid" + ], + "dependentProperties": { + "invites": { + "mapping": { + "interaction_sid": "interaction_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Invites" + }, + "participants": { + "mapping": { + "interaction_sid": "interaction_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Participants" + } + }, + "parent": "/Interactions/{Sid}", + "className": "interaction_channel", + "pathType": "instance" }, - "delete": { - "description": "To delete the questionnaire", + "get": { + "description": "Fetch a Channel for an Interaction.", + "tags": [ + "FlexV1InteractionChannel" + ], "parameters": [ { - "name": "QuestionnaireSid", + "name": "InteractionSid", "in": "path", - "description": "The SID of the questionnaire", + "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^GM[0-9a-fA-F]{32}$" + "pattern": "^KD[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ] - }, - "get": { - "description": "To get the Questionnaire Detail", - "parameters": [ - { - "name": "QuestionnaireSid", + "name": "Sid", "in": "path", - "description": "The SID of the questionnaire", + "description": "The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^GM[0-9a-fA-F]{32}$" + "pattern": "^UO[0-9a-fA-F]{32}$" }, "required": true - }, - { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { @@ -3095,7 +7278,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + "$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" + } + } + } } } }, @@ -3107,50 +7307,96 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Insights/QualityManagement/Categories": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "account_sid", - "category_sid", - "name" - ], - "pathType": "list", - "mountName": "insights_questionnaires_category" + "operationId": "FetchInteractionChannel" }, "post": { - "description": "To create a category for Questions", + "description": "Update an existing Interaction Channel.", + "tags": [ + "FlexV1InteractionChannel" + ], "parameters": [ { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "InteractionSid", + "in": "path", + "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KD[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" + "$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" + } + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -3158,40 +7404,98 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateInteractionChannel", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInsightsQuestionnairesCategoryRequest", + "title": "UpdateInteractionChannelRequest", "properties": { - "Name": { + "Status": { "type": "string", - "description": "The name of this category." + "$ref": "#/components/schemas/interaction_channel_enum_update_channel_status", + "description": "Required. Indicates the Interaction channel's status. When a channel is set to `closed`, all tasks are put in the `wrapping` state by default unless the Routing status is set to `closed` in which case the tasks will be `completed`. When a channel is set to `inactive`, it is mandatory to set the Routing status as `closed` else the request will be invalid. Value: `closed`, `inactive`" + }, + "Routing": { + "description": "It changes the state of associated tasks. Routing status is required, When the channel status is set to `inactive`. Allowed Value for routing status is `closed`. Otherwise Optional, if not specified, all tasks will be set to `wrapping`." } }, "required": [ - "Name" + "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "closed" + } + }, + "updateStatusClosed": { + "value": { + "Status": "closed" + } + }, + "updateStatusInactive": { + "value": { + "Status": "inactive", + "Routing": "{\"status\":\"closed\"}" + } + } } } } } + } + }, + "/v1/Interactions/{InteractionSid}/Channels": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid" + ], + "dependentProperties": { + "invites": { + "mapping": { + "interaction_sid": "interaction_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Invites" + }, + "participants": { + "mapping": { + "interaction_sid": "interaction_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Participants" + } + }, + "parent": "/Interactions/{Sid}", + "className": "interaction_channel", + "pathType": "list" }, "get": { - "description": "To get all the categories", + "description": "List all Channels for an Interaction.", + "tags": [ + "FlexV1InteractionChannel" + ], "parameters": [ { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "InteractionSid", + "in": "path", + "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KD[0-9a-fA-F]{32}$" + }, + "required": true }, { "name": "PageSize", @@ -3227,25 +7531,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListInsightsQuestionnairesCategoryResponse", + "title": "ListInteractionChannelResponse", "properties": { - "categories": { + "channels": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3254,17 +7560,97 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "channels": [ + { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "type": "chat", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "closed", + "error_code": 19025, + "error_message": "Channel validation error", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites" + } + }, + { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2", + "type": "sms", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "error_code": null, + "error_message": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2/Invites" + } + }, + { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3", + "type": "email", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 19025, + "error_message": "Channel validation error", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3/Invites" + } + }, + { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4", + "type": "voice", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "setup", + "error_code": null, + "error_message": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4/Invites" + } + }, + { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5", + "type": "gbm", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 19025, + "error_message": "Channel validation error", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5/Invites" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" } } } @@ -3279,62 +7665,102 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInteractionChannel" } }, - "/v1/Insights/QualityManagement/Categories/{CategorySid}": { + "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "account_sid", - "category_sid", - "name" + "sid" ], - "pathType": "instance", - "mountName": "insights_questionnaires_category" + "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", + "className": "interaction_channel_invite", + "pathType": "list" }, "post": { - "description": "To update the category for Questions", + "description": "Invite an Agent or a TaskQueue to a Channel.", + "tags": [ + "FlexV1InteractionChannelInvite" + ], "parameters": [ { - "name": "CategorySid", + "name": "InteractionSid", "in": "path", - "description": "The SID of the category to be updated", + "description": "The Interaction SID for this Channel.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^FY[0-9a-fA-F]{32}$" + "pattern": "^KD[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "ChannelSid", + "in": "path", + "description": "The Channel SID for this Invite.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite" + }, + "examples": { + "create": { + "value": { + "sid": "KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "routing": { + "reservation": null, + "properties": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": 1634845217, + "date_updated": 1634845217, + "attributes": "{\"customerAddress\":\"customer phone address\",\"flexChannelInviteSid\":\"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"conversationSid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"channelType\":\"sms\",\"customers\":{\"phone\":\"customer phone address\",\"name\":\"customer name\"},\"conversations\":{\"conversation_id\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"media\":[{\"type\":\"ChatTranscript\",\"sid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}]},\"customerName\":\"customer name\",\"flexInteractionChannelSid\":\"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"flexInteractionSid\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}", + "assignment_status": "pending", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_name": "Default Fifo Workflow", + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "queue_name": "Sample Queue", + "priority": 0, + "age": 0, + "reason": "", + "timeout": 86400, + "assignmentCounter": 0, + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_entered_date": 1634845217, + "age_in_queue": 0, + "addons": "{}" + } + }, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -3342,57 +7768,225 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateInteractionChannelInvite", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateInsightsQuestionnairesCategoryRequest", + "title": "CreateInteractionChannelInviteRequest", "properties": { - "Name": { - "type": "string", - "description": "The name of this category." + "Routing": { + "description": "The Interaction's routing logic." } }, "required": [ - "Name" + "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\"}}}" + } + } } } } } }, - "delete": { - "description": "", + "get": { + "description": "List all Invites for a Channel.", + "tags": [ + "FlexV1InteractionChannelInvite" + ], "parameters": [ { - "name": "CategorySid", + "name": "InteractionSid", "in": "path", - "description": "The SID of the category to be deleted", + "description": "The Interaction SID for this Channel.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^FY[0-9a-fA-F]{32}$" + "pattern": "^KD[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "ChannelSid", + "in": "path", + "description": "The Channel SID for this Participant.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[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": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListInteractionChannelInviteResponse", + "properties": { + "invites": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite" + } + }, + "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": { + "read": { + "value": { + "invites": [ + { + "sid": "KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "routing": { + "reservation": null, + "properties": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": 1634845217, + "date_updated": 1634845217, + "attributes": "{\"customerAddress\":\"customer phone address\",\"flexChannelInviteSid\":\"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"conversationSid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"channelType\":\"sms\",\"customers\":{\"phone\":\"customer phone address\",\"name\":\"customer name\"},\"conversations\":{\"conversation_id\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"media\":[{\"type\":\"ChatTranscript\",\"sid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}]},\"customerName\":\"customer name\",\"flexInteractionChannelSid\":\"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"flexInteractionSid\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}", + "assignment_status": "pending", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_name": "Default Fifo Workflow", + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "queue_name": "Sample Queue", + "priority": 0, + "age": 0, + "reason": "", + "timeout": 86400, + "assignmentCounter": 0, + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_entered_date": 1634845217, + "age_in_queue": 0, + "addons": "{}" + } + }, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1" + }, + { + "sid": "KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "routing": { + "reservation": null, + "properties": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": 1634845217, + "date_updated": 1634845217, + "attributes": "{\"customerAddress\":\"customer phone address\",\"flexChannelInviteSid\":\"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"conversationSid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"channelType\":\"sms\",\"customers\":{\"phone\":\"customer phone address\",\"name\":\"customer name\"},\"conversations\":{\"conversation_id\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"media\":[{\"type\":\"ChatTranscript\",\"sid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}]},\"customerName\":\"customer name\",\"flexInteractionChannelSid\":\"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"flexInteractionSid\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}", + "assignment_status": "pending", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_name": "Default Fifo Workflow", + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "queue_name": "Sample Queue", + "priority": 0, + "age": 0, + "reason": "", + "timeout": 86400, + "assignmentCounter": 0, + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_entered_date": 1634845217, + "age_in_queue": 0, + "addons": "{}" + } + }, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?PageSize=50&Page=0", + "next_page_url": null, + "key": "invites" + } + } + } + } + } + }, + "description": "OK" } }, "security": [ @@ -3400,38 +7994,53 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInteractionChannelInvite" } }, - "/v1/Insights/QualityManagement/Questions": { + "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "account_sid", - "question_sid", - "question" + "sid" ], - "pathType": "list", - "mountName": "insights_questionnaires_question" + "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", + "className": "interaction_channel_participant", + "pathType": "list" }, "post": { - "description": "To create a question for a Category", + "description": "Add a Participant to a Channel.", + "tags": [ + "FlexV1InteractionChannelParticipant" + ], "parameters": [ { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "InteractionSid", + "in": "path", + "description": "The Interaction Sid for the new Channel Participant.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KD[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ChannelSid", + "in": "path", + "description": "The Channel Sid for the new Channel Participant.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -3439,7 +8048,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" + "$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" + } + } } } }, @@ -3451,76 +8076,73 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateInteractionChannelParticipant", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInsightsQuestionnairesQuestionRequest", + "title": "CreateInteractionChannelParticipantRequest", "properties": { - "CategorySid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FY[0-9a-fA-F]{32}$", - "description": "The SID of the category" - }, - "Question": { - "type": "string", - "description": "The question." - }, - "AnswerSetId": { + "Type": { "type": "string", - "description": "The answer_set for the question." + "$ref": "#/components/schemas/interaction_channel_participant_enum_type", + "description": "Participant type. Can be: `agent`, `customer`, `supervisor`, `external` or `unknown`." }, - "AllowNa": { - "type": "boolean", - "description": "The flag to enable for disable NA for answer." + "MediaProperties": { + "description": "JSON representing the Media Properties for the new Participant." }, - "Description": { - "type": "string", - "description": "The description for the question." + "RoutingProperties": { + "description": "Object representing the Routing Properties for the new Participant." } }, "required": [ - "CategorySid", - "Question", - "AnswerSetId", - "AllowNa" + "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\"}" + } + } } } } } }, "get": { - "description": "To get all the question for the given categories", + "description": "List all Participants for a Channel.", + "tags": [ + "FlexV1InteractionChannelParticipant" + ], "parameters": [ { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "InteractionSid", + "in": "path", + "description": "The Interaction Sid for this channel.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KD[0-9a-fA-F]{32}$" + }, + "required": true }, { - "name": "CategorySid", - "in": "query", - "description": "The list of category SIDs", + "name": "ChannelSid", + "in": "path", + "description": "The Channel Sid for this Participant.", "schema": { - "type": "array", - "items": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FY[0-9a-fA-F]{32}$" - } - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true }, { "name": "PageSize", @@ -3556,25 +8178,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListInsightsQuestionnairesQuestionResponse", + "title": "ListInteractionChannelParticipantResponse", "properties": { - "questions": { + "participants": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3583,17 +8207,52 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "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" } } } @@ -3608,50 +8267,65 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInteractionChannelParticipant" } }, - "/v1/Insights/QualityManagement/Questions/{QuestionSid}": { + "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "account_sid", - "question_sid", - "question" + "sid" ], - "pathType": "instance", - "mountName": "insights_questionnaires_question" + "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", + "className": "interaction_channel_participant", + "pathType": "instance" }, "post": { - "description": "To update the question", + "description": "Update an existing Channel Participant.", + "tags": [ + "FlexV1InteractionChannelParticipant" + ], "parameters": [ { - "name": "QuestionSid", + "name": "InteractionSid", "in": "path", - "description": "The SID of the question", + "description": "The Interaction Sid for this channel.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^GE[0-9a-fA-F]{32}$" + "pattern": "^KD[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "ChannelSid", + "in": "path", + "description": "The Channel Sid for this Participant.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The unique string created by Twilio to identify an Interaction Channel resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UT[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -3659,7 +8333,37 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" + "$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" + } + } } } }, @@ -3671,141 +8375,78 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateInteractionChannelParticipant", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateInsightsQuestionnairesQuestionRequest", + "title": "UpdateInteractionChannelParticipantRequest", "properties": { - "AllowNa": { - "type": "boolean", - "description": "The flag to enable for disable NA for answer." - }, - "CategorySid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FY[0-9a-fA-F]{32}$", - "description": "The SID of the category" - }, - "Question": { - "type": "string", - "description": "The question." - }, - "Description": { - "type": "string", - "description": "The description for the question." - }, - "AnswerSetId": { + "Status": { "type": "string", - "description": "The answer_set for the question." + "$ref": "#/components/schemas/interaction_channel_participant_enum_status", + "description": "The Participant's status. Can be: `closed` or `wrapup`. Participant must be an agent." } }, "required": [ - "AllowNa" + "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "closed" + } + }, + "updateStatusClosed": { + "value": { + "Status": "closed" + } + } } } } - } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "QuestionSid", - "in": "path", - "description": "The SID of the question", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^GE[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ] + } } }, - "/v1/Insights/Segments": { + "/v1/PluginService/Plugins": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "segment_id", - "external_id", - "account_id", - "agent_id", - "queue" + "sid", + "unique_name", + "friendly_name" ], - "pathType": "list", - "mountName": "insights_segments", - "className": "insights_segments" + "dependentProperties": { + "plugin_versions": { + "mapping": { + "plugin_sid": "sid" + }, + "resource_url": "/v1/PluginService/Plugins/{plugin_sid}/Versions" + } + }, + "pathType": "list" }, "get": { - "description": "To get segments for given reservation Ids", + "description": "", + "tags": [ + "FlexV1Plugin" + ], "parameters": [ { - "name": "Authorization", + "name": "Flex-Metadata", "in": "header", - "description": "The Authorization HTTP request header", - "schema": { - "type": "string" - } - }, - { - "name": "SegmentId", - "in": "query", - "description": "To unique id of the segment", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } }, - { - "name": "ReservationId", - "in": "query", - "description": "The list of reservation Ids", - "schema": { - "type": "array", - "items": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WR[0-9a-fA-F]{32}$" - } - } - }, { "name": "PageSize", "in": "query", @@ -3840,25 +8481,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListInsightsSegmentsResponse", + "title": "ListPluginResponse", "properties": { - "segments": { + "plugins": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.insights_segments" + "$ref": "#/components/schemas/flex.v1.plugin" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3867,17 +8510,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "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" } } } @@ -3892,36 +8578,18 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsSegments", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Insights/Session": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "workspace_id", - "session_expiry", - "session_id", - "base_url" - ], - "pathType": "instance", - "mountName": "insights_session" + "operationId": "ListPlugin" }, "post": { - "description": "To obtain session details for fetching reports and dashboards", + "description": "", + "tags": [ + "FlexV1Plugin" + ], "parameters": [ { - "name": "Authorization", + "name": "Flex-Metadata", "in": "header", - "description": "The Authorization HTTP request header", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } @@ -3932,7 +8600,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_session" + "$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" + } + } + } } } }, @@ -3944,36 +8630,87 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsSession", - "x-maturity": [ - "Preview" - ] + "operationId": "CreatePlugin", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreatePluginRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "The Flex Plugin's unique name." + }, + "FriendlyName": { + "type": "string", + "description": "The Flex Plugin's friendly name." + }, + "Description": { + "type": "string", + "description": "A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long" + } + }, + "required": [ + "UniqueName" + ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique-name", + "FriendlyName": "friendly name", + "Description": "description" + } + } + } + } + } + } } }, - "/v1/Insights/QualityManagement/Settings/AnswerSets": { + "/v1/PluginService/Plugins/{Sid}": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "answer_sets", - "answer_set_categories", - "not_applicable" + "sid", + "unique_name", + "friendly_name" ], - "pathType": "list", - "mountName": "insights_settings_answer_sets", - "className": "insights_settings_answer_sets" + "dependentProperties": { + "plugin_versions": { + "mapping": { + "plugin_sid": "sid" + }, + "resource_url": "/v1/PluginService/Plugins/{plugin_sid}/Versions" + } + }, + "pathType": "instance" }, "get": { - "description": "To get the Answer Set Settings for an Account", + "description": "", + "tags": [ + "FlexV1Plugin" + ], "parameters": [ { - "name": "Authorization", + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Plugin resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Flex-Metadata", "in": "header", - "description": "The Authorization HTTP request header", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } @@ -3984,7 +8721,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_settings_answersets" + "$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" + } + } + } } } }, @@ -3996,33 +8751,27 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsSettingsAnswersets", - "x-maturity": [ - "Preview" - ] - } - }, - "/v1/Insights/QualityManagement/Settings/CommentTags": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "comments" - ], - "pathType": "list", - "mountName": "insights_settings_comment" + "operationId": "FetchPlugin" }, - "get": { - "description": "To get the Comment Settings for an Account", + "post": { + "description": "", + "tags": [ + "FlexV1Plugin" + ], "parameters": [ { - "name": "Authorization", + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Plugin resource to update.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Flex-Metadata", "in": "header", - "description": "The Authorization HTTP request header", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } @@ -4033,7 +8782,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_settings_comment" + "$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" + } + } + } } } }, @@ -4045,34 +8812,72 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsSettingsComment", - "x-maturity": [ - "Preview" - ] + "operationId": "UpdatePlugin", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdatePluginRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "The Flex Plugin's friendly name." + }, + "Description": { + "type": "string", + "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" + } + } + } + } + } + } } }, - "/v1/Insights/UserRoles": { + "/v1/PluginService/Plugins/{Sid}/Archive": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "roles" + "sid", + "unique_name", + "friendly_name" ], - "pathType": "instance", - "mountName": "insights_user_roles", - "className": "insights_user_roles" + "mountName": "plugin_archive", + "pathType": "instance" }, - "get": { - "description": "This is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user", + "post": { + "description": "", + "tags": [ + "FlexV1PluginArchive" + ], "parameters": [ { - "name": "Authorization", + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Plugin resource to archive.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Flex-Metadata", "in": "header", - "description": "The Authorization HTTP request header", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } @@ -4083,7 +8888,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_user_roles" + "$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" + } + } } } }, @@ -4095,43 +8915,73 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsUserRoles", - "x-maturity": [ - "Preview" - ] + "operationId": "UpdatePluginArchive" } }, - "/v1/Interactions/{Sid}": { + "/v1/PluginService/Configurations": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid" + "sid", + "name", + "description" ], - "pathType": "instance", "dependentProperties": { - "interaction_channel": "{interaction_sid: sid}" + "plugins": { + "mapping": { + "configuration_sid": "sid" + }, + "resource_url": "/v1/PluginService/Configurations/{configuration_sid}/Plugins" + } }, - "mountName": "interaction" + "mountName": "plugin_configurations", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "FlexV1PluginConfiguration" + ], "parameters": [ { - "name": "Sid", - "in": "path", - "description": "The SID of the Interaction resource to fetch.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", + "schema": { + "type": "string" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { @@ -4139,7 +8989,91 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction" + "type": "object", + "title": "ListPluginConfigurationResponse", + "properties": { + "configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.plugin_configuration" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "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" + } + } + } } } }, @@ -4151,37 +9085,45 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInteraction", - "x-maturity": [ - "GA" - ] - } - }, - "/v1/Interactions": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid" - ], - "pathType": "list", - "dependentProperties": { - "interaction_channel": "{interaction_sid: sid}" - }, - "mountName": "interaction" + "operationId": "ListPluginConfiguration" }, "post": { - "description": "Create a new Interaction.", + "description": "", + "tags": [ + "FlexV1PluginConfiguration" + ], + "parameters": [ + { + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", + "schema": { + "type": "string" + } + } + ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction" + "$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" + } + } + } } } }, @@ -4193,79 +9135,97 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInteraction", - "x-maturity": [ - "GA" - ], + "operationId": "CreatePluginConfiguration", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInteractionRequest", + "title": "CreatePluginConfigurationRequest", "properties": { - "Channel": { - "description": "The Interaction's channel." + "Name": { + "type": "string", + "description": "The Flex Plugin Configuration's name." }, - "Routing": { - "description": "The Interaction's routing logic." + "Plugins": { + "type": "array", + "items": {}, + "description": "A list of objects that describe the plugin versions included in the configuration. Each object contains the sid of the plugin version." + }, + "Description": { + "type": "string", + "description": "The Flex Plugin Configuration's description." } }, "required": [ - "Channel", - "Routing" + "Name" ] + }, + "examples": { + "create": { + "value": { + "Name": "some name", + "Description": "description", + "Plugins": [ + "{\"plugin_version\": \"FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\", \"phase\": 3}" + ] + } + } } } } } } }, - "/v1/Interactions/{InteractionSid}/Channels/{Sid}": { + "/v1/PluginService/Configurations/{Sid}": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid" + "sid", + "name", + "description" ], - "pathType": "instance", "dependentProperties": { - "interaction_channel_invite": "{interaction_sid: interaction_sid, channel_sid: sid}", - "interaction_channel_participant": "{interaction_sid: interaction_sid, channel_sid: sid}" + "plugins": { + "mapping": { + "configuration_sid": "sid" + }, + "resource_url": "/v1/PluginService/Configurations/{configuration_sid}/Plugins" + } }, - "parent": "/Interactions/{Sid}", - "className": "interaction_channel" + "mountName": "plugin_configurations", + "pathType": "instance" }, "get": { - "description": "Fetch a Channel for an Interaction.", + "description": "", + "tags": [ + "FlexV1PluginConfiguration" + ], "parameters": [ { - "name": "InteractionSid", + "name": "Sid", "in": "path", - "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", + "description": "The SID of the Flex Plugin Configuration resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "pattern": "^FJ[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Sid", - "in": "path", - "description": "The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { @@ -4273,7 +9233,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" + "$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" + } + } + } } } }, @@ -4285,37 +9261,50 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInteractionChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPluginConfiguration" + } + }, + "/v1/PluginService/Configurations/{Sid}/Archive": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "name", + "description" + ], + "mountName": "plugin_configuration_archive", + "pathType": "instance" }, "post": { - "description": "Update an existing Interaction Channel.", + "description": "", + "tags": [ + "FlexV1PluginConfigurationArchive" + ], "parameters": [ { - "name": "InteractionSid", + "name": "Sid", "in": "path", - "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", + "description": "The SID of the Flex Plugin Configuration resource to archive.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "pattern": "^FJ[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Sid", - "in": "path", - "description": "The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { @@ -4323,7 +9312,20 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" + "$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" + } + } } } }, @@ -4335,68 +9337,38 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInteractionChannel", - "x-maturity": [ - "GA" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateInteractionChannelRequest", - "properties": { - "Status": { - "type": "string", - "$ref": "#/components/schemas/interaction_channel_enum_status", - "description": "Required. Indicates the Interaction channel's status. When a channel is set to `closed`, all tasks are put in the `wrapping` state by default unless the Routing status is set to `closed` in which case the tasks will be `completed`. Value: `closed`." - }, - "Routing": { - "description": "Optional. The state of associated tasks. If not specified, all tasks will be set to `wrapping`." - } - }, - "required": [ - "Status" - ] - } - } - } - } + "operationId": "UpdatePluginConfigurationArchive" } }, - "/v1/Interactions/{InteractionSid}/Channels": { + "/v1/PluginService/Releases": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid" + "sid", + "configuration_sid", + "date_created" ], - "pathType": "list", - "dependentProperties": { - "interaction_channel_invite": "{interaction_sid: interaction_sid, channel_sid: sid}", - "interaction_channel_participant": "{interaction_sid: interaction_sid, channel_sid: sid}" - }, - "parent": "/Interactions/{Sid}", - "className": "interaction_channel" + "mountName": "plugin_releases", + "pathType": "list" }, "get": { - "description": "List all Channels for an Interaction.", + "description": "", + "tags": [ + "FlexV1PluginRelease" + ], "parameters": [ { - "name": "InteractionSid", - "in": "path", - "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } }, { "name": "PageSize", @@ -4432,25 +9404,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListInteractionChannelResponse", + "title": "ListPluginReleaseResponse", "properties": { - "channels": { + "releases": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" + "$ref": "#/components/schemas/flex.v1.plugin_release" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4459,24 +9433,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" + } + } + }, + "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" } } } } } }, - "description": "OK" + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListPluginRelease" + }, + "post": { + "description": "", + "tags": [ + "FlexV1PluginRelease" + ], + "parameters": [ + { + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "content": { + "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" + } + } + } + } + }, + "description": "Created" } }, "security": [ @@ -4484,65 +9539,105 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannel", - "x-maturity": [ - "GA" - ] + "operationId": "CreatePluginRelease", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreatePluginReleaseRequest", + "properties": { + "ConfigurationId": { + "type": "string", + "description": "The SID or the Version of the Flex Plugin Configuration to release." + } + }, + "required": [ + "ConfigurationId" + ] + }, + "examples": { + "create": { + "value": { + "ConfigurationId": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + } } }, - "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites": { + "/v1/PluginService/Releases/{Sid}": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid" + "sid", + "configuration_sid", + "date_created" ], - "pathType": "list", - "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", - "className": "interaction_channel_invite" + "mountName": "plugin_releases", + "pathType": "instance" }, - "post": { - "description": "Invite an Agent or a TaskQueue to a Channel.", + "get": { + "description": "", + "tags": [ + "FlexV1PluginRelease" + ], "parameters": [ { - "name": "InteractionSid", + "name": "Sid", "in": "path", - "description": "The Interaction SID for this Channel.", + "description": "The SID of the Flex Plugin Release resource to fetch.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ChannelSid", - "in": "path", - "description": "The Channel SID for this Invite.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite" + "$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" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -4550,55 +9645,49 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInteractionChannelInvite", - "x-maturity": [ - "GA" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateInteractionChannelInviteRequest", - "properties": { - "Routing": { - "description": "The Interaction's routing logic." - } - }, - "required": [ - "Routing" - ] - } - } - } + "operationId": "FetchPluginRelease" + } + }, + "/v1/PluginService/Plugins/{PluginSid}/Versions": { + "servers": [ + { + "url": "https://flex-api.twilio.com" } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "plugin_sid", + "version" + ], + "parent": "/PluginService/Plugins/{Sid}", + "mountName": "plugin_versions", + "className": "plugin_versions", + "pathType": "list" }, "get": { - "description": "List all Invites for a Channel.", + "description": "", + "tags": [ + "FlexV1PluginVersions" + ], "parameters": [ { - "name": "InteractionSid", + "name": "PluginSid", "in": "path", - "description": "The Interaction SID for this Channel.", + "description": "The SID of the Flex Plugin the resource to belongs to.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ChannelSid", - "in": "path", - "description": "The Channel SID for this Participant.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } }, { "name": "PageSize", @@ -4634,25 +9723,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListInteractionChannelInviteResponse", + "title": "ListPluginVersionResponse", "properties": { - "invites": { + "plugin_versions": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite" + "$ref": "#/components/schemas/flex.v1.plugin.plugin_version" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4661,17 +9752,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "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, + "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" } } } @@ -4686,53 +9818,30 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannelInvite", - "x-maturity": [ - "GA" - ] - } - }, - "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid" - ], - "pathType": "list", - "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", - "className": "interaction_channel_participant" + "operationId": "ListPluginVersion" }, "post": { - "description": "Add a Participant to a Channel.", + "description": "", + "tags": [ + "FlexV1PluginVersions" + ], "parameters": [ { - "name": "InteractionSid", + "name": "PluginSid", "in": "path", - "description": "The Interaction Sid for the new Channel Participant.", + "description": "The SID of the Flex Plugin the resource to belongs to.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ChannelSid", - "in": "path", - "description": "The Channel Sid for the new Channel Participant.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { @@ -4740,7 +9849,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" + "$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, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4752,85 +9877,98 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInteractionChannelParticipant", - "x-maturity": [ - "GA" - ], + "operationId": "CreatePluginVersion", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInteractionChannelParticipantRequest", + "title": "CreatePluginVersionRequest", "properties": { - "Type": { + "Version": { "type": "string", - "$ref": "#/components/schemas/interaction_channel_participant_enum_type", - "description": "Participant type. Can be: `agent`, `customer`, `supervisor`, `external` or `unknown`." + "description": "The Flex Plugin Version's version." }, - "MediaProperties": { - "description": "JSON representing the Media Properties for the new Participant." + "PluginUrl": { + "type": "string", + "format": "uri", + "description": "The URL of the Flex Plugin Version bundle" + }, + "Changelog": { + "type": "string", + "description": "The changelog of the Flex Plugin Version." + }, + "Private": { + "type": "boolean", + "description": "Whether this Flex Plugin Version requires authorization." } }, "required": [ - "Type", - "MediaProperties" + "Version", + "PluginUrl" ] + }, + "examples": { + "create": { + "value": { + "Version": "1.0.0", + "PluginUrl": "https://sample.twil.io/plugin.js", + "Changelog": "the changelog", + "Private": true + } + } } } } } + } + }, + "/v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "plugin_sid", + "version" + ], + "parent": "/PluginService/Plugins/{Sid}", + "mountName": "plugin_versions", + "className": "plugin_versions", + "pathType": "instance" }, "get": { - "description": "List all Participants for a Channel.", + "description": "", + "tags": [ + "FlexV1PluginVersions" + ], "parameters": [ { - "name": "InteractionSid", + "name": "PluginSid", "in": "path", - "description": "The Interaction Sid for this channel.", + "description": "The SID of the Flex Plugin the resource to belongs to.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ChannelSid", + "name": "Sid", "in": "path", - "description": "The Channel Sid for this Participant.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[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.", + "description": "The SID of the Flex Plugin Version resource to fetch.", "schema": { - "type": "integer", - "minimum": 0 - } + "type": "string" + }, + "required": true }, { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } @@ -4841,46 +9979,21 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListInteractionChannelParticipantResponse", - "properties": { - "participants": { - "type": "array", - "items": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } + "$ref": "#/components/schemas/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, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -4894,65 +10007,56 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannelParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPluginVersion" } }, - "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}": { + "/v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}/Archive": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid" + "sid", + "plugin_sid", + "version" ], - "pathType": "instance", - "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", - "className": "interaction_channel_participant" + "mountName": "plugin_version_archive", + "pathType": "instance" }, "post": { - "description": "Update an existing Channel Participant.", + "description": "", + "tags": [ + "FlexV1PluginVersionArchive" + ], "parameters": [ { - "name": "InteractionSid", + "name": "PluginSid", "in": "path", - "description": "The Interaction Sid for this channel.", + "description": "The SID of the Flex Plugin the resource to belongs to.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ChannelSid", + "name": "Sid", "in": "path", - "description": "The Channel Sid for this Participant.", + "description": "The SID of the Flex Plugin Version resource to archive.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "Sid", - "in": "path", - "description": "The unique string created by Twilio to identify an Interaction Channel resource.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { @@ -4960,7 +10064,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" + "$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" + } + } } } }, @@ -4972,30 +10092,54 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInteractionChannelParticipant", - "x-maturity": [ - "GA" + "operationId": "UpdatePluginVersionArchive" + } + }, + "/v1/account/provision/status": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Status for email provisioning", + "x-twilio": { + "defaultOutputProperties": [ + "status" ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateInteractionChannelParticipantRequest", - "properties": { - "Status": { - "type": "string", - "$ref": "#/components/schemas/interaction_channel_participant_enum_status", - "description": "The Participant's status. Can be: `closed` or `wrapup`. Participant must be an agent." - } + "mountName": "provisioning_status", + "pathType": "instance" + }, + "get": { + "description": "", + "tags": [ + "FlexV1ProvisioningStatus" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.provisioning_status" }, - "required": [ - "Status" - ] + "examples": { + "fetch": { + "value": { + "status": "active", + "url": "https://flex-api.twilio.com/v1/account/provision/status" + } + } + } } - } + }, + "description": "OK" } - } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchProvisioningStatus" } }, "/v1/WebChannels": { @@ -5004,17 +10148,20 @@ "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": "", + "tags": [ + "FlexV1WebChannel" + ], "parameters": [ { "name": "PageSize", @@ -5059,16 +10206,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5077,18 +10226,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_chat_channels" + }, + "flex_chat_channels": [ + { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_chat_channels" + }, + "flex_chat_channels": [] } } } @@ -5102,19 +10288,31 @@ "accountSid_authToken": [] } ], - "operationId": "ListWebChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListWebChannel" }, "post": { "description": "", + "tags": [ + "FlexV1WebChannel" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.web_channel" + }, + "examples": { + "create": { + "value": { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5127,9 +10325,6 @@ } ], "operationId": "CreateWebChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5171,6 +10366,17 @@ "CustomerFriendlyName", "ChatFriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FlexFlowSid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Identity": "abc", + "ChatFriendlyName": "firendly1", + "CustomerFriendlyName": "friendly2", + "PreEngagementData": "{}" + } + } } } } @@ -5183,17 +10389,20 @@ "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": "", + "tags": [ + "FlexV1WebChannel" + ], "parameters": [ { "name": "Sid", @@ -5214,6 +10423,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.web_channel" + }, + "examples": { + "fetch": { + "value": { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5225,13 +10446,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWebChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWebChannel" }, "post": { "description": "", + "tags": [ + "FlexV1WebChannel" + ], "parameters": [ { "name": "Sid", @@ -5252,6 +10473,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.web_channel" + }, + "examples": { + "update": { + "value": { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5264,9 +10497,6 @@ } ], "operationId": "UpdateWebChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5284,6 +10514,14 @@ "description": "The post-engagement data." } } + }, + "examples": { + "update": { + "value": { + "ChatStatus": "inactive", + "PostEngagementData": "{}" + } + } } } } @@ -5291,6 +10529,9 @@ }, "delete": { "description": "", + "tags": [ + "FlexV1WebChannel" + ], "parameters": [ { "name": "Sid", @@ -5315,10 +10556,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWebChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWebChannel" } } }, @@ -5327,14 +10565,146 @@ "url": "https://flex-api.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "FlexV1AiInsights" + }, + { + "name": "FlexV1Assessments" + }, + { + "name": "FlexV1Channel" + }, + { + "name": "FlexV1ChannelUser" + }, + { + "name": "FlexV1Configuration" + }, + { + "name": "FlexV1ConfiguredPlugin" + }, + { + "name": "FlexV1FlexFlow" + }, + { + "name": "FlexV1FlexVideoOrchestration" + }, + { + "name": "FlexV1InsightsAssessmentsComment" + }, + { + "name": "FlexV1InsightsConversationalAi" + }, + { + "name": "FlexV1InsightsConversations" + }, + { + "name": "FlexV1InsightsQuestionnaires" + }, + { + "name": "FlexV1InsightsQuestionnairesCategory" + }, + { + "name": "FlexV1InsightsQuestionnairesQuestion" + }, + { + "name": "FlexV1InsightsSegments" + }, + { + "name": "FlexV1InsightsSession" + }, + { + "name": "FlexV1InsightsSettingsAnswerSets" + }, + { + "name": "FlexV1InsightsSettingsComment" + }, + { + "name": "FlexV1InsightsUserRoles" + }, + { + "name": "FlexV1Interaction" + }, + { + "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": "FlexV1Plugin" + }, + { + "name": "FlexV1PluginArchive" + }, + { + "name": "FlexV1PluginConfiguration" + }, + { + "name": "FlexV1PluginConfigurationArchive" + }, + { + "name": "FlexV1PluginRelease" + }, + { + "name": "FlexV1PluginVersionArchive" + }, + { + "name": "FlexV1PluginVersions" + }, + { + "name": "FlexV1ProvisioningStatus" + }, + { + "name": "FlexV1PublicConfiguration" + }, + { + "name": "FlexV1Transfer" + }, { - "name": "GA", - "description": "This product is Generally Available." + "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 help@twilio.com." + "name": "FlexV1WebChannel" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_flex_v2.json b/spec/json/twilio_flex_v2.json index 91ff3409..1f7663d1 100644 --- a/spec/json/twilio_flex_v2.json +++ b/spec/json/twilio_flex_v2.json @@ -1,6 +1,31 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { + "conductor_flow_enum_flow_type": { + "type": "string", + "enum": [ + "StartInboundMessaging", + "StartOutboundVoice", + "AcceptInvite", + "EndInboundMessaging", + "EndOutboundVoice" + ] + }, + "conductor_flow_enum_name": { + "type": "string", + "enum": [ + "AcceptInviteFlow", + "EndInboundMessagingFlow", + "StartInboundMessagingFlow", + "StartOutboundVoiceFlow" + ] + }, "flex.v2.web_channel": { "type": "object", "properties": { @@ -19,12 +44,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -40,7 +59,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -50,23 +69,34 @@ "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": "", + "tags": [ + "FlexV2WebChannels" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flex.v2.web_channel" + }, + "examples": { + "create": { + "value": { + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "seinfeld" + } + } } } }, @@ -79,9 +109,6 @@ } ], "operationId": "CreateWebChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -109,6 +136,15 @@ "required": [ "AddressSid" ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChatFriendlyName": "LoquaciousLarry", + "CustomerFriendlyName": "LarryDavid" + } + } } } } @@ -121,10 +157,26 @@ "url": "https://flex-api.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "FlexV2ConductorFlow" + }, + { + "name": "FlexV2User" + }, + { + "name": "FlexV2WebChannels" + }, + { + "name": "FlexV2WebchatInitToken" + }, + { + "name": "FlexV2WebchatRefreshToken" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_frontline_v1.json b/spec/json/twilio_frontline_v1.json index 3b22c5ad..36b5e740 100644 --- a/spec/json/twilio_frontline_v1.json +++ b/spec/json/twilio_frontline_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "frontline.v1.user": { "type": "object", @@ -15,12 +21,24 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive." + "description": "The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the User." + "description": "The string that you assigned to describe the User.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "avatar": { "type": "string", @@ -53,12 +71,6 @@ "deactivated" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -74,7 +86,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -94,6 +106,9 @@ }, "get": { "description": "Fetch a frontline user", + "tags": [ + "FrontlineV1User" + ], "parameters": [ { "name": "Sid", @@ -111,6 +126,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/frontline.v1.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "john@example.com", + "friendly_name": "John Doe", + "avatar": "https://example.com/profile.png", + "state": "active", + "is_available": true, + "url": "https://frontline-api.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -122,13 +150,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUser" }, "post": { "description": "Update an existing frontline user", + "tags": [ + "FrontlineV1User" + ], "parameters": [ { "name": "Sid", @@ -146,6 +174,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/frontline.v1.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "john@example.com", + "friendly_name": "John Doe", + "avatar": "https://example.com/profile.png", + "state": "active", + "is_available": true, + "url": "https://frontline-api.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -158,9 +199,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -186,6 +224,16 @@ "description": "Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing)." } } + }, + "examples": { + "update": { + "value": { + "State": "active", + "FriendlyName": "Name", + "Avatar": "https://example.com/avatar.png", + "IsAvailable": true + } + } } } } @@ -198,10 +246,14 @@ "url": "https://frontline-api.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "FrontlineV1User" + } + ], + "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/spec/json/twilio_insights_v1.json b/spec/json/twilio_insights_v1.json index 5d165714..6219724e 100644 --- a/spec/json/twilio_insights_v1.json +++ b/spec/json/twilio_insights_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "insights.v1.account_settings": { "type": "object", @@ -9,20 +15,24 @@ "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Account." }, "advanced_features": { "type": "boolean", - "nullable": true + "nullable": true, + "description": "A boolean flag indicating whether Advanced Features for Voice Insights are enabled." }, "voice_trace": { "type": "boolean", - "nullable": true + "nullable": true, + "description": "A boolean flag indicating whether Voice Trace is enabled." }, "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "The URL of this resource." } } }, @@ -49,13 +59,13 @@ "type": "string", "$ref": "#/components/schemas/annotation_enum_answered_by", "nullable": true, - "description": "Which entity answered the call as determined by Answering Machine Detection. Use this to provide feedback on Answering Machine Detection accuracy. Possible enumerated values, one of: human, machine. human indicates the call was answered by a person. machine indicates the call was answered by an answering machine." + "description": "Specifies which entity answered the call as determined by Answering Machine Detection. Possible enumerated values, one of: `human`, `machine`. `human` indicates the call was answered by a person. `machine` indicates the call was answered by an answering machine." }, "connectivity_issue": { "type": "string", "$ref": "#/components/schemas/annotation_enum_connectivity_issue", "nullable": true, - "description": "Specify if the call had any connectivity issues. Possible enumerated values, one : no_connectivity_issue, invalid_number, caller_id, dropped_call, number_reachability." + "description": "Specifies if the call had any connectivity issues. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`." }, "quality_issues": { "type": "array", @@ -63,33 +73,32 @@ "type": "string" }, "nullable": true, - "description": "Specify if the call had any subjective quality issues. Possible values, one or more of: no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated values to indicate multiple quality issues for the same call" + "description": "Specifies if the call had any subjective quality issues. Possible values are one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, or `static_noise`." }, "spam": { "type": "boolean", "nullable": true, - "description": "Specify if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call." + "description": "Specifies if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call." }, "call_score": { "type": "integer", "nullable": true, - "description": "Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad]." + "description": "Specifies the Call Score, if available. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad]." }, "comment": { "type": "string", "nullable": true, - "description": "Specify any comments pertaining to the call. This of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don\u2019t put any PII in here." + "description": "Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments." }, "incident": { "type": "string", "nullable": true, - "description": "Associate this call with an incident or support ticket. This is of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don\u2019t put any PII in here." + "description": "Incident or support ticket associated with this call. The `incident` property is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`." }, "url": { "type": "string", "format": "uri", - "nullable": true, - "description": "The URL of this resource." + "nullable": true } } }, @@ -156,95 +165,132 @@ "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Account." }, "call_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Call." }, "answered_by": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_answered_by", - "nullable": true + "nullable": true, + "description": "The Answered By value for the summarized call based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`. Refer to [AMD](https://www.twilio.com/docs/voice/answering-machine-detection) for more detail." }, "call_type": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_call_type", - "nullable": true + "nullable": true, + "description": "The Call Type of the summarized Call. One of `carrier`, `sip`, `trunking` or `client`." }, "call_state": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_call_state", - "nullable": true + "nullable": true, + "description": "The Call State of the summarized Call. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`." }, "processing_state": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_processing_state", - "nullable": true + "nullable": true, + "description": "The Processing State of the Call Summary. The Processing State will be `partial` until the assembly of the Call Summary finishes, which occurs approximately 30 minutes after Call end. Then the Processing State changes to `complete`" }, "created_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS" }, "start_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was started, given in ISO 8601 format." }, "end_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was ended, given in ISO 8601 format." }, "duration": { "type": "integer", - "nullable": true + "nullable": true, + "description": "Duration between when the call was initiated and the call was ended" }, "connect_duration": { "type": "integer", - "nullable": true + "nullable": true, + "description": "Duration between when the call was answered and when it ended" }, "from": { - "nullable": true + "nullable": true, + "description": "The calling party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "to": { - "nullable": true + "nullable": true, + "description": "The called party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "carrier_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a PSTN call." }, "client_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a Client call." }, "sdk_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the SDK sensor library for Client calls." }, "sip_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call." }, "tags": { "type": "array", "items": { "type": "string" }, - "nullable": true + "nullable": true, + "description": "Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality." }, "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "The URL of this resource." }, "attributes": { - "nullable": true + "nullable": true, + "description": "Attributes capturing call-flow-specific details." }, "properties": { - "nullable": true + "nullable": true, + "description": "Contains edge-agnostic call-level details." }, "trust": { + "nullable": true, + "description": "Contains trusted communications details including Branded Call and verified caller ID." + }, + "annotation": { "nullable": true } } @@ -338,7 +384,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "Custom label for the conference resource, up to 64 characters." + "description": "Custom label for the conference resource, up to 64 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "create_time": { "type": "string", @@ -526,7 +578,13 @@ "label": { "type": "string", "nullable": true, - "description": "The user-specified label of this participant." + "description": "The user-specified label of this participant.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conference_sid": { "type": "string", @@ -561,12 +619,24 @@ "from": { "type": "string", "nullable": true, - "description": "Caller ID of the calling party." + "description": "Caller ID of the calling party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "to": { "type": "string", "nullable": true, - "description": "Called party." + "description": "Called party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "call_status": { "type": "string", @@ -736,51 +806,62 @@ "properties": { "timestamp": { "type": "string", - "nullable": true + "nullable": true, + "description": "Event time." }, "call_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Call." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Account." }, "edge": { "type": "string", "$ref": "#/components/schemas/event_enum_twilio_edge", - "nullable": true + "nullable": true, + "description": "The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`." }, "group": { "type": "string", - "nullable": true + "nullable": true, + "description": "Event group." }, "level": { "type": "string", "$ref": "#/components/schemas/event_enum_level", - "nullable": true + "nullable": true, + "description": "The Level of this Event. One of `UNKNOWN`, `DEBUG`, `INFO`, `WARNING` or `ERROR`." }, "name": { "type": "string", - "nullable": true + "nullable": true, + "description": "Event name." }, "carrier_edge": { - "nullable": true + "nullable": true, + "description": "Represents the connection between Twilio and our immediate carrier partners. The events here describe the call lifecycle as reported by Twilio's carrier media gateways." }, "sip_edge": { - "nullable": true + "nullable": true, + "description": "Represents the Twilio media gateway for SIP interface and SIP trunking calls. The events here describe the call lifecycle as reported by Twilio's public media gateways." }, "sdk_edge": { - "nullable": true + "nullable": true, + "description": "Represents the Voice SDK running locally in the browser or in the Android/iOS application. The events here are emitted by the Voice SDK in response to certain call progress events, network changes, or call quality conditions." }, "client_edge": { - "nullable": true + "nullable": true, + "description": "Represents the Twilio media gateway for Client calls. The events here describe the call lifecycle as reported by Twilio's Voice SDK media gateways." } } }, @@ -809,43 +890,52 @@ "properties": { "timestamp": { "type": "string", - "nullable": true + "nullable": true, + "description": "Timestamp of metric sample. Samples are taken every 10 seconds and contain the metrics for the previous 10 seconds." }, "call_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Call." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Account." }, "edge": { "type": "string", "$ref": "#/components/schemas/metric_enum_twilio_edge", - "nullable": true + "nullable": true, + "description": "The Twilio media edge this Metric was captured on. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`." }, "direction": { "type": "string", "$ref": "#/components/schemas/metric_enum_stream_direction", - "nullable": true + "nullable": true, + "description": "The Direction of the media stream from the perspective of the Twilio media edge. One of `unknown`, `inbound`, `outbound` or `both`." }, "carrier_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a PSTN call." }, "sip_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call." }, "sdk_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the SDK sensor library for Client calls." }, "client_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a Client call." } } }, @@ -876,99 +966,134 @@ "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Account." }, "call_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Call." }, "call_type": { "type": "string", "$ref": "#/components/schemas/summary_enum_call_type", - "nullable": true + "nullable": true, + "description": "The Call Type of the summarized Call. One of `carrier`, `sip`, `trunking` or `client`." }, "call_state": { "type": "string", "$ref": "#/components/schemas/summary_enum_call_state", - "nullable": true + "nullable": true, + "description": "The Call State of the summarized Call. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`." }, "answered_by": { "type": "string", "$ref": "#/components/schemas/summary_enum_answered_by", - "nullable": true + "nullable": true, + "description": "The Answered By value for the summarized call based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`. Refer to [AMD](https://www.twilio.com/docs/voice/answering-machine-detection) for more detail." }, "processing_state": { "type": "string", "$ref": "#/components/schemas/summary_enum_processing_state", - "nullable": true + "nullable": true, + "description": "The Processing State of the Call Summary. The Processing State will be `partial` until the assembly of the Call Summary finishes, which occurs approximately 30 minutes after Call end. Then the Processing State changes to `complete`" }, "created_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS" }, "start_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was started, given in ISO 8601 format." }, "end_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was ended, given in ISO 8601 format." }, "duration": { "type": "integer", - "nullable": true + "nullable": true, + "description": "Duration between when the call was initiated and the call was ended" }, "connect_duration": { "type": "integer", - "nullable": true + "nullable": true, + "description": "Duration between when the call was answered and when it ended" }, "from": { - "nullable": true + "nullable": true, + "description": "The calling party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "to": { - "nullable": true + "nullable": true, + "description": "The called party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "carrier_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a PSTN call." }, "client_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a Client call." }, "sdk_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the SDK sensor library for Client calls." }, "sip_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call." }, "tags": { "type": "array", "items": { "type": "string" }, - "nullable": true + "nullable": true, + "description": "Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality." }, "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "The URL of this resource." }, "attributes": { - "nullable": true + "nullable": true, + "description": "Attributes capturing call-flow-specific details." }, "properties": { - "nullable": true + "nullable": true, + "description": "Contains edge-agnostic call-level details." }, "trust": { - "nullable": true + "nullable": true, + "description": "Contains trusted communications details including Branded Call and verified caller ID." }, "annotation": { - "nullable": true + "nullable": true, + "description": "Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API." } } }, @@ -1081,7 +1206,7 @@ "end_reason": { "type": "string", "nullable": true, - "description": "Reason the participant left the room. See [the list of possible values here](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#end_reason)." + "description": "Reason the participant left the room. See [the list of possible values here](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#end_reason)." }, "error_code": { "type": "integer", @@ -1101,7 +1226,7 @@ }, "properties": { "nullable": true, - "description": "Object containing information about the participant's data from the room. See [below](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#properties) for more information." + "description": "Object containing information about the participant's data from the room. See [below](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#properties) for more information." }, "edge_location": { "type": "string", @@ -1111,7 +1236,7 @@ }, "publisher_info": { "nullable": true, - "description": "Object containing information about the SDK name and version. See [below](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#publisher_info) for more information." + "description": "Object containing information about the SDK name and version. See [below](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#publisher_info) for more information." }, "url": { "type": "string", @@ -1409,12 +1534,6 @@ "tokyo" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1430,7 +1549,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1440,7 +1559,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "advanced_features", @@ -1449,12 +1568,15 @@ "pathType": "instance" }, "get": { - "description": "", + "description": "Get the Voice Insights Settings.", + "tags": [ + "InsightsV1Setting" + ], "parameters": [ { "name": "SubaccountSid", "in": "query", - "description": "", + "description": "The unique SID identifier of the Subaccount.", "schema": { "type": "string", "minLength": 34, @@ -1469,6 +1591,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.account_settings" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_trace": true, + "advanced_features": true, + "url": "https://insights.twilio.com/v1/Voice/Settings" + } + } } } }, @@ -1480,19 +1612,29 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccountSettings", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAccountSettings" }, "post": { - "description": "", + "description": "Update a specific Voice Insights Setting.", + "tags": [ + "InsightsV1Setting" + ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.account_settings" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_trace": true, + "advanced_features": true, + "url": "https://insights.twilio.com/v1/Voice/Settings" + } + } } } }, @@ -1505,9 +1647,6 @@ } ], "operationId": "UpdateAccountSettings", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1517,18 +1656,27 @@ "properties": { "AdvancedFeatures": { "type": "boolean", - "description": "" + "description": "A boolean flag to enable Advanced Features for Voice Insights." }, "VoiceTrace": { "type": "boolean", - "description": "" + "description": "A boolean flag to enable Voice Trace." }, "SubaccountSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "description": "" + "description": "The unique SID identifier of the Subaccount." + } + } + }, + "examples": { + "update": { + "value": { + "VoiceTrace": true, + "AdvancedFeatures": true, + "SubaccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" } } } @@ -1543,17 +1691,20 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "call_sid", "account_sid" ], - "pathType": "instance", - "parent": "/Voice/{Sid}" + "parent": "/Voice/{Sid}", + "pathType": "instance" }, "post": { - "description": "Create/Update the annotation for the call", + "description": "Update an Annotation for a specific Call.", + "tags": [ + "InsightsV1Annotation" + ], "parameters": [ { "name": "CallSid", @@ -1574,6 +1725,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.call.annotation" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answered_by": "human", + "connectivity_issue": "invalid_number", + "quality_issues": [ + "low_volume", + "choppy_robotic" + ], + "spam": true, + "call_score": 2, + "comment": "this is a call", + "incident": "https://twilio.zendesk.com/support/tickets/17353089", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation" + } + } } } }, @@ -1586,9 +1756,6 @@ } ], "operationId": "UpdateAnnotation", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1599,20 +1766,20 @@ "AnsweredBy": { "type": "string", "$ref": "#/components/schemas/annotation_enum_answered_by", - "description": "Which entity answered the call as determined by Answering Machine Detection. Use this to provide feedback on Answering Machine Detection accuracy. Possible enumerated values, one of: human, machine. human indicates the call was answered by a person. machine indicates the call was answered by an answering machine." + "description": "Specify which entity answered the call as determined by Answering Machine Detection. Use this to provide feedback on Answering Machine Detection accuracy. Possible enumerated values, one of: `human`, `machine`. `human` indicates the call was answered by a person. `machine` indicates the call was answered by an answering machine." }, "ConnectivityIssue": { "type": "string", "$ref": "#/components/schemas/annotation_enum_connectivity_issue", - "description": "Specify if the call had any connectivity issues. Possible enumerated values, one : no_connectivity_issue, invalid_number, caller_id, dropped_call, number_reachability." + "description": "Specify if the call had any connectivity issues. Possible enumerated values, one of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`." }, "QualityIssues": { "type": "string", - "description": "Specify if the call had any subjective quality issues. Possible values, one or more of: no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated values to indicate multiple quality issues for the same call" + "description": "Specify if the call had any subjective quality issues. Possible values, one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. Use comma separated values to indicate multiple quality issues for the same call." }, "Spam": { "type": "boolean", - "description": "Specify if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call." + "description": "A boolean flag to indicate if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Use `true` if the call was a spam call." }, "CallScore": { "type": "integer", @@ -1621,11 +1788,24 @@ }, "Comment": { "type": "string", - "description": "Specify any comments pertaining to the call. This of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don\u2019t put any PII in here." + "description": "Specify any comments pertaining to the call. `comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`." }, "Incident": { "type": "string", - "description": "Associate this call with an incident or support ticket. This is of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don\u2019t put any PII in here." + "description": "Associate this call with an incident or support ticket. The `incident` parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`." + } + } + }, + "examples": { + "update": { + "value": { + "AnsweredBy": "human", + "ConnectivityIssue": "invalid_number", + "QualityIssues": "low_volume,choppy_robotic", + "Spam": true, + "CallScore": 2, + "Comment": "this is a call", + "Incident": "https://twilio.zendesk.com/support/tickets/17353089" } } } @@ -1634,7 +1814,10 @@ } }, "get": { - "description": "Fetch a specific Annotation.", + "description": "Get the Annotation for a specific Call.", + "tags": [ + "InsightsV1Annotation" + ], "parameters": [ { "name": "CallSid", @@ -1655,6 +1838,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.call.annotation" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answered_by": "human", + "connectivity_issue": "invalid_number", + "quality_issues": [ + "low_volume" + ], + "spam": true, + "call_score": 2, + "comment": "this is a call", + "incident": "https://twilio.zendesk.com/support/tickets/17353089", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation" + } + } } } }, @@ -1666,10 +1867,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAnnotation", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAnnotation" } }, "/v1/Voice/{Sid}": { @@ -1678,20 +1876,43 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { - "event": "{call_sid: sid}", - "metric": "{call_sid: sid}", - "call_summary": "{call_sid: sid}", - "annotation": "{call_sid: sid}" + "events": { + "mapping": { + "call_sid": "sid" + }, + "resource_url": "/v1/Voice/{call_sid}/Events" + }, + "metrics": { + "mapping": { + "call_sid": "sid" + }, + "resource_url": "/v1/Voice/{call_sid}/Metrics" + }, + "summary": { + "mapping": { + "call_sid": "sid" + }, + "resource_url": "/v1/Voice/{call_sid}/Summary" + }, + "annotation": { + "mapping": { + "call_sid": "sid" + }, + "resource_url": "/v1/Voice/{call_sid}/Annotation" + } }, - "mountName": "calls" + "mountName": "calls", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "InsightsV1Call" + ], "parameters": [ { "name": "Sid", @@ -1712,6 +1933,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.call" + }, + "examples": { + "fetch": { + "value": { + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "events": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events", + "metrics": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics", + "summary": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Summary", + "annotation": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation" + } + } + } } } }, @@ -1723,10 +1958,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCall", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCall" } }, "/v1/Voice/Summaries": { @@ -1735,7 +1967,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -1748,33 +1980,48 @@ "call_type", "call_state" ], - "pathType": "list", "mountName": "call_summaries", - "className": "call_summaries" + "className": "call_summaries", + "pathType": "list" }, "get": { - "description": "", + "description": "Get a list of Call Summaries.", + "tags": [ + "InsightsV1CallSummaries" + ], "parameters": [ { "name": "From", "in": "query", - "description": "", + "description": "A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { "name": "To", "in": "query", - "description": "", + "description": "A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { "name": "FromCarrier", "in": "query", - "description": "", + "description": "An origination carrier.", "schema": { "type": "string" } @@ -1782,15 +2029,20 @@ { "name": "ToCarrier", "in": "query", - "description": "", + "description": "A destination carrier.", "schema": { "type": "string" + }, + "examples": { + "readWithCarrier": { + "value": "AT&T Wireless" + } } }, { "name": "FromCountryCode", "in": "query", - "description": "", + "description": "A source country code based on phone number in From.", "schema": { "type": "string" } @@ -1798,7 +2050,7 @@ { "name": "ToCountryCode", "in": "query", - "description": "", + "description": "A destination country code. Based on phone number in To.", "schema": { "type": "string" } @@ -1806,7 +2058,7 @@ { "name": "Branded", "in": "query", - "description": "", + "description": "A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.", "schema": { "type": "boolean" } @@ -1814,31 +2066,55 @@ { "name": "VerifiedCaller", "in": "query", - "description": "", + "description": "A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.", "schema": { "type": "boolean" + }, + "examples": { + "readWithTrust": { + "value": true + } } }, { "name": "HasTag", "in": "query", - "description": "", + "description": "A boolean flag indicating the presence of one or more [Voice Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).", "schema": { "type": "boolean" + }, + "examples": { + "readWithSubaccount": { + "value": true + } } }, { "name": "StartTime", "in": "query", - "description": "", + "description": "A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.", "schema": { "type": "string" + }, + "examples": { + "readWithCarrier": { + "value": "4h" + }, + "readWithSubaccount": { + "value": "7d" + }, + "readWithTrust": { + "value": "1d" + }, + "readWithAbnormalSession": { + "value": "15d" + } } }, { "name": "EndTime", "in": "query", - "description": "", + "description": "An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.", "schema": { "type": "string" } @@ -1846,31 +2122,49 @@ { "name": "CallType", "in": "query", - "description": "", + "description": "A Call Type of the calls. One of `carrier`, `sip`, `trunking` or `client`.", "schema": { "type": "string" + }, + "examples": { + "readWithSubaccount": { + "value": "client" + }, + "readWithAbnormalSession": { + "value": "sip,trunking" + } } }, { "name": "CallState", "in": "query", - "description": "", + "description": "A Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.", "schema": { "type": "string" + }, + "examples": { + "readWithAbnormalSession": { + "value": "completed" + } } }, { "name": "Direction", "in": "query", - "description": "", + "description": "A Direction of the calls. One of `outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.", "schema": { "type": "string" + }, + "examples": { + "readWithTrust": { + "value": "outbound_api,outbound_dial,trunking_terminating" + } } }, { "name": "ProcessingState", "in": "query", - "description": "", + "description": "A Processing State of the Call Summaries. One of `completed`, `partial` or `all`.", "schema": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_processing_state_request" @@ -1879,7 +2173,7 @@ { "name": "SortBy", "in": "query", - "description": "", + "description": "A Sort By criterion for the returned list of Call Summaries. One of `start_time` or `end_time`.", "schema": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_sort_by" @@ -1888,61 +2182,109 @@ { "name": "Subaccount", "in": "query", - "description": "", + "description": "A unique SID identifier of a Subaccount.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$" + }, + "examples": { + "readWithSubaccount": { + "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } } }, { "name": "AbnormalSession", "in": "query", - "description": "", + "description": "A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.", "schema": { "type": "boolean" + }, + "examples": { + "readWithAbnormalSession": { + "value": true + } } }, { "name": "AnsweredBy", "in": "query", - "description": "", + "description": "An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.", "schema": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_answered_by" + }, + "examples": { + "readWithCarrier": { + "value": "machine_start" + } } }, { - "name": "ConnectivityIssues", + "name": "AnsweredByAnnotation", "in": "query", - "description": "", + "description": "Either machine or human.", "schema": { "type": "string" + }, + "examples": { + "readWithAnnotationParameters": { + "value": "human" + } } }, { - "name": "QualityIssues", + "name": "ConnectivityIssueAnnotation", "in": "query", - "description": "", + "description": "A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.", "schema": { "type": "string" + }, + "examples": { + "readWithAnnotationParameters": { + "value": "invalid_number,dropped_call" + } } }, { - "name": "Spam", + "name": "QualityIssueAnnotation", "in": "query", - "description": "", + "description": "A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.", + "schema": { + "type": "string" + }, + "examples": { + "readWithAnnotationParameters": { + "value": "choppy_robotic,echo" + } + } + }, + { + "name": "SpamAnnotation", + "in": "query", + "description": "A boolean flag indicating spam calls.", "schema": { "type": "boolean" + }, + "examples": { + "readWithAnnotationParameters": { + "value": true + } } }, { - "name": "CallScores", + "name": "CallScoreAnnotation", "in": "query", - "description": "", + "description": "A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].", "schema": { "type": "string" + }, + "examples": { + "readWithAnnotationParameters": { + "value": "1,2" + } } }, { @@ -1988,16 +2330,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2006,18 +2350,1050 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?PageSize=25&Page=0" + }, + "call_summaries": [] + } + }, + "readWithCarrier": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0" + }, + "call_summaries": [ + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T03:40:25Z", + "start_time": "2021-08-25T03:40:25Z", + "end_time": "2021-08-25T03:40:45Z", + "duration": 20, + "connect_duration": 20, + "call_type": "carrier", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "T-Mobile USA, Inc.", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 40.83885, + "lon": -74.04568 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "carrier": "AT&T Wireless", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 33.42767, + "lon": -86.886475 + }, + "country_code": "US" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxxx", + "direction": "inbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 202, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.48209, + "avg": 0.483035 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 218, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.51868, + "avg": 0.364434 + } + } + } + }, + "tags": [ + "high_packet_loss", + "high_jitter" + ], + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 121, + "disconnected_by": "callee", + "direction": "inbound" + }, + "trust": { + "verified_caller": { + "verified": true + } + }, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + }, + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T02:20:25Z", + "start_time": "2021-08-25T02:20:25Z", + "end_time": "2021-08-25T02:40:45Z", + "duration": 18, + "connect_duration": 18, + "call_type": "carrier", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "T-Mobile USA, Inc.", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 40.83885, + "lon": -74.04568 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "carrier": "AT&T Wireless", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 33.42767, + "lon": -86.886475 + }, + "country_code": "US" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxxx", + "direction": "inbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 100, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.48209, + "avg": 0.483035 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 102, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.51868, + "avg": 0.364434 + } + } + } + }, + "tags": null, + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 121, + "disconnected_by": "callee", + "direction": "inbound" + }, + "trust": { + "verified_caller": { + "verified": true + } + }, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + } + ] + } + }, + "readWithSubaccount": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?CallType=client&StartTime=7d&HasTag=True&Subaccount=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab&PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?CallType=client&StartTime=7d&HasTag=True&Subaccount=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab&PageSize=25&Page=0" + }, + "call_summaries": [ + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "created_time": "2021-08-25T04:16:35Z", + "start_time": "2021-08-25T04:16:36Z", + "end_time": "2021-08-25T04:16:42Z", + "duration": 7, + "connect_duration": 6, + "call_type": "client", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "client:+15555555555", + "connection": "twilio_sdk" + }, + "to": { + "callee": "client:TBBXXXXXXXXXXXX", + "connection": "twilio_sdk" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "54.xxx.xx.xxx", + "external_media_ip": "54.xxx.xx.xxx", + "edge_location": "xxxxxx", + "direction": "inbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 252, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 5.60994, + "avg": 0.933334 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 229, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.960786, + "avg": 0.399859 + } + } + } + }, + "carrier_edge": null, + "tags": [ + "high_pdd" + ], + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 58, + "disconnected_by": "callee", + "direction": "inbound" + }, + "trust": null, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + }, + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "created_time": "2021-08-25T04:16:35Z", + "start_time": "2021-08-25T04:16:37Z", + "end_time": "2021-08-25T04:16:40Z", + "duration": 5, + "connect_duration": 3, + "call_type": "client", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "Verizon", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 40.83885, + "lon": -74.04568 + }, + "country_code": "US" + }, + "to": { + "callee": "client:TBBTXXXXXX", + "connection": "twilio_sdk" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "54.xxx.xx.xxx", + "external_media_ip": "54.xxx.xx.xxx", + "edge_location": "xxxxx", + "direction": "outbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 110, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.05918, + "avg": 0.461966 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 147, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.869174, + "avg": 0.319674 + } + } + } + }, + "carrier_edge": null, + "tags": null, + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 35, + "disconnected_by": "callee", + "direction": "outbound_api" + }, + "trust": null, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + } + ] + } + }, + "readWithTrust": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?Direction=outbound_api%2Coutbound_dial%2Ctrunking_terminating&StartTime=1d&VerifiedCaller=True&PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?Direction=outbound_api%2Coutbound_dial%2Ctrunking_terminating&StartTime=1d&VerifiedCaller=True&PageSize=25&Page=0" + }, + "call_summaries": [ + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T14:31:18Z", + "start_time": "2021-08-25T14:31:22Z", + "end_time": "2021-08-25T14:32:02Z", + "duration": 44, + "connect_duration": 41, + "call_type": "trunking", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "ACS", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 60.268353, + "lon": -141.13632 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "carrier": "Hawaiian Telcom, Inc. - HI", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 20.956036, + "lon": -157.23793 + }, + "country_code": "US" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "54.xxx.xx.xx", + "twilio_signaling_ip": "54.xxx.xx.xx", + "external_signaling_ip": "54.xxx.xx.xx", + "sip_call_id": "xxxxx@0.0.0.0", + "user_agent": "xxxx", + "edge_location": "xxxxx", + "trunk_sid": "xxxxxxx", + "direction": "inbound" + }, + "metrics": { + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 1953, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.76407, + "avg": 0.23138 + }, + "latency": { + "max": 0.386, + "avg": 0.3765 + } + } + } + }, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxx", + "direction": "outbound" + } + }, + "tags": [ + "silence" + ], + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 1990, + "disconnected_by": "caller", + "direction": "trunking_terminating" + }, + "trust": { + "verified_caller": { + "verified": true + } + }, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + }, + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T14:03:31Z", + "start_time": "2021-08-25T14:03:32Z", + "end_time": "2021-08-25T14:03:38Z", + "duration": 7, + "connect_duration": 6, + "call_type": "carrier", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "T-Mobile USA, Inc.", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 40.83885, + "lon": -74.04568 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "carrier": "T-Mobile USA, Inc.", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 34.186115, + "lon": -118.43555 + }, + "country_code": "US" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxx", + "direction": "outbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 229, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.10303, + "avg": 0.449886 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 273, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.410031, + "avg": 0.295951 + } + } + } + }, + "tags": null, + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 315, + "disconnected_by": "callee", + "direction": "outbound_api" + }, + "trust": { + "verified_caller": { + "verified": true + } + }, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + }, + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-24T22:28:17Z", + "start_time": "2021-08-24T22:28:20Z", + "end_time": "2021-08-24T22:28:23Z", + "duration": 4, + "connect_duration": 3, + "call_type": "carrier", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "Hawaiian Telcom, Inc. - HI", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 20.956036, + "lon": -157.23793 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "connection": "pstn" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxx", + "direction": "outbound" + }, + "metrics": { + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 103, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.596712, + "avg": 0.251725 + } + } + } + }, + "tags": [ + "silence" + ], + "attributes": null, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 105, + "disconnected_by": "caller", + "direction": "outbound_dial" + }, + "trust": null, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + } + ] + } + }, + "readWithAbnormalSession": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?CallType=sip%2Ctrunking&CallState=completed&StartTime=15d&AbnormalSession=True&PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?CallType=sip%2Ctrunking&CallState=completed&StartTime=15d&AbnormalSession=True&PageSize=25&Page=0" + }, + "call_summaries": [ + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T14:46:40Z", + "start_time": "2021-08-25T14:46:40Z", + "end_time": "2021-08-25T14:46:52Z", + "duration": 12, + "connect_duration": 12, + "call_type": "sip", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "XO Communications, Inc.", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 40.83885, + "lon": -74.04568 + }, + "country_code": "US" + }, + "to": { + "callee": "sip:xxxx@xx.xxx.xx.xxx", + "connection": "sip_interface" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "xx.xxx.xx.xxx", + "twilio_signaling_ip": "xx.xx.xx.xx", + "external_media_ip": "xx.xxx.xx.xxx", + "external_signaling_ip": "xx.xxx.xx.xxx", + "sip_call_id": "xxxxxxxx@0.0.0.0", + "edge_location": "xxxxx", + "direction": "outbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 525, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.554729, + "avg": 0.229541 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 245, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.03548, + "avg": 0.344092 + } + } + } + }, + "client_edge": null, + "carrier_edge": null, + "tags": null, + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 255, + "disconnected_by": "callee", + "direction": "outbound_dial" + }, + "trust": null, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + }, + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T14:31:18Z", + "start_time": "2021-08-25T14:31:22Z", + "end_time": "2021-08-25T14:32:02Z", + "duration": 44, + "connect_duration": 41, + "call_type": "trunking", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "ACS", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 60.268353, + "lon": -141.13632 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "carrier": "Hawaiian Telcom, Inc. - HI", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 20.956036, + "lon": -157.23793 + }, + "country_code": "US" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "54.xxx.xx.xx", + "twilio_signaling_ip": "54.xxx.xx.xx", + "external_signaling_ip": "54.xxx.xx.xx", + "sip_call_id": "xxxxx@0.0.0.0", + "user_agent": "xxxx", + "edge_location": "xxxxx", + "trunk_sid": "xxxxxxx", + "direction": "inbound" + }, + "metrics": { + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 1953, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.76407, + "avg": 0.23138 + }, + "latency": { + "max": 0.386, + "avg": 0.3765 + } + } + } + }, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxx", + "direction": "outbound" + } + }, + "tags": [ + "silence" + ], + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 1990, + "disconnected_by": "caller", + "direction": "trunking_terminating" + }, + "trust": { + "verified_caller": { + "verified": true + } + }, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + } + ] + } + }, + "readWithAnnotationParameters": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?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" + } + ] } } } @@ -2031,10 +3407,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCallSummaries", - "x-maturity": [ - "GA" - ] + "operationId": "ListCallSummaries" } }, "/v1/Conferences/{ConferenceSid}": { @@ -2043,19 +3416,27 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "conference_sid", "account_sid" ], - "pathType": "instance", "dependentProperties": { - "conference_participant": "{conference_sid: conference_sid}" - } + "conference_participants": { + "mapping": { + "conference_sid": "conference_sid" + }, + "resource_url": "/v1/Conferences/{conference_sid}/Participants" + } + }, + "pathType": "instance" }, "get": { - "description": "Fetch a specific Conference.", + "description": "Get a specific Conference Summary.", + "tags": [ + "InsightsV1Conference" + ], "parameters": [ { "name": "ConferenceSid", @@ -2076,6 +3457,55 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.conference" + }, + "examples": { + "fetch": { + "value": { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference1", + "start_time": "2021-10-08T02:58:51Z", + "create_time": "2021-10-08T02:58:47Z", + "end_time": "2021-10-08T03:00:02Z", + "duration_seconds": 76, + "connect_duration_seconds": 72, + "status": "completed", + "max_participants": 250, + "max_concurrent_participants": 4, + "unique_participants": 4, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": "us1", + "mixer_region_requested": "us1", + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 1, + "region_configuration": 0, + "participant_behavior": 3 + }, + "tags": [ + "duplicate_identity", + "detected_silence", + "participant_behavior_issues" + ], + "tag_info": { + "duplicate_identity": [ + { + "participant_identity": "client:+10000000000", + "participant_sids": [ + "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ] + } + ] + }, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + } } } }, @@ -2087,10 +3517,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConference", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConference" } }, "/v1/Conferences": { @@ -2099,19 +3526,27 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "conference_sid", "account_sid" ], - "pathType": "list", "dependentProperties": { - "conference_participant": "{conference_sid: conference_sid}" - } + "conference_participants": { + "mapping": { + "conference_sid": "conference_sid" + }, + "resource_url": "/v1/Conferences/{conference_sid}/Participants" + } + }, + "pathType": "list" }, "get": { - "description": "Retrieve a list of Conferences.", + "description": "Get a list of Conference Summaries.", + "tags": [ + "InsightsV1Conference" + ], "parameters": [ { "name": "ConferenceSid", @@ -2127,6 +3562,17 @@ "description": "Custom label for the conference resource, up to 64 characters.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readWithFriendlynameStartfailure": { + "value": "outboundConfCallTransferThrice_1" + } } }, { @@ -2135,6 +3581,14 @@ "description": "Conference status.", "schema": { "type": "string" + }, + "examples": { + "readWithRegion": { + "value": "completed" + }, + "readWithFriendlynameStartfailure": { + "value": "not_started" + } } }, { @@ -2143,6 +3597,11 @@ "description": "Conferences created after the provided timestamp specified in ISO 8601 format", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "2021-10-09T17:20:53Z" + } } }, { @@ -2151,6 +3610,11 @@ "description": "Conferences created before the provided timestamp specified in ISO 8601 format.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "2021-10-12T18:37:53Z" + } } }, { @@ -2159,6 +3623,11 @@ "description": "Twilio region where the conference media was mixed.", "schema": { "type": "string" + }, + "examples": { + "readWithRegion": { + "value": "au1" + } } }, { @@ -2167,6 +3636,11 @@ "description": "Tags applied by Twilio for common potential configuration, quality, or performance issues.", "schema": { "type": "string" + }, + "examples": { + "readWithDuplicateIdentity": { + "value": "duplicate_identity" + } } }, { @@ -2186,6 +3660,11 @@ "description": "Potential configuration, behavior, or performance issues detected during the conference.", "schema": { "type": "string" + }, + "examples": { + "readWithDetectedIssueEndreason": { + "value": "call_quality" + } } }, { @@ -2194,6 +3673,11 @@ "description": "Conference end reason; e.g. last participant left, modified by API, etc.", "schema": { "type": "string" + }, + "examples": { + "readWithDetectedIssueEndreason": { + "value": "participant_with_end_conference_on_exit_left" + } } }, { @@ -2239,16 +3723,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2257,18 +3743,347 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0", + "next_page_url": null, + "key": "conferences" + }, + "conferences": [ + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 1", + "start_time": "2021-10-12T18:11:10Z", + "create_time": "2021-10-12T18:11:09Z", + "end_time": "2021-10-12T18:11:15Z", + "duration_seconds": 7, + "connect_duration_seconds": 5, + "status": "completed", + "max_participants": 250, + "max_concurrent_participants": 2, + "unique_participants": 2, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": "us1", + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 1, + "region_configuration": 0, + "participant_behavior": 0 + }, + "tags": null, + "tag_info": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + }, + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 2", + "start_time": null, + "create_time": "2021-10-12T18:09:21Z", + "end_time": "2021-10-12T18:09:21Z", + "duration_seconds": 1, + "connect_duration_seconds": 0, + "status": "completed", + "max_participants": 250, + "max_concurrent_participants": 2, + "unique_participants": 3, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "mixer_region": "us1", + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 1, + "region_configuration": 0, + "participant_behavior": 0 + }, + "tags": [ + "detected_silence", + "participant_behavior_issues" + ], + "tag_info": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants" + } + } + ] + } + }, + "readWithRegion": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences?MixerRegion=au1&Status=completed&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences?MixerRegion=au1&Status=completed&PageSize=25&Page=0", + "next_page_url": null, + "key": "conferences" + }, + "conferences": [ + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 1", + "start_time": "2021-10-12T18:19:10Z", + "create_time": "2021-10-12T18:19:09Z", + "end_time": "2021-10-12T18:20:17Z", + "duration_seconds": 7, + "connect_duration_seconds": 5, + "status": "completed", + "max_participants": 250, + "max_concurrent_participants": 2, + "unique_participants": 2, + "end_reason": "participant_with_end_conference_on_exit_kicked", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": "au1", + "mixer_region_requested": "au1", + "recording_enabled": true, + "processing_state": "complete", + "detected_issues": { + "call_quality": 0, + "region_configuration": 2, + "participant_behavior": 0 + }, + "tags": [ + "region_configuration_issues" + ], + "tag_info": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + }, + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 2", + "start_time": "2021-10-12T18:16:53Z", + "create_time": "2021-10-12T18:16:51Z", + "end_time": "2021-10-12T18:17:20Z", + "duration_seconds": 30, + "connect_duration_seconds": 27, + "status": "completed", + "max_participants": 250, + "max_concurrent_participants": 2, + "unique_participants": 2, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "mixer_region": "au1", + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 0, + "region_configuration": 2, + "participant_behavior": 3 + }, + "tags": [ + "detected_silence", + "region_configuration_issues", + "participant_behavior_issues" + ], + "tag_info": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants" + } + } + ] + } + }, + "readWithFriendlynameStartfailure": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences?FriendlyName=outboundConfCallTransferThrice_1&Status=not_started&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences?FriendlyName=outboundConfCallTransferThrice_1&Status=not_started&PageSize=25&Page=0", + "next_page_url": null, + "key": "conferences" + }, + "conferences": [ + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "outboundConfCallTransferThrice_1", + "start_time": null, + "create_time": "2021-11-18T00:09:09Z", + "end_time": "2021-11-18T00:09:52Z", + "duration_seconds": 7, + "connect_duration_seconds": 0, + "status": "not_started", + "max_participants": 250, + "max_concurrent_participants": 1, + "unique_participants": 1, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": null, + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 0, + "region_configuration": 0, + "participant_behavior": 0 + }, + "tags": [ + "participant_behavior_issues", + "start_failure" + ], + "tag_info": { + "start_failure": { + "reason": "no_concurrent_participants" + } + }, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + ] + } + }, + "readWithDuplicateIdentity": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences?Tags=duplicate_identity&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences?Tags=duplicate_identity&PageSize=25&Page=0", + "next_page_url": null, + "key": "conferences" + }, + "conferences": [ + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 1", + "start_time": "2021-11-17T16:21:45Z", + "create_time": "2021-11-17T16:21:40Z", + "end_time": "2021-11-17T16:22:11Z", + "duration_seconds": 32, + "connect_duration_seconds": 27, + "status": "not_started", + "max_participants": 250, + "max_concurrent_participants": 3, + "unique_participants": 4, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": "us1", + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 0, + "region_configuration": 0, + "participant_behavior": 0 + }, + "tags": [ + "duplicate_identity", + "detected_silence", + "participant_behavior_issues" + ], + "tag_info": { + "duplicate_identity": [ + { + "participant_identity": "client:+10000000000", + "participant_sids": [ + "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ] + } + ] + }, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + ] + } + }, + "readWithDetectedIssueEndreason": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences?DetectedIssues=call_quality&EndReason=participant_with_end_conference_on_exit_left&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences?DetectedIssues=call_quality&EndReason=participant_with_end_conference_on_exit_left&PageSize=25&Page=0", + "next_page_url": null, + "key": "conferences" + }, + "conferences": [ + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 1", + "start_time": "2021-11-17T16:21:45Z", + "create_time": "2021-11-17T16:21:40Z", + "end_time": "2021-11-17T16:22:11Z", + "duration_seconds": 32, + "connect_duration_seconds": 27, + "status": "not_started", + "max_participants": 250, + "max_concurrent_participants": 3, + "unique_participants": 3, + "end_reason": "participant_with_end_conference_on_exit_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": "us1", + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 3, + "region_configuration": 0, + "participant_behavior": 1 + }, + "tags": [ + "high_packet_loss", + "low_mos", + "participant_behavior_issues", + "quality_warnings", + "high_jitter", + "detected_silence" + ], + "tag_info": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + ] } } } @@ -2282,10 +4097,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConference", - "x-maturity": [ - "GA" - ] + "operationId": "ListConference" } }, "/v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}": { @@ -2294,7 +4106,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "participant_sid", @@ -2302,12 +4114,15 @@ "call_sid", "account_sid" ], - "pathType": "instance", "parent": "/Conferences/{ConferenceSid}", - "mountName": "conference_participants" + "mountName": "conference_participants", + "pathType": "instance" }, "get": { - "description": "Fetch a specific Conference Participant Summary.", + "description": "Get a specific Conference Participant Summary for a Conference.", + "tags": [ + "InsightsV1ConferenceParticipant" + ], "parameters": [ { "name": "ConferenceSid", @@ -2356,6 +4171,79 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.conference.conference_participant" + }, + "examples": { + "fetch": { + "value": { + "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_direction": "outbound", + "from": "+10000000000", + "to": "+1000000001", + "call_status": "completed", + "country_code": "US", + "is_moderator": true, + "join_time": "2021-10-08T02:58:59Z", + "leave_time": "2021-10-08T03:00:02Z", + "duration_seconds": 64, + "outbound_queue_length": 0, + "outbound_time_in_queue": 965, + "jitter_buffer_size": null, + "is_coach": false, + "coached_participants": null, + "participant_region": "us1", + "conference_region": "us1", + "call_type": "carrier", + "processing_state": "complete", + "properties": { + "start_conference_on_enter": false, + "end_conference_on_exit": false, + "play_early_media": false, + "enter_muted": true, + "beep_on_enter": false, + "beep_on_exit": false + }, + "events": { + "mute": [ + 1633705131000 + ] + }, + "metrics": { + "inbound": { + "total_packets_lost": 0, + "total_packets_received": 49, + "packet_loss_percentage": 0.0, + "jitter": { + "avg": 0.34, + "max": 0.53 + }, + "latency": { + "avg": 0.0, + "max": 0.0 + }, + "mos": 4.4 + }, + "outbound": { + "total_packets_lost": 0, + "total_packets_received": 126, + "packet_loss_percentage": 0, + "jitter": { + "avg": 0.01, + "max": 0.01 + }, + "latency": { + "avg": 0, + "max": 0 + }, + "mos": 4.4 + } + }, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2367,10 +4255,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConferenceParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConferenceParticipant" } }, "/v1/Conferences/{ConferenceSid}/Participants": { @@ -2379,7 +4264,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "participant_sid", @@ -2387,12 +4272,15 @@ "call_sid", "account_sid" ], - "pathType": "list", "parent": "/Conferences/{ConferenceSid}", - "mountName": "conference_participants" + "mountName": "conference_participants", + "pathType": "list" }, "get": { - "description": "List Conference Participants.", + "description": "Get a list of Conference Participants Summaries for a Conference.", + "tags": [ + "InsightsV1ConferenceParticipant" + ], "parameters": [ { "name": "ConferenceSid", @@ -2420,6 +4308,17 @@ "description": "User-specified label for a participant.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readWithLabel": { + "value": "client" + } } }, { @@ -2473,16 +4372,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2491,18 +4392,250 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0", + "next_page_url": null, + "key": "participants" + }, + "participants": [ + { + "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_direction": "outbound", + "from": "+10000000000", + "to": "+10000000001", + "call_status": "completed", + "country_code": "US", + "is_moderator": true, + "join_time": "2021-10-08T02:58:51Z", + "leave_time": "2021-10-08T02:59:55Z", + "duration_seconds": 65, + "outbound_queue_length": 0, + "outbound_time_in_queue": 3361, + "jitter_buffer_size": null, + "is_coach": false, + "coached_participants": null, + "participant_region": "us1", + "conference_region": "us1", + "call_type": "carrier", + "processing_state": "complete", + "properties": { + "start_conference_on_enter": true, + "end_conference_on_exit": false, + "play_early_media": true, + "enter_muted": false, + "beep_on_enter": false, + "beep_on_exit": false + }, + "metrics": { + "inbound": { + "total_packets_lost": 0, + "total_packets_received": 70, + "packet_loss_percentage": 0.0, + "jitter": { + "avg": 0.41, + "max": 0.84 + }, + "latency": { + "avg": 0.0, + "max": 0.0 + }, + "mos": 4.4 + }, + "outbound": { + "total_packets_lost": 0, + "total_packets_received": 126, + "packet_loss_percentage": 0, + "jitter": { + "avg": 0.01, + "max": 0.01 + }, + "latency": { + "avg": 0, + "max": 0 + }, + "mos": 4.4 + } + }, + "events": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_direction": "outbound", + "from": "+10000000000", + "to": "+10000000002", + "call_status": "completed", + "country_code": "US", + "is_moderator": true, + "join_time": "2021-10-08T02:58:52Z", + "leave_time": "2021-10-08T02:59:54Z", + "duration_seconds": 63, + "outbound_queue_length": 0, + "outbound_time_in_queue": 321, + "jitter_buffer_size": null, + "is_coach": false, + "coached_participants": null, + "participant_region": "us1", + "conference_region": "us1", + "call_type": "carrier", + "processing_state": "complete", + "properties": { + "start_conference_on_enter": false, + "end_conference_on_exit": false, + "early_media": false, + "enter_muted": true, + "beep_on_enter": false, + "beep_on_exit": false + }, + "metrics": { + "inbound": { + "total_packets_lost": 0, + "total_packets_received": 16, + "packet_loss_percentage": 0, + "jitter": { + "avg": 0.26, + "max": 0.45 + }, + "latency": { + "avg": 0, + "max": 0 + }, + "mos": 4.4 + }, + "outbound": { + "total_packets_lost": 0, + "total_packets_received": 42, + "packet_loss_percentage": 0, + "jitter": { + "avg": 0.03, + "max": 0.08 + }, + "latency": { + "avg": 0, + "max": 0 + }, + "mos": 4.4, + "tags": [ + "silent" + ] + } + }, + "events": { + "mute": [ + 1633705131000 + ] + }, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } + ] + } + }, + "readWithLabel": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0", + "next_page_url": null, + "key": "participants" + }, + "participants": [ + { + "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_direction": "outbound", + "from": "+10000000000", + "to": "+10000000001", + "call_status": "completed", + "country_code": "US", + "is_moderator": true, + "join_time": "2021-10-08T02:58:51Z", + "leave_time": "2021-10-08T02:59:55Z", + "duration_seconds": 65, + "label": "client", + "outbound_queue_length": 0, + "outbound_time_in_queue": 3361, + "jitter_buffer_size": null, + "is_coach": false, + "coached_participants": null, + "participant_region": "us1", + "conference_region": "us1", + "call_type": "carrier", + "processing_state": "complete", + "properties": { + "start_conference_on_enter": true, + "end_conference_on_exit": false, + "play_early_media": true, + "enter_muted": false, + "beep_on_enter": false, + "beep_on_exit": false + }, + "metrics": { + "inbound": { + "total_packets_lost": 0, + "total_packets_received": 70, + "packet_loss_percentage": 0.0, + "jitter": { + "avg": 0.41, + "max": 0.84 + }, + "latency": { + "avg": 0.0, + "max": 0.0 + }, + "mos": 4.4 + }, + "outbound": { + "total_packets_lost": 0, + "total_packets_received": 96, + "packet_loss_percentage": 0, + "jitter": { + "avg": 0.01, + "max": 0.01 + }, + "latency": { + "avg": 0, + "max": 0 + }, + "mos": 4.4 + } + }, + "events": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -2516,10 +4649,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConferenceParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListConferenceParticipant" } }, "/v1/Voice/{CallSid}/Events": { @@ -2528,7 +4658,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "timestamp", @@ -2537,16 +4667,19 @@ "edge", "name" ], - "pathType": "list", - "parent": "/Voice/{Sid}" + "parent": "/Voice/{Sid}", + "pathType": "list" }, "get": { - "description": "", + "description": "Get a list of Call Insight Events for a Call.", + "tags": [ + "InsightsV1Event" + ], "parameters": [ { "name": "CallSid", "in": "path", - "description": "", + "description": "The unique SID identifier of the Call.", "schema": { "type": "string", "minLength": 34, @@ -2558,7 +4691,7 @@ { "name": "Edge", "in": "query", - "description": "", + "description": "The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.", "schema": { "type": "string", "$ref": "#/components/schemas/event_enum_twilio_edge" @@ -2607,16 +4740,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2625,18 +4760,136 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "events", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0" + }, + "events": [ + { + "timestamp": "2019-09-19T22:15:23Z", + "call_sid": "CA03a02b156c6faa96c86906f7e9ad0f38", + "account_sid": "AC998c10b68cbfda9f67277f7d8f4439c9", + "edge": "sdk_edge", + "group": "connection", + "name": "error", + "level": "ERROR", + "sdk_edge": { + "error": { + "code": 31600 + }, + "metadata": { + "client_name": "GTI9300323095d271b890c91568931321395", + "location": { + "lat": 37.4192, + "lon": -122.0574 + }, + "city": "Mountain View", + "country_code": "US", + "country_subdivision": "California", + "ip_address": "108.177.7.83", + "sdk": { + "type": "twilio-voice-android", + "version": "4.5.1", + "platform": "android", + "selected_region": "gll", + "os": { + "name": "android", + "version": "4.3" + }, + "device": { + "model": "GT-I9300", + "type": "GT-I9300", + "vendor": "samsung", + "arch": "armeabi-v7a" + } + } + } + }, + "client_edge": null, + "carrier_edge": null, + "sip_edge": null + } + ] + } + }, + "readDeep": { + "value": { + "meta": { + "page": 10, + "page_size": 5, + "first_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=0", + "previous_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=9&PageToken=DP10", + "next_page_url": null, + "key": "events", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=10" + }, + "events": [ + { + "timestamp": "2019-09-19T22:15:23Z", + "call_sid": "CA03a02b156c6faa96c86906f7e9ad0f38", + "account_sid": "AC998c10b68cbfda9f67277f7d8f4439c9", + "edge": "sdk_edge", + "group": "connection", + "name": "error", + "level": "ERROR", + "sdk_edge": { + "error": { + "code": 31600 + }, + "metadata": { + "client_name": "GTI9300323095d271b890c91568931321395", + "location": { + "lat": 37.4192, + "lon": -122.0574 + }, + "city": "Mountain View", + "country_code": "US", + "country_subdivision": "California", + "ip_address": "108.177.7.83", + "sdk": { + "type": "twilio-voice-android", + "version": "4.5.1", + "platform": "android", + "selected_region": "gll", + "os": { + "name": "android", + "version": "4.3" + }, + "device": { + "model": "GT-I9300", + "type": "GT-I9300", + "vendor": "samsung", + "arch": "armeabi-v7a" + } + } + } + }, + "client_edge": null, + "carrier_edge": null, + "sip_edge": null + } + ] } } } @@ -2650,10 +4903,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEvent", - "x-maturity": [ - "Preview" - ] + "operationId": "ListEvent" } }, "/v1/Voice/{CallSid}/Metrics": { @@ -2662,7 +4912,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "timestamp", @@ -2671,16 +4921,19 @@ "edge", "direction" ], - "pathType": "list", - "parent": "/Voice/{Sid}" + "parent": "/Voice/{Sid}", + "pathType": "list" }, "get": { - "description": "", + "description": "Get a list of Call Metrics for a Call.", + "tags": [ + "InsightsV1Metric" + ], "parameters": [ { "name": "CallSid", "in": "path", - "description": "", + "description": "The unique SID identifier of the Call.", "schema": { "type": "string", "minLength": 34, @@ -2692,19 +4945,29 @@ { "name": "Edge", "in": "query", - "description": "", + "description": "The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.", "schema": { "type": "string", "$ref": "#/components/schemas/metric_enum_twilio_edge" + }, + "examples": { + "readFull": { + "value": "sdk_edge" + } } }, { "name": "Direction", "in": "query", - "description": "", + "description": "The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`.", "schema": { "type": "string", "$ref": "#/components/schemas/metric_enum_stream_direction" + }, + "examples": { + "readFull": { + "value": "both" + } } }, { @@ -2750,16 +5013,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2768,18 +5033,124 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "metrics", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?PageSize=50&Page=0" + }, + "metrics": [ + { + "timestamp": "2019-10-07T22:32:06Z", + "call_sid": "CA7569efe0253644fa4a88aa97beca3310", + "account_sid": "AC998c10b68cbfda9f67277f7d8f4439c9", + "edge": "sdk_edge", + "direction": "both", + "sdk_edge": { + "interval": { + "packets_received": 50, + "packets_lost": 0, + "audio_in": { + "value": 81.0 + }, + "audio_out": { + "value": 5237.0 + }, + "jitter": { + "value": 9 + }, + "mos": { + "value": 4.39 + }, + "rtt": { + "value": 81 + } + }, + "cumulative": { + "bytes_received": 547788, + "bytes_sent": 329425, + "packets_received": 3900, + "packets_lost": 0, + "packets_sent": 3934 + } + }, + "client_edge": null, + "carrier_edge": null, + "sip_edge": null + } + ] + } + }, + "readFull": { + "value": { + "meta": { + "page": 10, + "page_size": 5, + "first_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=0", + "previous_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=9&PageToken=DP10", + "next_page_url": null, + "key": "metrics", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=10" + }, + "metrics": [ + { + "timestamp": "2019-10-07T22:32:06Z", + "call_sid": "CA7569efe0253644fa4a88aa97beca3310", + "account_sid": "AC998c10b68cbfda9f67277f7d8f4439c9", + "edge": "sdk_edge", + "direction": "both", + "sdk_edge": { + "interval": { + "packets_received": 50, + "packets_lost": 0, + "audio_in": { + "value": 81.0 + }, + "audio_out": { + "value": 5237.0 + }, + "jitter": { + "value": 9 + }, + "mos": { + "value": 4.39 + }, + "rtt": { + "value": 81 + } + }, + "cumulative": { + "bytes_received": 547788, + "bytes_sent": 329425, + "packets_received": 3900, + "packets_lost": 0, + "packets_sent": 3934 + } + }, + "client_edge": null, + "carrier_edge": null, + "sip_edge": null + } + ] } } } @@ -2793,10 +5164,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMetric", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMetric" } }, "/v1/Voice/{CallSid}/Summary": { @@ -2805,7 +5173,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "call_type", @@ -2813,17 +5181,20 @@ "processing_state", "duration" ], - "pathType": "instance", "parent": "/Voice/{Sid}", - "className": "call_summary" + "className": "call_summary", + "pathType": "instance" }, "get": { - "description": "", + "description": "Get a specific Call Summary.", + "tags": [ + "InsightsV1CallSummary" + ], "parameters": [ { "name": "CallSid", "in": "path", - "description": "", + "description": "The unique SID identifier of the Call.", "schema": { "type": "string", "minLength": 34, @@ -2835,7 +5206,7 @@ { "name": "ProcessingState", "in": "query", - "description": "", + "description": "The Processing State of this Call Summary. One of `complete`, `partial` or `all`.", "schema": { "type": "string", "$ref": "#/components/schemas/summary_enum_processing_state" @@ -2848,6 +5219,49 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.call.summary" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_type": "carrier", + "call_state": "ringing", + "answered_by": "machine_start", + "processing_state": "complete", + "created_time": "2015-07-30T20:00:00Z", + "start_time": "2015-07-30T20:00:00Z", + "end_time": "2015-07-30T20:00:00Z", + "duration": 100, + "connect_duration": 99, + "from": {}, + "to": {}, + "carrier_edge": {}, + "client_edge": {}, + "sdk_edge": {}, + "sip_edge": {}, + "tags": [ + "tags" + ], + "attributes": {}, + "properties": {}, + "trust": {}, + "annotation": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answered_by": "human", + "connectivity_issue": "invalid_number", + "quality_issues": [ + "low_volume" + ], + "spam": true, + "call_score": 2, + "comment": "this is a call", + "incident": "https://twilio.zendesk.com/support/tickets/17353089" + }, + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Summary" + } + } } } }, @@ -2859,10 +5273,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSummary", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSummary" } }, "/v1/Video/Rooms/{RoomSid}/Participants/{ParticipantSid}": { @@ -2871,16 +5282,19 @@ "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.", + "tags": [ + "InsightsV1Participant" + ], "parameters": [ { "name": "RoomSid", @@ -2907,6 +5321,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.video_room_summary.video_participant_summary" + }, + "examples": { + "fetch": { + "value": { + "publisher_info": {}, + "edge_location": "ashburn", + "join_time": "2015-07-30T20:00:00Z", + "leave_time": "2015-07-30T20:00:00Z", + "end_reason": "disconnected_via_api", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "error_code": 0, + "media_region": "us1", + "properties": {}, + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "error_code_url": "error_code_url", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "codecs": [ + "VP8" + ], + "status": "in_progress", + "duration_sec": 50000000, + "participant_identity": "participant_identity", + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2918,10 +5357,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVideoParticipantSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchVideoParticipantSummary" } }, "/v1/Video/Rooms/{RoomSid}/Participants": { @@ -2930,16 +5366,19 @@ "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.", + "tags": [ + "InsightsV1Participant" + ], "parameters": [ { "name": "RoomSid", @@ -2993,16 +5432,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3011,18 +5452,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "key": "participants", + "first_page_url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "page_size": 50, + "next_page_url": null, + "page": 0, + "previous_page_url": null + }, + "participants": [] + } + }, + "readFull": { + "value": { + "meta": { + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "key": "participants", + "first_page_url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "page_size": 50, + "next_page_url": null, + "page": 0, + "previous_page_url": null + }, + "participants": [ + { + "publisher_info": {}, + "edge_location": "ashburn", + "join_time": "2015-07-30T20:00:00Z", + "leave_time": "2015-07-30T20:00:00Z", + "end_reason": "disconnected_via_api", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "error_code": 53205, + "media_region": "us1", + "properties": {}, + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "error_code_url": "error_code_url", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "codecs": [ + "VP8" + ], + "status": "in_progress", + "duration_sec": 50000000, + "participant_identity": "participant_identity", + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -3036,10 +5527,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVideoParticipantSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "ListVideoParticipantSummary" } }, "/v1/Video/Rooms/{RoomSid}": { @@ -3048,19 +5536,27 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "room_sid", "create_time" ], - "pathType": "instance", "dependentProperties": { - "participant": "{room_sid: room_sid}" - } + "participants": { + "mapping": { + "room_sid": "room_sid" + }, + "resource_url": "/v1/Video/Rooms/{room_sid}/Participants" + } + }, + "pathType": "instance" }, "get": { "description": "Get Video Log Analyzer data for a Room.", + "tags": [ + "InsightsV1Room" + ], "parameters": [ { "name": "RoomSid", @@ -3078,6 +5574,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.video_room_summary" + }, + "examples": { + "fetch": { + "value": { + "room_type": "go", + "unique_participant_identities": 0, + "codecs": [ + "VP8" + ], + "max_participants": 0, + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "create_time": "2015-07-30T20:00:00Z", + "end_reason": "room_ended_via_api", + "duration_sec": 50000000, + "room_status": "in_progress", + "media_region": "us1", + "recording_enabled": false, + "edge_location": "ashburn", + "max_concurrent_participants": 0, + "unique_participants": 0, + "room_name": "room_name", + "created_method": "sdk", + "total_participant_duration_sec": 50000000, + "status_callback_method": "GET", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "end_time": "2015-07-30T20:00:00Z", + "total_recording_duration_sec": 50000000, + "processing_state": "complete", + "concurrent_participants": 0, + "status_callback": "http://www.example.com", + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + } } } }, @@ -3089,10 +5621,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVideoRoomSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchVideoRoomSummary" } }, "/v1/Video/Rooms": { @@ -3101,19 +5630,27 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "room_sid", "create_time" ], - "pathType": "list", "dependentProperties": { - "participant": "{room_sid: room_sid}" - } + "participants": { + "mapping": { + "room_sid": "room_sid" + }, + "resource_url": "/v1/Video/Rooms/{room_sid}/Participants" + } + }, + "pathType": "list" }, "get": { "description": "Get a list of Programmable Video Rooms.", + "tags": [ + "InsightsV1Room" + ], "parameters": [ { "name": "RoomType", @@ -3208,16 +5745,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3226,18 +5765,79 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0", + "url": "https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0", + "page_size": 50, + "next_page_url": null, + "key": "rooms", + "page": 0, + "previous_page_url": null + }, + "rooms": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0", + "url": "https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0", + "page_size": 50, + "next_page_url": null, + "key": "rooms", + "page": 0, + "previous_page_url": null + }, + "rooms": [ + { + "room_type": "go", + "unique_participant_identities": 0, + "codecs": [ + "VP8" + ], + "max_participants": 0, + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "create_time": "2015-07-30T20:00:00Z", + "end_reason": "room_ended_via_api", + "duration_sec": 50000000, + "room_status": "in_progress", + "media_region": "us1", + "recording_enabled": false, + "edge_location": "ashburn", + "max_concurrent_participants": 0, + "unique_participants": 0, + "room_name": "room_name", + "created_method": "sdk", + "total_participant_duration_sec": 50000000, + "status_callback_method": "GET", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "end_time": "2015-07-30T20:00:00Z", + "total_recording_duration_sec": 50000000, + "processing_state": "complete", + "concurrent_participants": 0, + "status_callback": "http://www.example.com", + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + ] } } } @@ -3251,10 +5851,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVideoRoomSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "ListVideoRoomSummary" } } }, @@ -3263,18 +5860,44 @@ "url": "https://insights.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "InsightsV1Annotation" + }, + { + "name": "InsightsV1Call" + }, + { + "name": "InsightsV1CallSummaries" + }, + { + "name": "InsightsV1CallSummary" + }, + { + "name": "InsightsV1Conference" + }, { - "name": "GA", - "description": "This product is Generally Available." + "name": "InsightsV1ConferenceParticipant" }, { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "name": "InsightsV1Event" }, { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." + "name": "InsightsV1Metric" + }, + { + "name": "InsightsV1Participant" + }, + { + "name": "InsightsV1Room" + }, + { + "name": "InsightsV1Setting" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_intelligence_v2.json b/spec/json/twilio_intelligence_v2.json index 6606c98e..4ccd8102 100644 --- a/spec/json/twilio_intelligence_v2.json +++ b/spec/json/twilio_intelligence_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "intelligence.v2.transcript.media": { "type": "object", @@ -108,6 +114,10 @@ "nullable": true, "description": "List of text extraction results. This might be available on classify-extract model outputs." }, + "text_generation_results": { + "nullable": true, + "description": "Output of a text generation operator for example Conversation Sumamary." + }, "transcript_sid": { "type": "string", "minLength": 34, @@ -160,7 +170,13 @@ "transcript": { "type": "string", "nullable": true, - "description": "Transcript text." + "description": "Transcript text.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "sid": { "type": "string", @@ -205,7 +221,7 @@ "data_logging": { "type": "boolean", "nullable": true, - "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." + "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "date_created": { "type": "string", @@ -323,7 +339,7 @@ "data_logging": { "type": "boolean", "nullable": true, - "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." + "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "language_code": { "type": "string", @@ -382,12 +398,6 @@ "unknown" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -403,7 +413,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -413,18 +423,21 @@ "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", + "tags": [ + "IntelligenceV2Media" + ], "parameters": [ { "name": "Sid", @@ -441,9 +454,14 @@ { "name": "Redacted", "in": "query", - "description": "Grant access to PII Redacted/Unredacted Media. The default is `true` to access redacted media.", + "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" + } } } ], @@ -453,6 +471,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript.media" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "media_url": "https://media.server.com/media.wav", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + }, + "fetchParams": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "media_url": "https://media.server.com/media.wav", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } } } }, @@ -464,10 +502,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMedia", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchMedia" } }, "/v2/Transcripts/{TranscriptSid}/OperatorResults": { @@ -476,16 +511,19 @@ "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.", + "tags": [ + "IntelligenceV2OperatorResult" + ], "parameters": [ { "name": "TranscriptSid", @@ -502,9 +540,14 @@ { "name": "Redacted", "in": "query", - "description": "Grant access to PII redacted/unredacted Language Understanding operator. The default is True.", + "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" + } } }, { @@ -550,16 +593,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -568,17 +613,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "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" } } } @@ -593,10 +686,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListOperatorResult", - "x-maturity": [ - "Beta" - ] + "operationId": "ListOperatorResult" } }, "/v2/Transcripts/{TranscriptSid}/OperatorResults/{OperatorSid}": { @@ -605,16 +695,19 @@ "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.", + "tags": [ + "IntelligenceV2OperatorResult" + ], "parameters": [ { "name": "TranscriptSid", @@ -643,9 +736,14 @@ { "name": "Redacted", "in": "query", - "description": "Grant access to PII redacted/unredacted Language Understanding operator. The default is True.", + "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" + } } } ], @@ -655,6 +753,29 @@ "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" + } + } } } }, @@ -666,10 +787,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOperatorResult", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchOperatorResult" } }, "/v2/Transcripts/{TranscriptSid}/Sentences": { @@ -678,7 +796,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -689,11 +807,14 @@ "end_time", "confidence" ], - "pathType": "list", - "parent": "/Transcripts/{Sid}" + "parent": "/Transcripts/{Sid}", + "pathType": "list" }, "get": { "description": "Get all Transcript Sentences by TranscriptSid", + "tags": [ + "IntelligenceV2Sentence" + ], "parameters": [ { "name": "TranscriptSid", @@ -710,9 +831,14 @@ { "name": "Redacted", "in": "query", - "description": "Grant access to PII Redacted/Unredacted Sentences. The default is `true` to access redacted sentences.", + "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" + } } }, { @@ -758,16 +884,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -776,17 +904,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "sentences": [ + { + "media_channel": 1, + "sentence_index": 0, + "start_time": null, + "end_time": null, + "transcript": "test test", + "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "confidence": null + } + ], + "meta": { + "key": "sentences", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null + } + } + }, + "readParams": { + "value": { + "sentences": [ + { + "media_channel": 1, + "sentence_index": 0, + "start_time": null, + "end_time": null, + "transcript": "test test", + "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "confidence": null + } + ], + "meta": { + "key": "sentences", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null } } } @@ -801,10 +977,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSentence", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSentence" } }, "/v2/Services": { @@ -813,7 +986,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -827,12 +1000,36 @@ }, "post": { "description": "Create a new Service for the given Account", + "tags": [ + "IntelligenceV2Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.service" + }, + "examples": { + "create": { + "value": { + "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "something", + "friendly_name": "some friendly name", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "auto_redaction": false, + "media_redaction": false, + "auto_transcribe": true, + "data_logging": true, + "language_code": "en-US", + "webhook_url": "https://www.twilio.com", + "webhook_http_method": "POST", + "version": 1, + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -845,9 +1042,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -865,7 +1059,7 @@ }, "DataLogging": { "type": "boolean", - "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." + "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "FriendlyName": { "type": "string", @@ -896,6 +1090,17 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "something", + "FriendlyName": "some friendly name", + "LanguageCode": "en-US", + "WebhookUrl": "https://www.twilio.com", + "WebhookHttpMethod": "POST" + } + } } } } @@ -903,6 +1108,9 @@ }, "get": { "description": "Retrieves a list of all Services for an account.", + "tags": [ + "IntelligenceV2Service" + ], "parameters": [ { "name": "PageSize", @@ -947,16 +1155,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -965,17 +1175,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "services": [ + { + "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "something", + "friendly_name": "some friendly name", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "auto_redaction": false, + "media_redaction": false, + "auto_transcribe": true, + "data_logging": true, + "language_code": "en-US", + "webhook_url": "https://www.twilio.com", + "webhook_http_method": "POST", + "version": 1, + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "key": "services", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "services": [], + "meta": { + "key": "services", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0" } } } @@ -990,10 +1246,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" } }, "/v2/Services/{Sid}": { @@ -1002,7 +1255,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1016,6 +1269,9 @@ }, "delete": { "description": "Delete a specific Service.", + "tags": [ + "IntelligenceV2Service" + ], "parameters": [ { "name": "Sid", @@ -1037,13 +1293,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "get": { "description": "Fetch a specific Service.", + "tags": [ + "IntelligenceV2Service" + ], "parameters": [ { "name": "Sid", @@ -1061,6 +1317,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.service" + }, + "examples": { + "fetch": { + "value": { + "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "something", + "friendly_name": "some friendly name", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "auto_redaction": false, + "media_redaction": false, + "auto_transcribe": true, + "data_logging": true, + "language_code": "en-US", + "webhook_url": "https://www.twilio.com", + "webhook_http_method": "POST", + "version": 1, + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1072,13 +1349,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "post": { "description": "Update a specific Service.", + "tags": [ + "IntelligenceV2Service" + ], "parameters": [ { "name": "Sid", @@ -1104,6 +1381,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.service" + }, + "examples": { + "update": { + "value": { + "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "something", + "friendly_name": "some friendly name", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "auto_redaction": false, + "media_redaction": false, + "auto_transcribe": true, + "data_logging": true, + "webhook_url": "https://www.sendgrid.com", + "webhook_http_method": "GET", + "language_code": "en-US", + "version": 2, + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1116,9 +1414,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1132,7 +1427,7 @@ }, "DataLogging": { "type": "boolean", - "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." + "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "FriendlyName": { "type": "string", @@ -1164,6 +1459,16 @@ "description": "The HTTP method for the Webhook. One of `GET` or `POST`." } } + }, + "examples": { + "update": { + "value": { + "UniqueName": "something", + "FriendlyName": "some friendly name", + "WebhookUrl": "https://www.sendgrid.com", + "WebhookHttpMethod": "GET" + } + } } } } @@ -1176,7 +1481,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1185,21 +1490,95 @@ "duration", "status" ], - "pathType": "list", "dependentProperties": { - "sentence": "{transcript_sid: sid}", - "media": "{sid: sid}", - "operator_result": "{transcript_sid: sid}" - } + "sentences": { + "mapping": { + "transcript_sid": "sid" + }, + "resource_url": "/v2/Transcripts/{transcript_sid}/Sentences" + }, + "media": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v2/Transcripts/{sid}/Media" + }, + "operator_results": { + "mapping": { + "transcript_sid": "sid" + }, + "resource_url": "/v2/Transcripts/{transcript_sid}/OperatorResults" + } + }, + "pathType": "list" }, "post": { "description": "Create a new Transcript for the service", + "tags": [ + "IntelligenceV2Transcript" + ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "status": "queued", + "channel": { + "media_properties": { + "media_url": "http://foobar.test/ClusterTests/call1.wav" + } + }, + "data_logging": false, + "language_code": "en-US", + "media_start_time": null, + "duration": 0, + "customer_key": "aaaaaaaa", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "redaction": true, + "links": { + "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", + "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", + "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults" + } + } + }, + "createParams": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "status": "queued", + "channel": { + "media_properties": { + "media_url": "http://foobar.test/ClusterTests/call1.wav" + } + }, + "data_logging": false, + "language_code": "en-US", + "media_start_time": null, + "duration": 0, + "customer_key": null, + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "redaction": true, + "links": { + "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", + "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", + "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults" + } + } + } } } }, @@ -1212,9 +1591,6 @@ } ], "operationId": "CreateTranscript", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1246,6 +1622,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" + } + } } } } @@ -1253,6 +1645,9 @@ }, "get": { "description": "Retrieve a list of Transcripts for a given service.", + "tags": [ + "IntelligenceV2Transcript" + ], "parameters": [ { "name": "ServiceSid", @@ -1263,6 +1658,17 @@ "minLength": 34, "maxLength": 34, "pattern": "^GA[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readQuery": { + "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1295,6 +1701,11 @@ "description": "Filter by after DateCreated.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "2019-11-22T23:46:00Z" + } } }, { @@ -1311,6 +1722,11 @@ "description": "Filter by Language Code.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "en-US" + } } }, { @@ -1319,6 +1735,11 @@ "description": "Filter by SourceSid.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1364,16 +1785,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1382,17 +1805,103 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "transcripts": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "status": "queued", + "channel": {}, + "data_logging": false, + "language_code": "en-US", + "media_start_time": null, + "duration": 0, + "customer_key": null, + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "redaction": true, + "links": { + "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", + "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", + "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults" + } + } + ], + "meta": { + "key": "transcripts", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "transcripts": [], + "meta": { + "key": "transcripts", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + } + } + }, + "readQuery": { + "value": { + "transcripts": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "status": "queued", + "channel": {}, + "data_logging": false, + "language_code": "en-US", + "media_start_time": null, + "duration": 0, + "customer_key": null, + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "redaction": true, + "links": { + "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", + "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", + "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults" + } + } + ], + "meta": { + "key": "transcripts", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } } @@ -1407,10 +1916,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTranscript", - "x-maturity": [ - "Beta" - ] + "operationId": "ListTranscript" } }, "/v2/Transcripts/{Sid}": { @@ -1419,7 +1925,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1428,15 +1934,33 @@ "duration", "status" ], - "pathType": "instance", "dependentProperties": { - "sentence": "{transcript_sid: sid}", - "media": "{sid: sid}", - "operator_result": "{transcript_sid: sid}" - } + "sentences": { + "mapping": { + "transcript_sid": "sid" + }, + "resource_url": "/v2/Transcripts/{transcript_sid}/Sentences" + }, + "media": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v2/Transcripts/{sid}/Media" + }, + "operator_results": { + "mapping": { + "transcript_sid": "sid" + }, + "resource_url": "/v2/Transcripts/{transcript_sid}/OperatorResults" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Transcript.", + "tags": [ + "IntelligenceV2Transcript" + ], "parameters": [ { "name": "Sid", @@ -1449,14 +1973,6 @@ "pattern": "^GT[0-9a-fA-F]{32}$" }, "required": true - }, - { - "name": "Redacted", - "in": "query", - "description": "Grant access to PII Redacted/Unredacted Transcript. The default is `true` to access redacted Transcript.", - "schema": { - "type": "boolean" - } } ], "responses": { @@ -1465,6 +1981,31 @@ "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" + } + } + } } } }, @@ -1476,13 +2017,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTranscript", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchTranscript" }, "delete": { "description": "Delete a specific Transcript.", + "tags": [ + "IntelligenceV2Transcript" + ], "parameters": [ { "name": "Sid", @@ -1507,10 +2048,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTranscript", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteTranscript" } } }, @@ -1519,10 +2057,26 @@ "url": "https://intelligence.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "IntelligenceV2Media" + }, + { + "name": "IntelligenceV2OperatorResult" + }, + { + "name": "IntelligenceV2Sentence" + }, + { + "name": "IntelligenceV2Service" + }, + { + "name": "IntelligenceV2Transcript" + } + ], + "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/spec/json/twilio_ip_messaging_v1.json b/spec/json/twilio_ip_messaging_v1.json index a250349c..d754e7cd 100644 --- a/spec/json/twilio_ip_messaging_v1.json +++ b/spec/json/twilio_ip_messaging_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "ip_messaging.v1.service.channel": { "type": "object", @@ -659,12 +665,6 @@ "not_participating" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -680,7 +680,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -690,23 +690,44 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "member": "{service_sid: service_sid, channel_sid: sid}", - "message": "{service_sid: service_sid, channel_sid: sid}", - "invite": "{service_sid: service_sid, channel_sid: sid}" + "members": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Members" + }, + "messages": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Messages" + }, + "invites": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Invites" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "IpMessagingV1Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -736,6 +757,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -747,13 +793,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", + "tags": [ + "IpMessagingV1Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -787,13 +833,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", + "tags": [ + "IpMessagingV1Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -823,6 +869,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -835,9 +906,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -858,6 +926,16 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Type": "channel", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }" + } + } } } } @@ -870,23 +948,44 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "member": "{service_sid: service_sid, channel_sid: sid}", - "message": "{service_sid: service_sid, channel_sid: sid}", - "invite": "{service_sid: service_sid, channel_sid: sid}" + "members": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Members" + }, + "messages": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Messages" + }, + "invites": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Invites" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "IpMessagingV1Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -907,6 +1006,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel" + }, + "examples": { + "create": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -919,9 +1043,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -947,6 +1068,16 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "Type": "public", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }" + } + } } } } @@ -954,6 +1085,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV1Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1022,16 +1156,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1040,17 +1176,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "channels": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + } + } + }, + "readEmpty": { + "value": { + "channels": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" } } } @@ -1065,10 +1251,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v1/Credentials": { @@ -1077,7 +1260,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1088,6 +1271,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV1Credential" + ], "parameters": [ { "name": "PageSize", @@ -1132,16 +1318,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1150,17 +1338,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -1175,19 +1402,33 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", + "tags": [ + "IpMessagingV1Credential" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1200,9 +1441,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1243,6 +1481,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -1255,7 +1500,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1266,6 +1511,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV1Credential" + ], "parameters": [ { "name": "Sid", @@ -1286,6 +1534,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1297,13 +1559,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", + "tags": [ + "IpMessagingV1Credential" + ], "parameters": [ { "name": "Sid", @@ -1324,6 +1586,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1336,9 +1612,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1371,6 +1644,13 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -1378,6 +1658,9 @@ }, "delete": { "description": "", + "tags": [ + "IpMessagingV1Credential" + ], "parameters": [ { "name": "Sid", @@ -1402,10 +1685,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -1414,18 +1694,21 @@ "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": "", + "tags": [ + "IpMessagingV1Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -1467,6 +1750,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1478,13 +1777,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", + "tags": [ + "IpMessagingV1Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -1530,10 +1829,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -1542,18 +1838,21 @@ "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": "", + "tags": [ + "IpMessagingV1Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -1583,6 +1882,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1595,9 +1910,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1620,6 +1932,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1627,6 +1947,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV1Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -1658,6 +1981,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -1703,16 +2038,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1721,17 +2058,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "invites": [], + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "invites": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" } } } @@ -1746,10 +2124,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInvite" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { @@ -1758,18 +2133,21 @@ "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": "", + "tags": [ + "IpMessagingV1Member" + ], "parameters": [ { "name": "ServiceSid", @@ -1811,6 +2189,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" + }, + "examples": { + "fetch": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1822,13 +2217,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", + "tags": [ + "IpMessagingV1Member" + ], "parameters": [ { "name": "ServiceSid", @@ -1874,13 +2269,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", + "tags": [ + "IpMessagingV1Member" + ], "parameters": [ { "name": "ServiceSid", @@ -1922,6 +2317,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" + }, + "examples": { + "updateRoleSid": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": 666, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1934,9 +2361,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1957,6 +2381,18 @@ "description": "" } } + }, + "examples": { + "updateRoleSid": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "LastConsumedMessageIndex": 666 + } + } } } } @@ -1969,18 +2405,21 @@ "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": "", + "tags": [ + "IpMessagingV1Member" + ], "parameters": [ { "name": "ServiceSid", @@ -2010,6 +2449,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" + }, + "examples": { + "create": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2022,9 +2478,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2047,6 +2500,13 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio" + } + } } } } @@ -2054,6 +2514,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV1Member" + ], "parameters": [ { "name": "ServiceSid", @@ -2130,16 +2593,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2148,18 +2613,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [ + { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [] } } } @@ -2173,10 +2680,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -2185,7 +2689,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2193,11 +2697,14 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "IpMessagingV1Message" + ], "parameters": [ { "name": "ServiceSid", @@ -2242,6 +2749,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" + }, + "examples": { + "fetch": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2253,13 +2779,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "delete": { "description": "", + "tags": [ + "IpMessagingV1Message" + ], "parameters": [ { "name": "ServiceSid", @@ -2308,13 +2834,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", + "tags": [ + "IpMessagingV1Message" + ], "parameters": [ { "name": "ServiceSid", @@ -2359,6 +2885,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" + }, + "examples": { + "update": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{\"test\": \"test\"}", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2371,9 +2916,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2390,6 +2932,13 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello" + } + } } } } @@ -2402,7 +2951,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2410,11 +2959,14 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "IpMessagingV1Message" + ], "parameters": [ { "name": "ServiceSid", @@ -2447,6 +2999,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" + }, + "examples": { + "create": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithAttributes": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2459,9 +3047,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2485,6 +3070,19 @@ "required": [ "Body" ] + }, + "examples": { + "create": { + "value": { + "Body": "Hello" + } + }, + "createWithAttributes": { + "value": { + "Body": "Hello", + "Attributes": "{\"test\": \"test\"}" + } + } } } } @@ -2492,6 +3090,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV1Message" + ], "parameters": [ { "name": "ServiceSid", @@ -2569,16 +3170,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2587,18 +3190,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [] } } } @@ -2612,10 +3259,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v1/Services/{ServiceSid}/Roles/{Sid}": { @@ -2624,18 +3268,21 @@ "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": "", + "tags": [ + "IpMessagingV1Role" + ], "parameters": [ { "name": "ServiceSid", @@ -2668,6 +3315,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2679,13 +3346,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", + "tags": [ + "IpMessagingV1Role" + ], "parameters": [ { "name": "ServiceSid", @@ -2722,13 +3389,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", + "tags": [ + "IpMessagingV1Role" + ], "parameters": [ { "name": "ServiceSid", @@ -2761,6 +3428,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2773,9 +3460,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2794,6 +3478,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -2806,18 +3497,21 @@ "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": "", + "tags": [ + "IpMessagingV1Role" + ], "parameters": [ { "name": "ServiceSid", @@ -2838,6 +3532,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2850,9 +3564,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2882,6 +3593,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -2889,6 +3609,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV1Role" + ], "parameters": [ { "name": "ServiceSid", @@ -2945,16 +3668,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2963,18 +3688,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -2988,10 +3758,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v1/Services/{Sid}": { @@ -3000,22 +3767,40 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "channel": "{service_sid: sid}", - "role": "{service_sid: sid}", - "user": "{service_sid: sid}" - } + "channels": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels" + }, + "roles": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Roles" + }, + "users": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Users" + } + }, + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "IpMessagingV1Service" + ], "parameters": [ { "name": "Sid", @@ -3036,6 +3821,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": {} + } + } } } }, @@ -3047,13 +3868,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", + "tags": [ + "IpMessagingV1Service" + ], "parameters": [ { "name": "Sid", @@ -3078,13 +3899,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", + "tags": [ + "IpMessagingV1Service" + ], "parameters": [ { "name": "Sid", @@ -3105,6 +3926,140 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 500, + "user_channels": 600 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": { + "added_to_channel": { + "enabled": false, + "template": "notifications.added_to_channel.template" + }, + "invited_to_channel": { + "enabled": false, + "template": "notifications.invited_to_channel.template" + }, + "new_message": { + "enabled": false, + "template": "notifications.new_message.template" + }, + "removed_from_channel": { + "enabled": false, + "template": "notifications.removed_from_channel.template" + } + }, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": { + "on_channel_add": { + "format": "webhooks.on_channel_add.format", + "method": "webhooks.on_channel_add.method", + "url": "webhooks.on_channel_add.url" + }, + "on_channel_added": { + "format": "webhooks.on_channel_added.format", + "method": "webhooks.on_channel_added.method", + "url": "webhooks.on_channel_added.url" + }, + "on_channel_destroy": { + "format": "webhooks.on_channel_destroy.format", + "method": "webhooks.on_channel_destroy.method", + "url": "webhooks.on_channel_destroy.url" + }, + "on_channel_destroyed": { + "format": "webhooks.on_channel_destroyed.format", + "method": "webhooks.on_channel_destroyed.method", + "url": "webhooks.on_channel_destroyed.url" + }, + "on_channel_update": { + "format": "webhooks.on_channel_update.format", + "method": "webhooks.on_channel_update.method", + "url": "webhooks.on_channel_update.url" + }, + "on_channel_updated": { + "format": "webhooks.on_channel_updated.format", + "method": "webhooks.on_channel_updated.method", + "url": "webhooks.on_channel_updated.url" + }, + "on_member_add": { + "format": "webhooks.on_member_add.format", + "method": "webhooks.on_member_add.method", + "url": "webhooks.on_member_add.url" + }, + "on_member_added": { + "format": "webhooks.on_member_added.format", + "method": "webhooks.on_member_added.method", + "url": "webhooks.on_member_added.url" + }, + "on_member_remove": { + "format": "webhooks.on_member_remove.format", + "method": "webhooks.on_member_remove.method", + "url": "webhooks.on_member_remove.url" + }, + "on_member_removed": { + "format": "webhooks.on_member_removed.format", + "method": "webhooks.on_member_removed.method", + "url": "webhooks.on_member_removed.url" + }, + "on_message_remove": { + "format": "webhooks.on_message_remove.format", + "method": "webhooks.on_message_remove.method", + "url": "webhooks.on_message_remove.url" + }, + "on_message_removed": { + "format": "webhooks.on_message_removed.format", + "method": "webhooks.on_message_removed.method", + "url": "webhooks.on_message_removed.url" + }, + "on_message_send": { + "format": "webhooks.on_message_send.format", + "method": "webhooks.on_message_send.method", + "url": "webhooks.on_message_send.url" + }, + "on_message_sent": { + "format": "webhooks.on_message_sent.format", + "method": "webhooks.on_message_sent.method", + "url": "webhooks.on_message_sent.url" + }, + "on_message_update": { + "format": "webhooks.on_message_update.format", + "method": "webhooks.on_message_update.method", + "url": "webhooks.on_message_update.url" + }, + "on_message_updated": { + "format": "webhooks.on_message_updated.format", + "method": "webhooks.on_message_updated.method", + "url": "webhooks.on_message_updated.url" + } + } + } + } } } }, @@ -3117,9 +4072,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3527,6 +4479,84 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "ConsumptionReportInterval": 100, + "DefaultChannelCreatorRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultChannelRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultServiceRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "Notifications.AddedToChannel.Enabled": false, + "Notifications.AddedToChannel.Template": "notifications.added_to_channel.template", + "Notifications.InvitedToChannel.Enabled": false, + "Notifications.InvitedToChannel.Template": "notifications.invited_to_channel.template", + "Notifications.NewMessage.Enabled": false, + "Notifications.NewMessage.Template": "notifications.new_message.template", + "Notifications.RemovedFromChannel.Enabled": false, + "Notifications.RemovedFromChannel.Template": "notifications.removed_from_channel.template", + "Limits.ChannelMembers": 600, + "Limits.UserChannels": 500, + "PostWebhookUrl": "post_webhook_url", + "PreWebhookUrl": "pre_webhook_url", + "ReachabilityEnabled": false, + "ReadStatusEnabled": false, + "TypingIndicatorTimeout": 100, + "WebhookFilters": [ + "webhook_filters" + ], + "WebhookMethod": "webhook_method", + "Webhooks.OnChannelAdd.Format": "webhooks.on_channel_add.format", + "Webhooks.OnChannelAdd.Method": "webhooks.on_channel_add.method", + "Webhooks.OnChannelAdd.Url": "webhooks.on_channel_add.url", + "Webhooks.OnChannelAdded.Format": "webhooks.on_channel_added.format", + "Webhooks.OnChannelAdded.Method": "webhooks.on_channel_added.method", + "Webhooks.OnChannelAdded.Url": "webhooks.on_channel_added.url", + "Webhooks.OnChannelDestroy.Format": "webhooks.on_channel_destroy.format", + "Webhooks.OnChannelDestroy.Method": "webhooks.on_channel_destroy.method", + "Webhooks.OnChannelDestroy.Url": "webhooks.on_channel_destroy.url", + "Webhooks.OnChannelDestroyed.Format": "webhooks.on_channel_destroyed.format", + "Webhooks.OnChannelDestroyed.Method": "webhooks.on_channel_destroyed.method", + "Webhooks.OnChannelDestroyed.Url": "webhooks.on_channel_destroyed.url", + "Webhooks.OnChannelUpdate.Format": "webhooks.on_channel_update.format", + "Webhooks.OnChannelUpdate.Method": "webhooks.on_channel_update.method", + "Webhooks.OnChannelUpdate.Url": "webhooks.on_channel_update.url", + "Webhooks.OnChannelUpdated.Format": "webhooks.on_channel_updated.format", + "Webhooks.OnChannelUpdated.Method": "webhooks.on_channel_updated.method", + "Webhooks.OnChannelUpdated.Url": "webhooks.on_channel_updated.url", + "Webhooks.OnMemberAdd.Format": "webhooks.on_member_add.format", + "Webhooks.OnMemberAdd.Method": "webhooks.on_member_add.method", + "Webhooks.OnMemberAdd.Url": "webhooks.on_member_add.url", + "Webhooks.OnMemberAdded.Format": "webhooks.on_member_added.format", + "Webhooks.OnMemberAdded.Method": "webhooks.on_member_added.method", + "Webhooks.OnMemberAdded.Url": "webhooks.on_member_added.url", + "Webhooks.OnMemberRemove.Format": "webhooks.on_member_remove.format", + "Webhooks.OnMemberRemove.Method": "webhooks.on_member_remove.method", + "Webhooks.OnMemberRemove.Url": "webhooks.on_member_remove.url", + "Webhooks.OnMemberRemoved.Format": "webhooks.on_member_removed.format", + "Webhooks.OnMemberRemoved.Method": "webhooks.on_member_removed.method", + "Webhooks.OnMemberRemoved.Url": "webhooks.on_member_removed.url", + "Webhooks.OnMessageRemove.Format": "webhooks.on_message_remove.format", + "Webhooks.OnMessageRemove.Method": "webhooks.on_message_remove.method", + "Webhooks.OnMessageRemove.Url": "webhooks.on_message_remove.url", + "Webhooks.OnMessageRemoved.Format": "webhooks.on_message_removed.format", + "Webhooks.OnMessageRemoved.Method": "webhooks.on_message_removed.method", + "Webhooks.OnMessageRemoved.Url": "webhooks.on_message_removed.url", + "Webhooks.OnMessageSend.Format": "webhooks.on_message_send.format", + "Webhooks.OnMessageSend.Method": "webhooks.on_message_send.method", + "Webhooks.OnMessageSend.Url": "webhooks.on_message_send.url", + "Webhooks.OnMessageSent.Format": "webhooks.on_message_sent.format", + "Webhooks.OnMessageSent.Method": "webhooks.on_message_sent.method", + "Webhooks.OnMessageSent.Url": "webhooks.on_message_sent.url", + "Webhooks.OnMessageUpdate.Format": "webhooks.on_message_update.format", + "Webhooks.OnMessageUpdate.Method": "webhooks.on_message_update.method", + "Webhooks.OnMessageUpdate.Url": "webhooks.on_message_update.url", + "Webhooks.OnMessageUpdated.Format": "webhooks.on_message_updated.format", + "Webhooks.OnMessageUpdated.Method": "webhooks.on_message_updated.method", + "Webhooks.OnMessageUpdated.Url": "webhooks.on_message_updated.url" + } + } } } } @@ -3539,28 +4569,82 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "channel": "{service_sid: sid}", - "role": "{service_sid: sid}", - "user": "{service_sid: sid}" - } + "channels": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Channels" + }, + "roles": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Roles" + }, + "users": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Users" + } + }, + "pathType": "list" }, "post": { "description": "", + "tags": [ + "IpMessagingV1Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": {} + } + } } } }, @@ -3573,9 +4657,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3591,6 +4672,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -3598,6 +4686,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV1Service" + ], "parameters": [ { "name": "PageSize", @@ -3642,16 +4733,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3660,18 +4753,79 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": {} + } + ] } } } @@ -3685,10 +4839,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{ServiceSid}/Users/{Sid}": { @@ -3697,21 +4848,30 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "user_channel": "{service_sid: service_sid, user_sid: sid}" + "user_channels": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Users/{user_sid}/Channels" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "IpMessagingV1User" + ], "parameters": [ { "name": "ServiceSid", @@ -3741,6 +4901,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3752,13 +4934,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", + "tags": [ + "IpMessagingV1User" + ], "parameters": [ { "name": "ServiceSid", @@ -3792,13 +4974,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", + "tags": [ + "IpMessagingV1User" + ], "parameters": [ { "name": "ServiceSid", @@ -3828,6 +5010,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3840,9 +5044,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3866,6 +5067,15 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -3878,21 +5088,30 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "user_channel": "{service_sid: service_sid, user_sid: sid}" + "user_channels": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Users/{user_sid}/Channels" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "IpMessagingV1User" + ], "parameters": [ { "name": "ServiceSid", @@ -3913,6 +5132,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3925,9 +5166,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3958,6 +5196,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -3965,6 +5213,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV1User" + ], "parameters": [ { "name": "ServiceSid", @@ -4021,16 +5272,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4039,18 +5292,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "joined_channels_count": 0, + "links": { + "user_channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [] } } } @@ -4064,10 +5364,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -4076,18 +5373,21 @@ "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": "", + "tags": [ + "IpMessagingV1UserChannel" + ], "parameters": [ { "name": "ServiceSid", @@ -4153,16 +5453,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4171,18 +5473,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "links": { + "channel": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [] } } } @@ -4196,10 +5540,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } } }, @@ -4208,10 +5549,38 @@ "url": "https://ip-messaging.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "IpMessagingV1Channel" + }, + { + "name": "IpMessagingV1Credential" + }, + { + "name": "IpMessagingV1Invite" + }, + { + "name": "IpMessagingV1Member" + }, + { + "name": "IpMessagingV1Message" + }, + { + "name": "IpMessagingV1Role" + }, + { + "name": "IpMessagingV1Service" + }, + { + "name": "IpMessagingV1User" + }, + { + "name": "IpMessagingV1UserChannel" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_ip_messaging_v2.json b/spec/json/twilio_ip_messaging_v2.json index 866a12b9..236cc110 100644 --- a/spec/json/twilio_ip_messaging_v2.json +++ b/spec/json/twilio_ip_messaging_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "ip_messaging.v2.service.binding": { "type": "object", @@ -968,12 +974,6 @@ "muted" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -989,7 +989,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -999,18 +999,21 @@ "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": "", + "tags": [ + "IpMessagingV2Binding" + ], "parameters": [ { "name": "ServiceSid", @@ -1090,16 +1093,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1108,18 +1113,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [ + { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [] } } } @@ -1133,10 +1188,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListBinding" } }, "/v2/Services/{ServiceSid}/Bindings/{Sid}": { @@ -1145,18 +1197,21 @@ "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": "", + "tags": [ + "IpMessagingV2Binding" + ], "parameters": [ { "name": "ServiceSid", @@ -1189,6 +1244,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.binding" + }, + "examples": { + "fetch": { + "value": { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser" + } + } + } } } }, @@ -1200,13 +1280,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBinding" }, "delete": { "description": "", + "tags": [ + "IpMessagingV2Binding" + ], "parameters": [ { "name": "ServiceSid", @@ -1243,10 +1323,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteBinding" } }, "/v2/Services/{ServiceSid}/Channels/{Sid}": { @@ -1255,24 +1332,51 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "member": "{service_sid: service_sid, channel_sid: sid}", - "message": "{service_sid: service_sid, channel_sid: sid}", - "invite": "{service_sid: service_sid, channel_sid: sid}", - "webhook": "{service_sid: service_sid, channel_sid: sid}" + "members": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Members" + }, + "messages": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Messages" + }, + "invites": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Invites" + }, + "webhooks": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "IpMessagingV2Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1302,6 +1406,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1313,13 +1443,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", + "tags": [ + "IpMessagingV2Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1362,13 +1492,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1407,6 +1537,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "created_by": "username", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1419,9 +1575,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1456,6 +1609,19 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Type": "channel", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "CreatedBy": "username" + } + } } } } @@ -1468,24 +1634,51 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "member": "{service_sid: service_sid, channel_sid: sid}", - "message": "{service_sid: service_sid, channel_sid: sid}", - "invite": "{service_sid: service_sid, channel_sid: sid}", - "webhook": "{service_sid: service_sid, channel_sid: sid}" + "members": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Members" + }, + "messages": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Messages" + }, + "invites": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Invites" + }, + "webhooks": { + "mapping": { + "service_sid": "service_sid", + "channel_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1515,6 +1708,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel" + }, + "examples": { + "create": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "created_by": "username", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1527,9 +1746,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1569,6 +1785,19 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "Type": "public", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "CreatedBy": "username" + } + } } } } @@ -1576,6 +1805,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV2Channel" + ], "parameters": [ { "name": "ServiceSid", @@ -1644,16 +1876,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1662,17 +1896,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "channels": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + } + } + }, + "readEmpty": { + "value": { + "channels": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" } } } @@ -1687,10 +1972,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks": { @@ -1699,17 +1981,20 @@ "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": "", + "tags": [ + "IpMessagingV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -1775,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" @@ -1793,18 +2080,98 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "webhook", + "configuration": { + "url": "dummy", + "method": "GET", + "filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "retry_count": 2 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "trigger", + "configuration": { + "url": "dummy", + "method": "POST", + "filters": [ + "keyword1", + "keyword2" + ], + "retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [] } } } @@ -1818,13 +2185,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannelWebhook" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -1854,6 +2221,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.channel_webhook" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "webhook", + "configuration": { + "url": "dummy", + "method": "GET", + "filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "retry_count": 2 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1866,9 +2256,6 @@ } ], "operationId": "CreateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1919,6 +2306,20 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "webhook", + "Configuration.Url": "dummy", + "Configuration.Method": "GET", + "Configuration.Filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "Configuration.RetryCount": 2 + } + } } } } @@ -1931,17 +2332,20 @@ "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": "", + "tags": [ + "IpMessagingV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -1983,6 +2387,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.channel_webhook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1994,13 +2415,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannelWebhook" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -2042,6 +2463,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.channel_webhook" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "trigger", + "configuration": { + "url": "dummy", + "method": "POST", + "filters": [ + "keyword1", + "keyword2" + ], + "retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2054,9 +2498,6 @@ } ], "operationId": "UpdateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2099,6 +2540,19 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Configuration.Url": "dummy", + "Configuration.Method": "POST", + "Configuration.Triggers": [ + "keyword1", + "keyword2" + ], + "Configuration.RetryCount": 5 + } + } } } } @@ -2106,6 +2560,9 @@ }, "delete": { "description": "", + "tags": [ + "IpMessagingV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -2151,10 +2608,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannelWebhook" } }, "/v2/Credentials": { @@ -2163,7 +2617,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2174,6 +2628,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV2Credential" + ], "parameters": [ { "name": "PageSize", @@ -2218,16 +2675,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2236,17 +2695,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -2261,19 +2759,33 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Credential" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2286,9 +2798,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2329,6 +2838,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -2341,7 +2857,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2352,6 +2868,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV2Credential" + ], "parameters": [ { "name": "Sid", @@ -2372,6 +2891,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2383,13 +2916,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Credential" + ], "parameters": [ { "name": "Sid", @@ -2410,6 +2943,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2422,9 +2969,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2457,6 +3001,13 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -2464,6 +3015,9 @@ }, "delete": { "description": "", + "tags": [ + "IpMessagingV2Credential" + ], "parameters": [ { "name": "Sid", @@ -2488,10 +3042,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -2500,18 +3051,21 @@ "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": "", + "tags": [ + "IpMessagingV2Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -2553,6 +3107,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.invite" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2564,13 +3134,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", + "tags": [ + "IpMessagingV2Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -2616,10 +3186,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -2628,18 +3195,21 @@ "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": "", + "tags": [ + "IpMessagingV2Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -2669,6 +3239,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.invite" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2681,9 +3267,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2706,6 +3289,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2713,6 +3304,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV2Invite" + ], "parameters": [ { "name": "ServiceSid", @@ -2744,6 +3338,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -2789,16 +3395,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2807,17 +3415,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "invites": [], + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "invites": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" } } } @@ -2832,10 +3481,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { @@ -2844,18 +3490,21 @@ "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": "", + "tags": [ + "IpMessagingV2Member" + ], "parameters": [ { "name": "ServiceSid", @@ -2894,6 +3543,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.member" + }, + "examples": { + "fetch": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2905,13 +3572,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", + "tags": [ + "IpMessagingV2Member" + ], "parameters": [ { "name": "ServiceSid", @@ -2963,13 +3630,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Member" + ], "parameters": [ { "name": "ServiceSid", @@ -3017,6 +3684,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.member" + }, + "examples": { + "updateRoleSid": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": 20, + "last_consumption_timestamp": "2016-03-24T21:05:52Z", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "attributes": "{}", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3029,9 +3714,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3071,6 +3753,18 @@ "description": "" } } + }, + "examples": { + "updateRoleSid": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2016-03-24T21:05:50Z", + "DateUpdated": "2016-03-24T21:05:51Z", + "LastConsumedMessageIndex": 20, + "LastConsumptionTimestamp": "2016-03-24T21:05:52Z", + "Attributes": "{}" + } + } } } } @@ -3083,18 +3777,21 @@ "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": "", + "tags": [ + "IpMessagingV2Member" + ], "parameters": [ { "name": "ServiceSid", @@ -3133,6 +3830,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.member" + }, + "examples": { + "create": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3145,9 +3860,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3194,6 +3906,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio", + "Attributes": "{}" + } + } } } } @@ -3201,6 +3921,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV2Member" + ], "parameters": [ { "name": "ServiceSid", @@ -3277,16 +4000,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3295,18 +4020,61 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [ + { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [] } } } @@ -3320,10 +4088,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -3332,7 +4097,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3340,11 +4105,14 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "IpMessagingV2Message" + ], "parameters": [ { "name": "ServiceSid", @@ -3386,6 +4154,53 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.message" + }, + "examples": { + "fetch": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchMedia": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "media", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3397,13 +4212,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "delete": { "description": "", + "tags": [ + "IpMessagingV2Message" + ], "parameters": [ { "name": "ServiceSid", @@ -3458,13 +4273,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Message" + ], "parameters": [ { "name": "ServiceSid", @@ -3515,6 +4330,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.message" + }, + "examples": { + "update": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"foo\": \"bar\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "last_updated_by": "username", + "was_edited": true, + "from": "fromUser", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3527,9 +4364,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3564,6 +4398,18 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "LastUpdatedBy": "username", + "From": "fromUser" + } + } } } } @@ -3576,7 +4422,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3584,11 +4430,14 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Message" + ], "parameters": [ { "name": "ServiceSid", @@ -3627,6 +4476,73 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.message" + }, + "examples": { + "create": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": "system", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithAll": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "last_updated_by": "username", + "was_edited": true, + "from": "system", + "attributes": "{\"test\": \"test\"}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createMedia": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": "system", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "type": "text", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3639,9 +4555,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3683,6 +4596,27 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "Body": "Hello" + } + }, + "createWithAll": { + "value": { + "Body": "Hello", + "Attributes": "{\"test\": \"test\"}", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "LastUpdatedBy": "username" + } + }, + "createMedia": { + "value": { + "MediaSid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3690,6 +4624,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV2Message" + ], "parameters": [ { "name": "ServiceSid", @@ -3764,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" @@ -3782,18 +4721,88 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "media", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [] } } } @@ -3807,10 +4816,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v2/Services/{ServiceSid}/Roles/{Sid}": { @@ -3819,18 +4825,21 @@ "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": "", + "tags": [ + "IpMessagingV2Role" + ], "parameters": [ { "name": "ServiceSid", @@ -3863,6 +4872,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3874,13 +4903,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", + "tags": [ + "IpMessagingV2Role" + ], "parameters": [ { "name": "ServiceSid", @@ -3917,13 +4946,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Role" + ], "parameters": [ { "name": "ServiceSid", @@ -3956,6 +4985,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3968,9 +5017,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3989,6 +5035,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -4001,18 +5054,21 @@ "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": "", + "tags": [ + "IpMessagingV2Role" + ], "parameters": [ { "name": "ServiceSid", @@ -4033,6 +5089,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4045,9 +5121,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4077,6 +5150,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -4084,6 +5166,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV2Role" + ], "parameters": [ { "name": "ServiceSid", @@ -4140,16 +5225,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4158,18 +5245,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -4183,10 +5315,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v2/Services/{Sid}": { @@ -4195,23 +5324,46 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "channel": "{service_sid: sid}", - "role": "{service_sid: sid}", - "user": "{service_sid: sid}", - "binding": "{service_sid: sid}" - } + "channels": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels" + }, + "roles": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Roles" + }, + "users": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users" + }, + "bindings": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Bindings" + } + }, + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "IpMessagingV2Service" + ], "parameters": [ { "name": "Sid", @@ -4232,6 +5384,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + } } } }, @@ -4243,13 +5437,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", + "tags": [ + "IpMessagingV2Service" + ], "parameters": [ { "name": "Sid", @@ -4274,13 +5468,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Service" + ], "parameters": [ { "name": "Sid", @@ -4301,6 +5495,67 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 500, + "user_channels": 600 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": { + "log_enabled": true, + "added_to_channel": { + "enabled": false, + "template": "notifications.added_to_channel.template" + }, + "invited_to_channel": { + "enabled": false, + "template": "notifications.invited_to_channel.template" + }, + "new_message": { + "enabled": false, + "template": "notifications.new_message.template", + "badge_count_enabled": true + }, + "removed_from_channel": { + "enabled": false, + "template": "notifications.removed_from_channel.template" + } + }, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "new media compatibility message" + } + } + } } } }, @@ -4313,9 +5568,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4471,6 +5723,41 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "ConsumptionReportInterval": 100, + "DefaultChannelCreatorRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultChannelRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultServiceRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "Notifications.AddedToChannel.Enabled": false, + "Notifications.AddedToChannel.Template": "notifications.added_to_channel.template", + "Notifications.InvitedToChannel.Enabled": false, + "Notifications.InvitedToChannel.Template": "notifications.invited_to_channel.template", + "Notifications.NewMessage.Enabled": false, + "Notifications.NewMessage.Template": "notifications.new_message.template", + "Notifications.NewMessage.BadgeCountEnabled": true, + "Notifications.RemovedFromChannel.Enabled": false, + "Notifications.RemovedFromChannel.Template": "notifications.removed_from_channel.template", + "Notifications.LogEnabled": true, + "Limits.ChannelMembers": 600, + "Limits.UserChannels": 500, + "PostWebhookUrl": "post_webhook_url", + "PreWebhookUrl": "pre_webhook_url", + "PreWebhookRetryCount": 2, + "PostWebhookRetryCount": 3, + "ReachabilityEnabled": false, + "ReadStatusEnabled": false, + "TypingIndicatorTimeout": 100, + "WebhookFilters": [ + "webhook_filters" + ], + "WebhookMethod": "webhook_method", + "Media.CompatibilityMessage": "new media compatibility message" + } + } } } } @@ -4483,29 +5770,94 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "channel": "{service_sid: sid}", - "role": "{service_sid: sid}", - "user": "{service_sid: sid}", - "binding": "{service_sid: sid}" - } + "channels": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Channels" + }, + "roles": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Roles" + }, + "users": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users" + }, + "bindings": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Bindings" + } + }, + "pathType": "list" }, "post": { "description": "", + "tags": [ + "IpMessagingV2Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + } } } }, @@ -4518,9 +5870,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4536,6 +5885,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -4543,6 +5899,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV2Service" + ], "parameters": [ { "name": "PageSize", @@ -4587,16 +5946,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4605,18 +5966,85 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0" + }, + "services": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + ] } } } @@ -4630,10 +6058,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v2/Services/{ServiceSid}/Users/{Sid}": { @@ -4642,7 +6067,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4650,15 +6075,30 @@ "identity", "date_created" ], - "pathType": "instance", "dependentProperties": { - "user_channel": "{service_sid: service_sid, user_sid: sid}", - "user_binding": "{service_sid: service_sid, user_sid: sid}" + "user_channels": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Channels" + }, + "user_bindings": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Bindings" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "IpMessagingV2User" + ], "parameters": [ { "name": "ServiceSid", @@ -4688,6 +6128,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4699,13 +6162,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", + "tags": [ + "IpMessagingV2User" + ], "parameters": [ { "name": "ServiceSid", @@ -4739,13 +6202,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", + "tags": [ + "IpMessagingV2User" + ], "parameters": [ { "name": "ServiceSid", @@ -4784,6 +6247,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4796,9 +6282,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4822,6 +6305,15 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -4834,7 +6326,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4842,15 +6334,30 @@ "identity", "date_created" ], - "pathType": "list", "dependentProperties": { - "user_channel": "{service_sid: service_sid, user_sid: sid}", - "user_binding": "{service_sid: service_sid, user_sid: sid}" + "user_channels": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Channels" + }, + "user_bindings": { + "mapping": { + "service_sid": "service_sid", + "user_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Bindings" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "IpMessagingV2User" + ], "parameters": [ { "name": "ServiceSid", @@ -4880,6 +6387,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4892,9 +6422,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4925,6 +6452,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -4932,6 +6469,9 @@ }, "get": { "description": "", + "tags": [ + "IpMessagingV2User" + ], "parameters": [ { "name": "ServiceSid", @@ -4988,16 +6528,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5006,18 +6548,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "joined_channels_count": 0, + "links": { + "user_channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [] } } } @@ -5031,10 +6621,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings": { @@ -5043,7 +6630,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5051,12 +6638,15 @@ "identity", "binding_type" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "IpMessagingV2UserBinding" + ], "parameters": [ { "name": "ServiceSid", @@ -5134,16 +6724,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5152,18 +6744,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [ + { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [] } } } @@ -5177,10 +6817,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}": { @@ -5189,7 +6826,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5197,12 +6834,15 @@ "identity", "binding_type" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "IpMessagingV2UserBinding" + ], "parameters": [ { "name": "ServiceSid", @@ -5244,6 +6884,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user.user_binding" + }, + "examples": { + "fetch": { + "value": { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5255,13 +6918,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserBinding" }, "delete": { "description": "", + "tags": [ + "IpMessagingV2UserBinding" + ], "parameters": [ { "name": "ServiceSid", @@ -5307,10 +6970,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -5319,18 +6979,21 @@ "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": "", + "tags": [ + "IpMessagingV2UserChannel" + ], "parameters": [ { "name": "ServiceSid", @@ -5396,16 +7059,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5414,18 +7079,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "default", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [] } } } @@ -5439,10 +7149,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}": { @@ -5451,18 +7158,21 @@ "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": "", + "tags": [ + "IpMessagingV2UserChannel" + ], "parameters": [ { "name": "ServiceSid", @@ -5501,6 +7211,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user.user_channel" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "default", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -5512,13 +7242,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserChannel" }, "delete": { "description": "", + "tags": [ + "IpMessagingV2UserChannel" + ], "parameters": [ { "name": "ServiceSid", @@ -5561,13 +7291,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserChannel" }, "post": { "description": "", + "tags": [ + "IpMessagingV2UserChannel" + ], "parameters": [ { "name": "ServiceSid", @@ -5606,6 +7336,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user.user_channel" + }, + "examples": { + "updateNotificationLevel": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "muted", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 10, + "unread_messages_count": 5, + "notification_level": "muted", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -5618,9 +7386,6 @@ } ], "operationId": "UpdateUserChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5644,6 +7409,18 @@ "description": "" } } + }, + "examples": { + "updateNotificationLevel": { + "value": { + "NotificationLevel": "muted" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "LastConsumedMessageIndex": 10 + } + } } } } @@ -5656,10 +7433,47 @@ "url": "https://ip-messaging.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "IpMessagingV2Binding" + }, + { + "name": "IpMessagingV2Channel" + }, + { + "name": "IpMessagingV2Credential" + }, + { + "name": "IpMessagingV2Invite" + }, + { + "name": "IpMessagingV2Member" + }, + { + "name": "IpMessagingV2Message" + }, + { + "name": "IpMessagingV2Role" + }, + { + "name": "IpMessagingV2Service" + }, + { + "name": "IpMessagingV2User" + }, + { + "name": "IpMessagingV2UserBinding" + }, + { + "name": "IpMessagingV2UserChannel" + }, + { + "name": "IpMessagingV2Webhook" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_lookups_v1.json b/spec/json/twilio_lookups_v1.json index 9e56a2a9..b687aea0 100644 --- a/spec/json/twilio_lookups_v1.json +++ b/spec/json/twilio_lookups_v1.json @@ -1,28 +1,58 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "lookups.v1.phone_number": { "type": "object", "properties": { "caller_name": { "nullable": true, - "description": "The name of the phone number's owner. If `null`, that information was not available." + "description": "The name of the phone number's owner. If `null`, that information was not available.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "country_code": { "type": "string", "nullable": true, - "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for the phone number." + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for the phone number.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number." + "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "national_format": { "type": "string", "nullable": true, - "description": "The phone number, in national format." + "description": "The phone number, in national format.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "carrier": { "nullable": true, @@ -30,7 +60,13 @@ }, "add_ons": { "nullable": true, - "description": "A JSON string with the results of the Add-ons you specified in the `add_ons` parameters. For the format of the object, see [Using Add-ons](https://www.twilio.com/docs/add-ons)." + "description": "A JSON string with the results of the Add-ons you specified in the `add_ons` parameters. For the format of the object, see [Using Add-ons](https://www.twilio.com/docs/add-ons).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -48,12 +84,6 @@ "voip" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -69,7 +99,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -84,20 +114,29 @@ "defaultOutputProperties": [ "caller_name", "country_code", - "carrier" + "carrier", + "url" ], "pathType": "instance" }, "get": { "description": "", + "tags": [ + "LookupsV1PhoneNumber" + ], "parameters": [ { "name": "PhoneNumber", "in": "path", "description": "The phone number to lookup in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", "schema": { - "type": "string", - "format": "phone-number" + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } }, "required": true }, @@ -107,6 +146,32 @@ "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to fetch. This is used to specify the country when the phone number is provided in a national format.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "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" + } } }, { @@ -118,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" + ] + } } }, { @@ -129,6 +235,29 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "fetchAddonsWhitepagesPro": { + "value": [ + "whitepages_pro_caller_id" + ] + }, + "fetchAddonsNomorobo": { + "value": [ + "nomorobo_spamscore" + ] + }, + "fetchAddonsPayfone": { + "value": [ + "payfone_tcpa_compliance" + ] + } } }, { @@ -147,6 +276,239 @@ "application/json": { "schema": { "$ref": "#/components/schemas/lookups.v1.phone_number" + }, + "examples": { + "fetch": { + "value": { + "caller_name": null, + "carrier": null, + "fraud": null, + "add_ons": null, + "country_code": "US", + "national_format": "(510) 867-5310", + "phone_number": "+15108675310", + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+15108675310" + } + }, + "fetchCarrier": { + "value": { + "caller_name": null, + "carrier": { + "error_code": null, + "mobile_country_code": "310", + "mobile_network_code": "456", + "name": "verizon", + "type": "mobile" + }, + "country_code": "US", + "national_format": "(510) 867-5310", + "phone_number": "+15108675310", + "fraud": null, + "add_ons": null, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+15108675310" + } + }, + "fetchCarrierInternational": { + "value": { + "caller_name": null, + "carrier": { + "error_code": null, + "mobile_country_code": null, + "mobile_network_code": null, + "name": "Vodafone Business Solutions", + "type": "landline" + }, + "country_code": "GB", + "national_format": "020 7765 1182", + "phone_number": "+4402077651182", + "fraud": null, + "add_ons": null, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+4402077651182" + } + }, + "fetchCallerName": { + "value": { + "caller_name": { + "caller_name": "Delicious Cheese Cake", + "caller_type": "CONSUMER", + "error_code": null + }, + "carrier": null, + "fraud": null, + "country_code": "US", + "national_format": "(510) 867-5310", + "phone_number": "+15108675310", + "add_ons": null, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+15108675310" + } + }, + "fetchCarrierAndCallerName": { + "value": { + "caller_name": { + "caller_name": "Delicious Cheese Cake", + "caller_type": "CONSUMER", + "error_code": null + }, + "carrier": { + "error_code": null, + "mobile_country_code": "310", + "mobile_network_code": "456", + "name": "verizon", + "type": "mobile" + }, + "fraud": null, + "country_code": "US", + "national_format": "(510) 867-5310", + "phone_number": "+15108675310", + "add_ons": { + "status": "successful", + "message": null, + "code": null, + "results": {} + }, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+15108675310" + } + }, + "fetchAddonsWhitepagesPro": { + "value": { + "caller_name": { + "caller_name": "EMPIRE STATE BUILDING", + "caller_type": "BUSINESS", + "error_code": null + }, + "country_code": "US", + "phone_number": "+12127363100", + "national_format": "(212) 736-3100", + "carrier": null, + "fraud": null, + "add_ons": { + "status": "successful", + "message": null, + "code": null, + "results": { + "whitepages_pro_caller_id": { + "status": "successful", + "request_sid": "XR28b8f152ae12345605b0b3cc34123456", + "message": null, + "code": null, + "result": { + "phone_number": "2127363100", + "warnings": [], + "historical_addresses": [], + "alternate_phones": [], + "error": null, + "is_commercial": true, + "associated_people": [], + "country_calling_code": "1", + "belongs_to": [], + "is_valid": true, + "line_type": "NonFixedVOIP", + "carrier": "Level 3 Communications", + "current_addresses": [ + { + "city": "New York", + "lat_long": { + "latitude": 40.748731, + "longitude": -73.986413, + "accuracy": "RoofTop" + }, + "is_active": null, + "location_type": "Address", + "street_line_2": null, + "link_to_person_start_date": "2018-08-28", + "street_line_1": "350 5th Ave", + "postal_code": "10118", + "delivery_point": "MultiUnit", + "country_code": "US", + "state_code": "NY", + "id": "Location.4e81b857-1234-5678-31d29a3301e1", + "zip4": "0110" + } + ], + "id": "Phone.f8396fef-1234-5678-bc7128b6fd99", + "is_prepaid": false + } + } + } + }, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+12127363100" + } + }, + "fetchAddonsNomorobo": { + "value": { + "caller_name": null, + "country_code": "US", + "phone_number": "+19892008374", + "national_format": "(989) 200-8374", + "carrier": { + "mobile_country_code": "310", + "mobile_network_code": null, + "name": "Ytel/Blitz", + "type": "mobile", + "error_code": null + }, + "fraud": null, + "add_ons": { + "status": "successful", + "message": null, + "code": null, + "results": { + "nomorobo_spamscore": { + "status": "successful", + "request_sid": "XR763c8acc4c56d5e3e18d2f0f12345bc1", + "message": null, + "code": null, + "result": { + "status": "success", + "message": "success", + "score": 1 + } + } + } + }, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+19892008374" + } + }, + "fetchAddonsPayfone": { + "value": { + "caller_name": null, + "country_code": "US", + "phone_number": "+16502530000", + "national_format": "(650) 253-0000", + "carrier": { + "mobile_country_code": null, + "mobile_network_code": null, + "name": "Level 3 Communications, LLC", + "type": "landline", + "error_code": null + }, + "fraud": null, + "add_ons": { + "status": "successful", + "message": null, + "code": null, + "results": { + "payfone_tcpa_compliance": { + "status": "successful", + "request_sid": "XRd3a2991c9108bde3ca9589ed84d31463", + "message": null, + "code": null, + "result": { + "Status": 0, + "Response": { + "MSISDNType": "NonFixedVoIP", + "NumberMatch": "I", + "VerifyNumberTransactionId": "2019459819" + }, + "RequestId": "XRd3a2991c9108bde3ca9589ed84d31463", + "Description": "Success." + } + } + } + }, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+16502530000" + } + } } } }, @@ -158,10 +520,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumber" } } }, @@ -170,10 +529,14 @@ "url": "https://lookups.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "LookupsV1PhoneNumber" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_lookups_v2.json b/spec/json/twilio_lookups_v2.json index bd24c036..9df06816 100644 --- a/spec/json/twilio_lookups_v2.json +++ b/spec/json/twilio_lookups_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "lookups.v2.phone_number": { "type": "object", @@ -12,18 +18,36 @@ "country_code": { "type": "string", "nullable": true, - "description": "The phone number's [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." + "description": "The phone number's [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number." + "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "national_format": { "type": "string", "nullable": true, - "description": "The phone number in [national format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers)." + "description": "The phone number in [national format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "valid": { "type": "boolean", @@ -41,7 +65,13 @@ }, "caller_name": { "nullable": true, - "description": "An object that contains caller name information based on [CNAM](https://support.twilio.com/hc/en-us/articles/360051670533-Getting-Started-with-CNAM-Caller-ID)." + "description": "An object that contains caller name information based on [CNAM](https://support.twilio.com/hc/en-us/articles/360051670533-Getting-Started-with-CNAM-Caller-ID).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "sim_swap": { "nullable": true, @@ -51,9 +81,9 @@ "nullable": true, "description": "An object that contains information on the unconditional call forwarding status of mobile phone number." }, - "live_activity": { + "line_status": { "nullable": true, - "description": "An object that contains live activity information for a mobile phone number." + "description": "An object that contains line status information for a mobile phone number." }, "line_type_intelligence": { "nullable": true, @@ -63,10 +93,18 @@ "nullable": true, "description": "An object that contains identity match information. The result of comparing user-provided information including name, address, date of birth, national ID, against authoritative phone-based data sources" }, + "reassigned_number": { + "nullable": true, + "description": "An object that contains reassigned number information. Reassigned Numbers will return a phone number's reassignment status given a phone number and date" + }, "sms_pumping_risk": { "nullable": true, "description": "An object that contains information on if a phone number has been currently or previously blocked by Verify Fraud Guard for receiving malicious SMS pumping traffic as well as other signals associated with risky carriers and low conversion rates." }, + "phone_number_quality_score": { + "nullable": true, + "description": "An object that contains information of a mobile phone number quality score. Quality score will return a risk score about the phone number." + }, "url": { "type": "string", "format": "uri", @@ -94,12 +132,6 @@ "NOT_A_NUMBER" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -115,7 +147,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -138,6 +170,9 @@ }, "get": { "description": "", + "tags": [ + "LookupsV2PhoneNumber" + ], "parameters": [ { "name": "PhoneNumber", @@ -146,14 +181,67 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { "name": "Fields", "in": "query", - "description": "A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match.", + "description": "A comma-separated list of fields to return. Possible values are validation, caller_name, sim_swap, call_forwarding, line_status, line_type_intelligence, identity_match, reassigned_number, sms_pumping_risk, phone_number_quality_score.", "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" + } } }, { @@ -162,6 +250,12 @@ "description": "The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -170,6 +264,11 @@ "description": "User\u2019s first name. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "John" + } } }, { @@ -178,6 +277,11 @@ "description": "User\u2019s last name. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "Doe" + } } }, { @@ -186,6 +290,11 @@ "description": "User\u2019s first address line. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "321 Main Street" + } } }, { @@ -194,6 +303,11 @@ "description": "User\u2019s second address line. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "Suite 2" + } } }, { @@ -202,6 +316,11 @@ "description": "User\u2019s city. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "New York" + } } }, { @@ -210,6 +329,11 @@ "description": "User\u2019s country subdivision, such as state, province, or locality. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "NY" + } } }, { @@ -218,6 +342,11 @@ "description": "User\u2019s postal zip code. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "10021" + } } }, { @@ -227,6 +356,11 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "fetchIdentityMatch": { + "value": "US" + } } }, { @@ -235,6 +369,17 @@ "description": "User\u2019s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + }, + "examples": { + "fetchIdentityMatch": { + "value": "YZ3456883" + } } }, { @@ -243,6 +388,36 @@ "description": "User\u2019s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + }, + "examples": { + "fetchIdentityMatch": { + "value": "19901214" + } + } + }, + { + "name": "LastVerifiedDate", + "in": "query", + "description": "The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests.", + "schema": { + "type": "string" + }, + "examples": { + "fetchReassignedNumberWithNumberReassigned": { + "value": "20201227" + }, + "fetchReassignedNumberWithNumberNoReassigned": { + "value": "20190924" + }, + "fetchReassignedNumberWithNoDataAvailable": { + "value": "20211224" + } } } ], @@ -252,6 +427,458 @@ "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, + "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, + "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, + "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, + "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, + "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, + "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, + "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, + "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, + "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, + "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, + "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, + "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, + "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, + "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, + "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, + "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": { + "mobile_country_code": "452", + "mobile_network_code": "05", + "carrier_risk_score": 17, + "carrier_risk_category": "low", + "line_type": "mobile", + "name": "Twilio Carrier" + }, + "quality_score": 0, + "quality_category": "low", + "velocity_risk_score": 0, + "velocity_risk_category": "low", + "error_code": null + }, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + } } } }, @@ -263,10 +890,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPhoneNumber" } } }, @@ -275,10 +899,14 @@ "url": "https://lookups.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "LookupsV2PhoneNumber" + } + ], + "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/spec/json/twilio_media_v1.json b/spec/json/twilio_media_v1.json index a32c5961..41334914 100644 --- a/spec/json/twilio_media_v1.json +++ b/spec/json/twilio_media_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "media.v1.media_processor": { "type": "object", @@ -35,12 +41,18 @@ "extension": { "type": "string", "nullable": true, - "description": "The [Media Extension](/docs/live/api/media-extensions-overview) name or URL. Ex: `video-composer-v2`" + "description": "The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "extension_context": { "type": "string", "nullable": true, - "description": "The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/api/media-extensions-overview) you are using for more information about the context to send." + "description": "The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send." }, "status": { "type": "string", @@ -63,7 +75,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) for details." + "description": "The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details." }, "status_callback_method": { "type": "string", @@ -192,7 +204,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/status-callbacks) for more details." + "description": "The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details." }, "status_callback_method": { "type": "string", @@ -297,7 +309,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/status-callbacks) for more details." + "description": "The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details." }, "status_callback_method": { "type": "string", @@ -393,12 +405,31 @@ "description": "The grant that authorizes the player sdk to connect to the livestream" } } - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" + }, + "transcription_enum_status": { + "type": "string", + "enum": [ + "completed", + "deleted", + "enqueued", + "failed", + "processing" + ] + }, + "transcription_configuration_enum_method": { + "type": "string", + "enum": [ + "get", + "post" + ] + }, + "transcription_result_enum_format": { + "type": "string", + "enum": [ + "json", + "raw", + "txt" + ] } } }, @@ -415,7 +446,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -433,17 +464,38 @@ "extension", "extension_context" ], - "pathType": "list", - "mountName": "media_processor" + "mountName": "media_processor", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "MediaV1MediaProcessor" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.media_processor" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "started", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": null, + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + } } } }, @@ -456,9 +508,6 @@ } ], "operationId": "CreateMediaProcessor", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -468,19 +517,19 @@ "properties": { "Extension": { "type": "string", - "description": "The [Media Extension](/docs/live/api/media-extensions-overview) name or URL. Ex: `video-composer-v2`" + "description": "The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`" }, "ExtensionContext": { "type": "string", - "description": "The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/api/media-extensions-overview) you are using for more information about the context to send." + "description": "The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send." }, "ExtensionEnvironment": { - "description": "User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the documentation for the specific [Media Extension](/docs/live/api/media-extensions-overview) you are using for more information about whether you need to provide this." + "description": "User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about whether you need to provide this." }, "StatusCallback": { "type": "string", "format": "uri", - "description": "The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) for details." + "description": "The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details." }, "StatusCallbackMethod": { "type": "string", @@ -504,6 +553,18 @@ "Extension", "ExtensionContext" ] + }, + "examples": { + "create": { + "value": { + "Extension": "video-composer-v2", + "ExtensionContext": "{}", + "ExtensionEnvironment": "{}", + "StatusCallback": "http://www.example.com", + "StatusCallbackMethod": "POST", + "MaxDuration": 300 + } + } } } } @@ -511,6 +572,9 @@ }, "get": { "description": "Returns a list of MediaProcessors.", + "tags": [ + "MediaV1MediaProcessor" + ], "parameters": [ { "name": "Order", @@ -519,6 +583,20 @@ "schema": { "type": "string", "$ref": "#/components/schemas/media_processor_enum_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readItems": { + "value": "desc" + }, + "readItemsUsingPageToken": { + "value": "desc" + }, + "readItemsPageLargerThanMax": { + "value": "desc" + } } }, { @@ -528,6 +606,20 @@ "schema": { "type": "string", "$ref": "#/components/schemas/media_processor_enum_status" + }, + "examples": { + "readEmpty": { + "value": "started" + }, + "readItems": { + "value": "ended" + }, + "readItemsUsingPageToken": { + "value": "ended" + }, + "readItemsPageLargerThanMax": { + "value": "ended" + } } }, { @@ -573,16 +665,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -591,18 +685,119 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/MediaProcessors?Status=started&Order=asc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaProcessors?Status=started&Order=asc&PageSize=10&Page=0", + "next_page_url": null, + "key": "media_processors" + }, + "media_processors": [] + } + }, + "readItems": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0", + "next_page_url": null, + "key": "media_processors" + }, + "media_processors": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "ended", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + ] + } + }, + "readItemsUsingPageToken": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0&PageToken=PTTUszYTgyOGFhNDIzZWExNzA0OTkwODNlMDlkZTg3M2NiNDoxOjI%253D", + "next_page_url": null, + "key": "media_processors" + }, + "media_processors": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "ended", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + ] + } + }, + "readItemsPageLargerThanMax": { + "value": { + "meta": { + "page": 0, + "page_size": 100, + "first_page_url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=100&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=100&Page=0", + "next_page_url": null, + "key": "media_processors" + }, + "media_processors": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "ended", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + ] } } } @@ -616,10 +811,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMediaProcessor", - "x-maturity": [ - "GA" - ] + "operationId": "ListMediaProcessor" } }, "/v1/MediaProcessors/{Sid}": { @@ -636,11 +828,14 @@ "extension", "extension_context" ], - "pathType": "instance", - "mountName": "media_processor" + "mountName": "media_processor", + "pathType": "instance" }, "get": { "description": "Returns a single MediaProcessor resource identified by a SID.", + "tags": [ + "MediaV1MediaProcessor" + ], "parameters": [ { "name": "Sid", @@ -661,6 +856,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.media_processor" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "started", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": null, + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + } } } }, @@ -672,13 +885,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMediaProcessor", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMediaProcessor" }, "post": { "description": "Updates a MediaProcessor resource identified by a SID.", + "tags": [ + "MediaV1MediaProcessor" + ], "parameters": [ { "name": "Sid", @@ -699,6 +912,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.media_processor" + }, + "examples": { + "updateEnded": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "ended", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + } } } }, @@ -711,9 +942,6 @@ } ], "operationId": "UpdateMediaProcessor", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -730,6 +958,13 @@ "required": [ "Status" ] + }, + "examples": { + "updateEnded": { + "value": { + "Status": "ended" + } + } } } } @@ -748,15 +983,28 @@ "sid", "status" ], - "pathType": "instance", "dependentProperties": { - "media/v1/media_recording_timed_metadata": "{media_recording_sid: sid}", - "media/v1/media_recording_media": "{media_recording_sid: sid}" + "timed_metadata": { + "mapping": { + "media_recording_sid": "sid" + }, + "resource_url": "/v1/MediaRecordings/{media_recording_sid}/TimedMetadata" + }, + "media": { + "mapping": { + "media_recording_sid": "sid" + }, + "resource_url": "/v1/MediaRecordings/{media_recording_sid}/Media" + } }, - "mountName": "media_recording" + "mountName": "media_recording", + "pathType": "instance" }, "delete": { "description": "Deletes a MediaRecording resource identified by a SID.", + "tags": [ + "MediaV1MediaRecording" + ], "parameters": [ { "name": "Sid", @@ -781,13 +1029,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMediaRecording", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteMediaRecording" }, "get": { "description": "Returns a single MediaRecording resource identified by a SID.", + "tags": [ + "MediaV1MediaRecording" + ], "parameters": [ { "name": "Sid", @@ -808,6 +1056,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.media_recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "duration": 2147483647, + "format": "mp4", + "links": { + "media": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/Media", + "timed_metadata": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/TimedMetadata" + }, + "processor_sid": "ZXcafebabecafebabecafebabecafebabe", + "resolution": "640x480", + "source_sid": "RMcafebabecafebabecafebabecafebabe", + "sid": "KVcafebabecafebabecafebabecafebabe", + "media_size": 2147483648, + "status": "completed", + "status_callback": "https://www.example.com", + "status_callback_method": "POST", + "url": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe" + } + } } } }, @@ -819,10 +1091,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMediaRecording", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchMediaRecording" } }, "/v1/MediaRecordings": { @@ -837,15 +1106,28 @@ "sid", "status" ], - "pathType": "list", "dependentProperties": { - "media/v1/media_recording_timed_metadata": "{media_recording_sid: sid}", - "media/v1/media_recording_media": "{media_recording_sid: sid}" + "timed_metadata": { + "mapping": { + "media_recording_sid": "sid" + }, + "resource_url": "/v1/MediaRecordings/{media_recording_sid}/TimedMetadata" + }, + "media": { + "mapping": { + "media_recording_sid": "sid" + }, + "resource_url": "/v1/MediaRecordings/{media_recording_sid}/Media" + } }, - "mountName": "media_recording" + "mountName": "media_recording", + "pathType": "list" }, "get": { "description": "Returns a list of MediaRecordings.", + "tags": [ + "MediaV1MediaRecording" + ], "parameters": [ { "name": "Order", @@ -854,6 +1136,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/media_recording_enum_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readItems": { + "value": "desc" + } } }, { @@ -863,6 +1153,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/media_recording_enum_status" + }, + "examples": { + "readEmpty": { + "value": "processing" + }, + "readItems": { + "value": "completed" + } } }, { @@ -874,6 +1172,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^ZX[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readItems": { + "value": "ZXcafebabecafebabecafebabecafebabe" + } } }, { @@ -885,6 +1191,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readItems": { + "value": "RMcafebabecafebabecafebabecafebabe" + } } }, { @@ -930,16 +1244,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -948,18 +1264,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/MediaRecordings?Status=processing&SourceSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ProcessorSid=ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Order=asc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaRecordings?Status=processing&SourceSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ProcessorSid=ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Order=asc&PageSize=10&Page=0", + "next_page_url": null, + "key": "media_recordings" + }, + "media_recordings": [] + } + }, + "readItems": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/MediaRecordings?Status=completed&SourceSid=RMcafebabecafebabecafebabecafebabe&ProcessorSid=ZXcafebabecafebabecafebabecafebabe&Order=desc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaRecordings?Status=completed&SourceSid=RMcafebabecafebabecafebabecafebabe&ProcessorSid=ZXcafebabecafebabecafebabecafebabe&Order=desc&PageSize=10&Page=0", + "next_page_url": null, + "key": "media_recordings" + }, + "media_recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "duration": 1000, + "format": "mp4", + "links": { + "media": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/Media", + "timed_metadata": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/TimedMetadata" + }, + "processor_sid": "ZXcafebabecafebabecafebabecafebabe", + "resolution": "640x480", + "source_sid": "RMcafebabecafebabecafebabecafebabe", + "sid": "KVcafebabecafebabecafebabecafebabe", + "media_size": 1000, + "status": "completed", + "status_callback": "https://www.example.com", + "status_callback_method": "POST", + "url": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe" + } + ] } } } @@ -973,10 +1338,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMediaRecording", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMediaRecording" } }, "/v1/PlayerStreamers/{Sid}": { @@ -991,16 +1353,34 @@ "sid", "status" ], - "pathType": "instance", "dependentProperties": { - "media/v1/player_streamer_timed_metadata": "{player_streamer_sid: sid}", - "playback_grant": "{sid: sid}", - "media/v1/player_streamer_recording_playback_grant": "{sid: sid}" + "timed_metadata": { + "mapping": { + "player_streamer_sid": "sid" + }, + "resource_url": "/v1/PlayerStreamers/{player_streamer_sid}/TimedMetadata" + }, + "playback_grant": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v1/PlayerStreamers/{sid}/PlaybackGrant" + }, + "recording_playback_grant": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v1/PlayerStreamers/{sid}/RecordingPlaybackGrant" + } }, - "mountName": "player_streamer" + "mountName": "player_streamer", + "pathType": "instance" }, "get": { "description": "Returns a single PlayerStreamer resource identified by a SID.", + "tags": [ + "MediaV1PlayerStreamer" + ], "parameters": [ { "name": "Sid", @@ -1021,6 +1401,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.player_streamer" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "created", + "video": true, + "sid": "VJcafebabecafebabecafebabecafebabe", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": null, + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe", + "max_duration": 300, + "links": { + "timed_metadata": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata", + "playback_grant": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant" + } + } + } } } }, @@ -1032,13 +1433,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPlayerStreamer", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPlayerStreamer" }, "post": { "description": "Updates a PlayerStreamer resource identified by a SID.", + "tags": [ + "MediaV1PlayerStreamer" + ], "parameters": [ { "name": "Sid", @@ -1059,6 +1460,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.player_streamer" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "status": "ended", + "video": true, + "sid": "VJcafebabecafebabecafebabecafebabe", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe", + "max_duration": 300, + "links": { + "timed_metadata": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata", + "playback_grant": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant" + } + } + } } } }, @@ -1071,9 +1493,6 @@ } ], "operationId": "UpdatePlayerStreamer", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1090,6 +1509,13 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "ended" + } + } } } } @@ -1108,22 +1534,61 @@ "sid", "status" ], - "pathType": "list", "dependentProperties": { - "media/v1/player_streamer_timed_metadata": "{player_streamer_sid: sid}", - "playback_grant": "{sid: sid}", - "media/v1/player_streamer_recording_playback_grant": "{sid: sid}" + "timed_metadata": { + "mapping": { + "player_streamer_sid": "sid" + }, + "resource_url": "/v1/PlayerStreamers/{player_streamer_sid}/TimedMetadata" + }, + "playback_grant": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v1/PlayerStreamers/{sid}/PlaybackGrant" + }, + "recording_playback_grant": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v1/PlayerStreamers/{sid}/RecordingPlaybackGrant" + } }, - "mountName": "player_streamer" + "mountName": "player_streamer", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "MediaV1PlayerStreamer" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.player_streamer" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "created", + "video": true, + "sid": "VJcafebabecafebabecafebabecafebabe", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": null, + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe", + "max_duration": 300, + "links": { + "timed_metadata": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata", + "playback_grant": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant" + } + } + } } } }, @@ -1136,9 +1601,6 @@ } ], "operationId": "CreatePlayerStreamer", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1153,7 +1615,7 @@ "StatusCallback": { "type": "string", "format": "uri", - "description": "The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/status-callbacks) for more details." + "description": "The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details." }, "StatusCallbackMethod": { "type": "string", @@ -1173,6 +1635,11 @@ "description": "The maximum time, in seconds, that the PlayerStreamer is active (`created` or `started`) before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the PlayerStreamer, regardless of whether media is still streaming." } } + }, + "examples": { + "create": { + "value": {} + } } } } @@ -1180,6 +1647,9 @@ }, "get": { "description": "Returns a list of PlayerStreamers.", + "tags": [ + "MediaV1PlayerStreamer" + ], "parameters": [ { "name": "Order", @@ -1188,6 +1658,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/player_streamer_enum_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readItems": { + "value": "desc" + }, + "readItemsPageLargerThanMax": { + "value": "desc" + } } }, { @@ -1197,6 +1678,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/player_streamer_enum_status" + }, + "examples": { + "readEmpty": { + "value": "started" + }, + "readItems": { + "value": "ended" + }, + "readItemsPageLargerThanMax": { + "value": "ended" + } } }, { @@ -1242,16 +1734,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1260,18 +1754,96 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/PlayerStreamers?Status=started&Order=asc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/PlayerStreamers?Status=started&Order=asc&PageSize=10&Page=0", + "next_page_url": null, + "key": "player_streamers" + }, + "player_streamers": [] + } + }, + "readItems": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=10&Page=0", + "next_page_url": null, + "key": "player_streamers" + }, + "player_streamers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "status": "ended", + "video": true, + "sid": "VJcafebabecafebabecafebabecafebabe", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe", + "max_duration": 300, + "links": { + "timed_metadata": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata", + "playback_grant": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant" + } + } + ] + } + }, + "readItemsPageLargerThanMax": { + "value": { + "meta": { + "page": 0, + "page_size": 100, + "first_page_url": "https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=100&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=100&Page=0", + "next_page_url": null, + "key": "player_streamers" + }, + "player_streamers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "status": "ended", + "video": true, + "sid": "VJcafebabecafebabecafebabecafebabe", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe", + "max_duration": 300, + "links": { + "timed_metadata": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata", + "playback_grant": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant" + } + } + ] } } } @@ -1285,10 +1857,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPlayerStreamer", - "x-maturity": [ - "GA" - ] + "operationId": "ListPlayerStreamer" } }, "/v1/PlayerStreamers/{Sid}/PlaybackGrant": { @@ -1300,11 +1869,14 @@ "description": "A PlaybackGrant resource allows developers to generate a grant to initialize the Twilio Live Player SDK and connect to a livestream.", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/PlayerStreamers/{Sid}" + "parent": "/PlayerStreamers/{Sid}", + "pathType": "instance" }, "post": { "description": "", + "tags": [ + "MediaV1PlaybackGrant" + ], "parameters": [ { "name": "Sid", @@ -1325,6 +1897,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.player_streamer.player_streamer_playback_grant" + }, + "examples": { + "create": { + "value": { + "sid": "VJcafebabecafebabecafebabecafebabe", + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "grant": { + "playbackUrl": "http://video.net/123/blabla?token=123", + "playerStreamerSid": "VJcafebabecafebabecafebabecafebabe", + "requestCredentials": null + } + } + } } } }, @@ -1337,9 +1924,6 @@ } ], "operationId": "CreatePlayerStreamerPlaybackGrant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1356,6 +1940,14 @@ "description": "The full origin URL where the livestream can be streamed. If this is not provided, it can be streamed from any domain." } } + }, + "examples": { + "create": { + "value": { + "Ttl": 100, + "AccessControlAllowOrigin": "youraccess_control_allow_origin.com" + } + } } } } @@ -1363,6 +1955,9 @@ }, "get": { "description": "**This method is not enabled.** Returns a single PlaybackGrant resource identified by a SID.", + "tags": [ + "MediaV1PlaybackGrant" + ], "parameters": [ { "name": "Sid", @@ -1383,6 +1978,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.player_streamer.player_streamer_playback_grant" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant", + "sid": "VJcafebabecafebabecafebabecafebabe", + "grant": { + "playbackUrl": "http://video.net/123/blabla?token=123", + "playerStreamerSid": "VJcafebabecafebabecafebabecafebabe", + "requestCredentials": null + } + } + } } } }, @@ -1394,10 +2004,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPlayerStreamerPlaybackGrant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPlayerStreamerPlaybackGrant" } } }, @@ -1406,14 +2013,47 @@ "url": "https://media.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "MediaV1MediaProcessor" + }, + { + "name": "MediaV1MediaRecording" + }, + { + "name": "MediaV1MediaRecordingMedia" + }, + { + "name": "MediaV1PlaybackGrant" + }, + { + "name": "MediaV1PlayerStreamer" + }, { - "name": "GA", - "description": "This product is Generally Available." + "name": "MediaV1RecordingPlaybackGrant" }, { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." + "name": "MediaV1RecordingTimedMetadata" + }, + { + "name": "MediaV1Result" + }, + { + "name": "MediaV1TimedMetadata" + }, + { + "name": "MediaV1Transcription" + }, + { + "name": "MediaV1TranscriptionConfigurations" + }, + { + "name": "MediaV1TranscriptionDefaultSettings" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_messaging_bulk_v1.json b/spec/json/twilio_messaging_bulk_v1.json new file mode 100644 index 00000000..2e7947f1 --- /dev/null +++ b/spec/json/twilio_messaging_bulk_v1.json @@ -0,0 +1,638 @@ +{ + "openapi": "3.0.3", + "security": [ + { + "accountSid_authToken": [] + } + ], + "info": { + "title": "Bulk Messaging and Broadcast", + "description": "Bulk Sending is a public Twilio REST API for 1:Many Message creation up to 100 recipients. Broadcast is a public Twilio REST API for 1:Many Message creation up to 10,000 recipients via file upload.", + "termsOfService": "https://www.twilio.com/legal/tos", + "version": "1.0.0-alpha.1", + "contact": { + "name": "Twilio Support", + "url": "https://support.twilio.com", + "email": "support@twilio.com" + }, + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "servers": [ + { + "url": "https://preview.messaging.twilio.com" + } + ], + "paths": { + "/v1/Messages": { + "post": { + "description": "Send messages to multiple recipients", + "operationId": "CreateMessages", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateMessagesRequest", + "properties": { + "Messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messaging.v1.Message" + } + }, + "From": { + "type": "string", + "format": "phone-number", + "description": "A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using `messaging_service_sid`, this parameter must be empty." + }, + "MessagingServiceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$", + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with the Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) you have configured and leave the `from` parameter empty. When only this parameter is set, Twilio will use your enabled Copilot Features to select the `from` phone number for delivery." + }, + "Body": { + "type": "string", + "description": "The text of the message you want to send. Can be up to 1,600 characters in length." + }, + "ContentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "description": "The SID of the preconfigured [Content Template](https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template) you want to associate with the Message. Must be used in conjuction with a preconfigured [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) When this parameter is set, Twilio will use your configured content template and the provided `ContentVariables`. This Twilio product is currently in Private Beta." + }, + "MediaUrl": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URL of the media to send with the message. The media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on the recipient's device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada." + }, + "StatusCallback": { + "type": "string", + "format": "uri", + "description": "The URL we should call using the \"status_callback_method\" to send status information to your application. If specified, we POST these message status changes to the URL - queued, failed, sent, delivered, or undelivered. Twilio will POST its [standard request parameters](https://www.twilio.com/docs/messaging/twiml#request-parameters) as well as some additional parameters including \"MessageSid\", \"MessageStatus\", and \"ErrorCode\". If you include this parameter with the \"messaging_service_sid\", we use this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api). URLs must contain a valid hostname and underscores are not allowed." + }, + "ValidityPeriod": { + "type": "integer", + "description": "How long in seconds the message can remain in our outgoing message queue. After this period elapses, the message fails and we call your status callback. Can be between 1 and the default value of 14,400 seconds. After a message has been accepted by a carrier, however, we cannot guarantee that the message will not be queued after this period. We recommend that this value be at least 5 seconds." + }, + "SendAt": { + "type": "string", + "description": "The time at which Twilio will send the message. This parameter can be used to schedule a message to be sent at a particular time. Must be in ISO 8601 format." + }, + "ScheduleType": { + "type": "string", + "description": "This parameter indicates your intent to schedule a message. Pass the value `fixed` to schedule a message at a fixed time. This parameter works in conjuction with the `SendAt` parameter." + }, + "ShortenUrls": { + "type": "boolean", + "description": "Determines the usage of Click Tracking. Setting it to `true` will instruct Twilio to replace all links in the Message with a shortened version based on the associated Domain Sid and track clicks on them. If this parameter is not set on an API call, we will use the value set on the Messaging Service. If this parameter is not set and the value is not configured on the Messaging Service used this will default to `false`." + }, + "SendAsMms": { + "type": "boolean", + "description": "If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media." + }, + "MaxPrice": { + "type": "number", + "description": "The maximum total price in US dollars that you will pay for the message to be delivered. Can be a decimal value that has up to 4 decimal places. All messages are queued for delivery and the message cost is checked before the message is sent. If the cost exceeds max_price, the message will fail and a status of Failed is sent to the status callback. If MaxPrice is not set, the message cost is not checked." + }, + "Attempt": { + "type": "integer", + "description": "Total number of attempts made ( including this ) to send out the message regardless of the provider used" + }, + "SmartEncoded": { + "type": "boolean", + "description": "This parameter indicates whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be true or false." + }, + "ForceDelivery": { + "type": "boolean", + "description": "This parameter allows Twilio to send SMS traffic to carriers without checking/caring whether the destination number is a mobile or a landline." + }, + "ApplicationSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "description": "The SID of the application that should receive message status. We POST a message_sid parameter and a message_status parameter with a value of sent or failed to the application's message_status_callback. If a status_callback parameter is also passed, it will be ignored and the application's message_status_callback parameter will be used." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.CreateMessagesResult" + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.Error" + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + } + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ] + } + }, + "/v1/Broadcasts/{BroadcastSid}": { + "parameters": [ + { + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BC[0-9a-fA-F]{32}$" + }, + "name": "BroadcastSid", + "description": "Id of an existing Broadcast.", + "in": "path", + "required": true + } + ] + }, + "/v1/Broadcasts": { + "post": { + "description": "Create a new Broadcast", + "operationId": "CreateBroadcast", + "responses": { + "201": { + "description": "Broadcast Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.Broadcast" + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + } + }, + "400": { + "description": "Missing Required Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.Error" + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + } + }, + "429": { + "description": "Broadcast Upload Limit Reached", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.Error" + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.Error" + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + } + } + }, + "parameters": [ + { + "schema": { + "type": "string", + "format": "uuid" + }, + "in": "header", + "name": "X-Twilio-Request-Key", + "description": "Idempotency key provided by the client" + } + ], + "security": [ + { + "accountSid_authToken": [] + } + ] + } + }, + "/v1/Broadcasts/{BroadcastSid}/Cancel": { + "parameters": [ + { + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BC[0-9a-fA-F]{32}$" + }, + "name": "BroadcastSid", + "description": "Id of an existing Broadcast.", + "in": "path", + "required": true + } + ] + } + }, + "components": { + "schemas": { + "messaging.v1.Message": { + "type": "object", + "properties": { + "To": { + "type": "string", + "format": "phone-number", + "description": "The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd-party channels." + }, + "Body": { + "type": "string", + "description": "The text of the message you want to send. Can be up to 1,600 characters in length. Overrides the request-level body and content template if provided." + }, + "ContentVariables": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of variable names to substitution values. Refer to the [Twilio Content API Resources](https://www.twilio.com/docs/content-api/content-api-resources#send-a-message-with-preconfigured-content) for more details." + } + } + }, + "messaging.v1.MessageReceipt": { + "type": "object", + "properties": { + "to": { + "type": "string", + "nullable": true, + "description": "The recipient phone number" + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that identifies the resource" + } + } + }, + "messaging.v1.FailedMessageReceipt": { + "type": "object", + "properties": { + "to": { + "type": "string", + "description": "The recipient phone number" + }, + "error_message": { + "type": "string", + "description": "The description of the error_code" + }, + "error_code": { + "type": "integer", + "description": "The error code associated with the message creation attempt" + } + } + }, + "messaging.v1.CreateMessagesResult": { + "properties": { + "total_message_count": { + "type": "integer", + "description": "The number of Messages processed in the request, equal to the sum of success_count and error_count." + }, + "success_count": { + "type": "integer", + "description": "The number of Messages successfully created." + }, + "error_count": { + "type": "integer", + "description": "The number of Messages unsuccessfully processed in the request." + }, + "message_receipts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messaging.v1.MessageReceipt" + } + }, + "failed_message_receipts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messaging.v1.FailedMessageReceipt" + } + } + } + }, + "messaging.v1.Broadcast": { + "title": "Broadcast", + "type": "object", + "description": "Details of a Broadcast", + "properties": { + "broadcast_sid": { + "type": "string", + "description": "Numeric ID indentifying individual Broadcast requests" + }, + "created_date": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the Broadcast was created" + }, + "updated_date": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the Broadcast was last updated" + }, + "broadcast_status": { + "type": "string", + "description": "Status of the Broadcast request. Valid values are None, Pending-Upload, Uploaded, Queued, Executing, Execution-Failure, Execution-Completed, Cancelation-Requested, and Canceled" + }, + "execution_details": { + "type": "object", + "description": "Details on the statuses of messages sent to recipients", + "properties": { + "total_records": { + "type": "integer", + "description": "Number of recipients in the Broadcast request" + }, + "total_completed": { + "type": "integer", + "description": "Number of recipients with messages successfully sent to them" + }, + "total_errors": { + "type": "integer", + "description": "Number of recipients with messages unsuccessfully sent to them, producing an error" + } + } + }, + "results_file": { + "type": "string", + "format": "uri", + "description": "Path to a file detailing successful requests and errors from Broadcast execution" + } + } + }, + "messaging.v1.Error": { + "title": "Error", + "type": "object", + "description": "Standard Error Body", + "properties": { + "code": { + "type": "integer", + "description": "The Twilio error code" + }, + "message": { + "type": "string", + "description": "The error message details" + }, + "status": { + "type": "integer", + "description": "The HTTP status code" + }, + "more_info": { + "type": "string", + "description": "More information on the error" + } + } + } + }, + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + } + } +} \ No newline at end of file diff --git a/spec/json/twilio_messaging_v1.json b/spec/json/twilio_messaging_v1.json index 942a9aa9..9754a2b5 100644 --- a/spec/json/twilio_messaging_v1.json +++ b/spec/json/twilio_messaging_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "messaging.v1.service.alpha_sender": { "type": "object", @@ -148,7 +154,13 @@ "failure_reason": { "type": "string", "nullable": true, - "description": "A reason why brand registration has failed. Only applicable when status is FAILED." + "description": "DEPRECATED. A reason why brand registration has failed. Only applicable when status is FAILED." + }, + "errors": { + "type": "array", + "items": {}, + "nullable": true, + "description": "A list of errors that occurred during the brand registration process." }, "url": { "type": "string", @@ -168,7 +180,7 @@ "$ref": "#/components/schemas/brand_registrations_enum_brand_feedback" }, "nullable": true, - "description": "Feedback on how to improve brand score" + "description": "DEPRECATED. Feedback on how to improve brand score" }, "identity_status": { "type": "string", @@ -311,6 +323,68 @@ "campaign-verify" ] }, + "messaging.v1.service.channel_sender": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ChannelSender resource." + }, + "messaging_service_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Service](https://www.twilio.com/docs/messaging/services) the resource is associated with." + }, + "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 ChannelSender resource." + }, + "sender": { + "type": "string", + "nullable": true, + "description": "The unique string that identifies the sender e.g whatsapp:+123456XXXX." + }, + "sender_type": { + "type": "string", + "nullable": true, + "description": "A string value that identifies the sender type e.g WhatsApp, Messenger." + }, + "country_code": { + "type": "string", + "nullable": true, + "description": "The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) of the number." + }, + "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 ChannelSender resource." + } + } + }, "messaging.v1.deactivation": { "type": "object", "properties": { @@ -529,7 +603,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) that the resource is associated with." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with." }, "date_created": { "type": "string", @@ -742,17 +816,17 @@ "sticky_sender": { "type": "boolean", "nullable": true, - "description": "Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance." + "description": "Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance." }, "mms_converter": { "type": "boolean", "nullable": true, - "description": "Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance." + "description": "Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance." }, "smart_encoding": { "type": "boolean", "nullable": true, - "description": "Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance." + "description": "Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance." }, "scan_message_content": { "type": "string", @@ -763,12 +837,12 @@ "fallback_to_long_code": { "type": "boolean", "nullable": true, - "description": "Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance." + "description": "[OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures." }, "area_code_geomatch": { "type": "boolean", "nullable": true, - "description": "Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance." + "description": "Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance." }, "synchronous_validation": { "type": "boolean", @@ -795,7 +869,7 @@ "usecase": { "type": "string", "nullable": true, - "description": "A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]" + "description": "A string that describes the scenario in which the Messaging Service will be used. Possible values are `notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`." }, "us_app_to_person_registered": { "type": "boolean", @@ -882,6 +956,246 @@ } } }, + "messaging.v1.tollfree_verification": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HH[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string to identify Tollfree Verification." + }, + "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 Tollfree Verification resource." + }, + "customer_profile_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Customer's Profile Bundle BundleSid." + }, + "trust_product_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Tollfree TrustProduct Bundle BundleSid." + }, + "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." + }, + "regulated_item_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Regulated Item." + }, + "business_name": { + "type": "string", + "nullable": true, + "description": "The name of the business or organization using the Tollfree number." + }, + "business_street_address": { + "type": "string", + "nullable": true, + "description": "The address of the business or organization using the Tollfree number." + }, + "business_street_address2": { + "type": "string", + "nullable": true, + "description": "The address of the business or organization using the Tollfree number." + }, + "business_city": { + "type": "string", + "nullable": true, + "description": "The city of the business or organization using the Tollfree number." + }, + "business_state_province_region": { + "type": "string", + "nullable": true, + "description": "The state/province/region of the business or organization using the Tollfree number." + }, + "business_postal_code": { + "type": "string", + "nullable": true, + "description": "The postal code of the business or organization using the Tollfree number." + }, + "business_country": { + "type": "string", + "nullable": true, + "description": "The country of the business or organization using the Tollfree number." + }, + "business_website": { + "type": "string", + "nullable": true, + "description": "The website of the business or organization using the Tollfree number." + }, + "business_contact_first_name": { + "type": "string", + "nullable": true, + "description": "The first name of the contact for the business or organization using the Tollfree number." + }, + "business_contact_last_name": { + "type": "string", + "nullable": true, + "description": "The last name of the contact for the business or organization using the Tollfree number." + }, + "business_contact_email": { + "type": "string", + "nullable": true, + "description": "The email address of the contact for the business or organization using the Tollfree number." + }, + "business_contact_phone": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "The E.164 formatted phone number of the contact for the business or organization using the Tollfree number." + }, + "notification_email": { + "type": "string", + "nullable": true, + "description": "The email address to receive the notification about the verification result. ." + }, + "use_case_categories": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "The category of the use case for the Tollfree Number. List as many are applicable.." + }, + "use_case_summary": { + "type": "string", + "nullable": true, + "description": "Use this to further explain how messaging is used by the business or organization." + }, + "production_message_sample": { + "type": "string", + "nullable": true, + "description": "An example of message content, i.e. a sample message." + }, + "opt_in_image_urls": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL." + }, + "opt_in_type": { + "type": "string", + "$ref": "#/components/schemas/tollfree_verification_enum_opt_in_type", + "nullable": true, + "description": "Describe how a user opts-in to text messages." + }, + "message_volume": { + "type": "string", + "nullable": true, + "description": "Estimate monthly volume of messages from the Tollfree Number." + }, + "additional_information": { + "type": "string", + "nullable": true, + "description": "Additional information to be provided for verification." + }, + "tollfree_phone_number_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Phone Number associated with the Tollfree Verification." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/tollfree_verification_enum_status", + "nullable": true, + "description": "The compliance status of the Tollfree Verification record." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Tollfree Verification resource." + }, + "rejection_reason": { + "type": "string", + "nullable": true, + "description": "The rejection reason given when a Tollfree Verification has been rejected." + }, + "error_code": { + "type": "integer", + "nullable": true, + "description": "The error code given when a Tollfree Verification has been rejected." + }, + "edit_expiration": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time when the ability to edit a rejected verification expires." + }, + "edit_allowed": { + "type": "boolean", + "nullable": true, + "description": "If a rejected verification is allowed to be edited/resubmitted. Some rejection reasons allow editing and some do not." + }, + "rejection_reasons": { + "type": "array", + "items": {}, + "nullable": true, + "description": "A list of rejection reasons and codes describing why a Tollfree Verification has been rejected." + }, + "resource_links": { + "nullable": true, + "description": "The URLs of the documents associated with the Tollfree Verification resource." + }, + "external_reference_id": { + "type": "string", + "nullable": true, + "description": "An optional external reference ID supplied by customer and echoed back on status retrieval." + } + } + }, + "tollfree_verification_enum_status": { + "type": "string", + "enum": [ + "PENDING_REVIEW", + "IN_REVIEW", + "TWILIO_APPROVED", + "TWILIO_REJECTED" + ] + }, + "tollfree_verification_enum_opt_in_type": { + "type": "string", + "enum": [ + "VERBAL", + "WEB_FORM", + "PAPER_FORM", + "VIA_TEXT", + "MOBILE_QR_CODE" + ] + }, "messaging.v1.service.us_app_to_person": { "type": "object", "properties": { @@ -915,7 +1229,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) that the resource is associated with." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with." }, "description": { "type": "string", @@ -928,7 +1242,7 @@ "type": "string" }, "nullable": true, - "description": "Message samples, at least 1 and up to 5 sample messages (at least 2 for starter/sole proprietor), >=20 chars, <=1024 chars each." + "description": "An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars." }, "us_app_to_person_usecase": { "type": "string", @@ -945,6 +1259,21 @@ "nullable": true, "description": "Indicates that this SMS campaign will send messages that contain phone numbers." }, + "subscriber_opt_in": { + "type": "boolean", + "nullable": true, + "description": "A boolean that specifies whether campaign has Subscriber Optin or not." + }, + "age_gated": { + "type": "boolean", + "nullable": true, + "description": "A boolean that specifies whether campaign is age gated or not." + }, + "direct_lending": { + "type": "boolean", + "nullable": true, + "description": "A boolean that specifies whether campaign allows direct lending or not." + }, "campaign_status": { "type": "string", "nullable": true, @@ -1060,12 +1389,37 @@ "description": "Human readable use case details (usecase, description and purpose) of Messaging Service Use Cases." } } - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" + }, + "whatsapp_sender_enum_status": { + "type": "string", + "enum": [ + "Configuring", + "PendingVerification", + "Configured", + "ConfigurationError", + "VerificationError" + ] + }, + "whatsapp_template_enum_category": { + "type": "string", + "enum": [ + "ACCOUNT_UPDATE", + "ALERT_UPDATE", + "AUTO_REPLY", + "APPOINTMENT_UPDATE", + "ISSUE_RESOLUTION", + "PAYMENT_UPDATE", + "PERSONAL_FINANCE_UPDATE", + "RESERVATION_UPDATE", + "SHIPPING_UPDATE", + "TICKET_UPDATE", + "TRANSPORTATION_UPDATE", + "MARKETING", + "OTP", + "TRANSACTIONAL", + "AUTHENTICATION", + "UTILITY" + ] } } }, @@ -1082,7 +1436,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1098,11 +1452,14 @@ "sid", "alpha_sender" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "MessagingV1AlphaSender" + ], "parameters": [ { "name": "ServiceSid", @@ -1123,6 +1480,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.alpha_sender" + }, + "examples": { + "create": { + "value": { + "sid": "AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "alpha_sender": "Twilio", + "capabilities": [ + "SMS" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1135,9 +1508,6 @@ } ], "operationId": "CreateAlphaSender", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1153,6 +1523,13 @@ "required": [ "AlphaSender" ] + }, + "examples": { + "create": { + "value": { + "AlphaSender": "Twilio" + } + } } } } @@ -1160,6 +1537,9 @@ }, "get": { "description": "", + "tags": [ + "MessagingV1AlphaSender" + ], "parameters": [ { "name": "ServiceSid", @@ -1216,16 +1596,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1234,18 +1616,45 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 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" + } + ] } } } @@ -1259,10 +1668,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAlphaSender", - "x-maturity": [ - "Beta" - ] + "operationId": "ListAlphaSender" } }, "/v1/Services/{ServiceSid}/AlphaSenders/{Sid}": { @@ -1277,11 +1683,14 @@ "sid", "alpha_sender" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "MessagingV1AlphaSender" + ], "parameters": [ { "name": "ServiceSid", @@ -1311,6 +1720,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.alpha_sender" + }, + "examples": { + "fetch": { + "value": { + "sid": "AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "alpha_sender": "Twilio", + "capabilities": [ + "SMS" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1322,13 +1747,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAlphaSender", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAlphaSender" }, "delete": { "description": "", + "tags": [ + "MessagingV1AlphaSender" + ], "parameters": [ { "name": "ServiceSid", @@ -1362,10 +1787,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAlphaSender", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteAlphaSender" } }, "/v1/a2p/BrandRegistrations/{BrandRegistrationSid}/SmsOtp": { @@ -1380,12 +1802,15 @@ "account_sid", "brand_registration_sid" ], - "pathType": "list", "parent": "/a2p/BrandRegistrations/{Sid}", - "mountName": "brand_registration_otps" + "mountName": "brand_registration_otps", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "MessagingV1BrandRegistrationOtp" + ], "parameters": [ { "name": "BrandRegistrationSid", @@ -1406,6 +1831,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.brand_registrations.brand_registration_otp" + }, + "examples": { + "create": { + "value": { + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "brand_registration_sid": "BN0044409f7e067e279523808d267e2d85" + } + } } } }, @@ -1417,10 +1850,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateBrandRegistrationOtp", - "x-maturity": [ - "Beta" - ] + "operationId": "CreateBrandRegistrationOtp" } }, "/v1/a2p/BrandRegistrations/{Sid}": { @@ -1435,14 +1865,27 @@ "sid", "date_created" ], - "pathType": "instance", "dependentProperties": { - "brand_vetting": "{brand_sid: sid}", - "brand_registration_otp": "{brand_registration_sid: sid}" - } + "brand_vettings": { + "mapping": { + "brand_sid": "sid" + }, + "resource_url": "/v1/a2p/BrandRegistrations/{brand_sid}/Vettings" + }, + "brand_registration_otps": { + "mapping": { + "brand_registration_sid": "sid" + }, + "resource_url": "/v1/a2p/BrandRegistrations/{brand_registration_sid}/SmsOtp" + } + }, + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "MessagingV1BrandRegistration" + ], "parameters": [ { "name": "Sid", @@ -1463,6 +1906,151 @@ "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" + } + } + } } } }, @@ -1474,13 +2062,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBrandRegistrations", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBrandRegistrations" }, "post": { "description": "", + "tags": [ + "MessagingV1BrandRegistration" + ], "parameters": [ { "name": "Sid", @@ -1501,6 +2089,67 @@ "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" + } + } + } } } }, @@ -1512,10 +2161,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateBrandRegistrations", - "x-maturity": [ - "Beta" - ] + "operationId": "UpdateBrandRegistrations" } }, "/v1/a2p/BrandRegistrations": { @@ -1530,14 +2176,27 @@ "sid", "date_created" ], - "pathType": "list", "dependentProperties": { - "brand_vetting": "{brand_sid: sid}", - "brand_registration_otp": "{brand_registration_sid: sid}" - } + "brand_vettings": { + "mapping": { + "brand_sid": "sid" + }, + "resource_url": "/v1/a2p/BrandRegistrations/{brand_sid}/Vettings" + }, + "brand_registration_otps": { + "mapping": { + "brand_registration_sid": "sid" + }, + "resource_url": "/v1/a2p/BrandRegistrations/{brand_registration_sid}/SmsOtp" + } + }, + "pathType": "list" }, "get": { "description": "", + "tags": [ + "MessagingV1BrandRegistration" + ], "parameters": [ { "name": "PageSize", @@ -1582,16 +2241,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1600,18 +2261,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" + } + } + }, + "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" + } + } + ] } } } @@ -1625,19 +2383,80 @@ "accountSid_authToken": [] } ], - "operationId": "ListBrandRegistrations", - "x-maturity": [ - "Beta" - ] + "operationId": "ListBrandRegistrations" }, "post": { "description": "", + "tags": [ + "MessagingV1BrandRegistration" + ], "responses": { "201": { "content": { "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" + } + } + } } } }, @@ -1650,9 +2469,6 @@ } ], "operationId": "CreateBrandRegistrations", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1691,6 +2507,26 @@ "CustomerProfileBundleSid", "A2PProfileBundleSid" ] + }, + "examples": { + "create": { + "value": { + "CustomerProfileBundleSid": "BU0000009f7e067e279523808d267e2d90", + "A2PProfileBundleSid": "BU1111109f7e067e279523808d267e2d85", + "BrandType": "STANDARD", + "SkipAutomaticSecVet": false, + "Mock": false + } + }, + "createSoleProprietorBrand": { + "value": { + "CustomerProfileBundleSid": "BU0000009f7e067e279523808d267e2d90", + "A2PProfileBundleSid": "BU1111109f7e067e279523808d267e2d85", + "BrandType": "STANDARD", + "SkipAutomaticSecVet": false, + "Mock": false + } + } } } } @@ -1714,12 +2550,15 @@ "vetting_status", "vetting_class" ], - "pathType": "list", "parent": "/a2p/BrandRegistrations/{Sid}", - "mountName": "brand_vettings" + "mountName": "brand_vettings", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "MessagingV1BrandVetting" + ], "parameters": [ { "name": "BrandSid", @@ -1740,6 +2579,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.brand_registrations.brand_vetting" + }, + "examples": { + "create": { + "value": { + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "brand_sid": "BN0044409f7e067e279523808d267e2d85", + "brand_vetting_sid": "VT12445353", + "vetting_provider": "campaign-verify", + "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY", + "vetting_class": "POLITICAL", + "vetting_status": "IN_PROGRESS", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:35Z", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353" + } + } } } }, @@ -1752,9 +2607,6 @@ } ], "operationId": "CreateBrandVetting", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1775,6 +2627,14 @@ "required": [ "VettingProvider" ] + }, + "examples": { + "create": { + "value": { + "VettingProvider": "campaign-verify", + "VettingId": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY" + } + } } } } @@ -1782,6 +2642,9 @@ }, "get": { "description": "", + "tags": [ + "MessagingV1BrandVetting" + ], "parameters": [ { "name": "BrandSid", @@ -1847,16 +2710,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1865,18 +2730,45 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "data", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0" + }, + "data": [ + { + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "brand_sid": "BN0044409f7e067e279523808d267e2d85", + "brand_vetting_sid": "VT12445353", + "vetting_provider": "campaign-verify", + "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY", + "vetting_class": "POLITICAL", + "vetting_status": "IN_PROGRESS", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:35Z", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353" + } + ] } } } @@ -1890,10 +2782,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBrandVetting", - "x-maturity": [ - "Beta" - ] + "operationId": "ListBrandVetting" } }, "/v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid}": { @@ -1913,12 +2802,15 @@ "vetting_status", "vetting_class" ], - "pathType": "instance", "parent": "/a2p/BrandRegistrations/{Sid}", - "mountName": "brand_vettings" + "mountName": "brand_vettings", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "MessagingV1BrandVetting" + ], "parameters": [ { "name": "BrandSid", @@ -1951,6 +2843,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.brand_registrations.brand_vetting" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "brand_sid": "BN0044409f7e067e279523808d267e2d85", + "brand_vetting_sid": "VT12445353", + "vetting_provider": "campaign-verify", + "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY", + "vetting_class": "POLITICAL", + "vetting_status": "IN_PROGRESS", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:35Z", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353" + } + } } } }, @@ -1962,49 +2870,150 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBrandVetting", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBrandVetting" } }, - "/v1/Deactivations": { + "/v1/Services/{MessagingServiceSid}/ChannelSenders": { "servers": [ { "url": "https://messaging.twilio.com" } ], - "description": "A Deactivation resource to retrieve a list of United States phone numbers that have been deactivated by mobile carriers on a specific date.", + "description": "A Messaging Service resource to read, fetch all Channel Senders associated with a Messaging Service.", "x-twilio": { "defaultOutputProperties": [ - "redirect_to" + "sid", + "sender", + "sender_type" ], - "pathType": "instance", - "className": "deactivations" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { - "description": "Fetch a list of all United States numbers that have been deactivated on a specific date.", + "description": "", + "tags": [ + "MessagingV1ChannelSender" + ], "parameters": [ { - "name": "Date", - "in": "query", - "description": "The request will return a list of all United States Phone Numbers that were deactivated on the day specified by this parameter. This date should be specified in YYYY-MM-DD format.", + "name": "MessagingServiceSid", + "in": "path", + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from.", "schema": { "type": "string", - "format": "date" + "minLength": 34, + "maxLength": 34, + "pattern": "^MG[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": { - "307": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/messaging.v1.deactivation" + "type": "object", + "title": "ListChannelSenderResponse", + "properties": { + "senders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messaging.v1.service.channel_sender" + } + }, + "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": { + "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" + } + ] + } + } } } }, - "description": "Temporary Redirect" + "description": "OK" } }, "security": [ @@ -2012,45 +3021,49 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeactivation", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannelSender" } }, - "/v1/LinkShortening/Domains/{DomainSid}/Certificate": { + "/v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}": { "servers": [ { "url": "https://messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "A Messaging Service resource to read, fetch all Channel Senders associated with a Messaging Service.", "x-twilio": { "defaultOutputProperties": [ - "certificate_sid", - "domain_name", - "domain_sid", - "date_expires", - "date_created", - "date_updated", - "url" + "sid", + "sender", + "sender_type" ], - "pathType": "instance", - "mountName": "domain_certs", - "className": "domain_certs" + "parent": "/Services/{Sid}", + "pathType": "instance" }, - "post": { + "get": { "description": "", + "tags": [ + "MessagingV1ChannelSender" + ], "parameters": [ { - "name": "DomainSid", + "name": "MessagingServiceSid", "in": "path", - "description": "Unique string used to identify the domain that this certificate should be associated with.", + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DN[0-9a-fA-F]{32}$" + "pattern": "^MG[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The SID of the ChannelSender resource to fetch.", + "schema": { + "type": "string" }, "required": true } @@ -2060,17 +3073,183 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/messaging.v1.domain_cert_v4" + "$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" + } + } } } }, "description": "OK" - }, - "201": { - "content": { - "application/json": { + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchChannelSender" + } + }, + "/v1/Deactivations": { + "servers": [ + { + "url": "https://messaging.twilio.com" + } + ], + "description": "A Deactivation resource to retrieve a list of United States phone numbers that have been deactivated by mobile carriers on a specific date.", + "x-twilio": { + "defaultOutputProperties": [ + "redirect_to" + ], + "className": "deactivations", + "pathType": "instance" + }, + "get": { + "description": "Fetch a list of all United States numbers that have been deactivated on a specific date.", + "tags": [ + "MessagingV1Deactivations" + ], + "parameters": [ + { + "name": "Date", + "in": "query", + "description": "The request will return a list of all United States Phone Numbers that were deactivated on the day specified by this parameter. This date should be specified in YYYY-MM-DD format.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "307": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.deactivation" + }, + "examples": { + "fetch": { + "value": { + "redirect_to": "https://com-twilio-dev-messaging-deactivations.s3.amazonaws.com" + } + } + } + } + }, + "description": "Temporary Redirect" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchDeactivation" + } + }, + "/v1/LinkShortening/Domains/{DomainSid}/Certificate": { + "servers": [ + { + "url": "https://messaging.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "certificate_sid", + "domain_name", + "domain_sid", + "date_expires", + "date_created", + "date_updated", + "url" + ], + "mountName": "domain_certs", + "className": "domain_certs", + "pathType": "instance" + }, + "post": { + "description": "", + "tags": [ + "MessagingV1DomainCerts" + ], + "parameters": [ + { + "name": "DomainSid", + "in": "path", + "description": "Unique string used to identify the domain that this certificate should be associated with.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DN[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_cert_v4" + }, + "examples": { + "update": { + "value": { + "certificate_sid": "CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "https://api.example.com", + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_expires": "2021-02-06T18:02:04Z", + "date_created": "2021-02-06T18:02:04Z", + "date_updated": "2021-02-06T18:02:04Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate", + "cert_in_validation": { + "date_expires": "2021-02-06T18:02:04Z", + "status": "pending" + } + } + } + } + } + }, + "description": "OK" + }, + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.domain_cert_v4" + }, + "examples": { + "create": { + "value": { + "certificate_sid": "CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "https://api.example.com", + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_expires": null, + "date_created": "2021-02-06T18:02:04Z", + "date_updated": "2021-02-06T18:02:04Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate", + "cert_in_validation": { + "date_expires": "2021-02-06T18:02:04Z", + "status": "pending" + } + } + } } } }, @@ -2083,9 +3262,6 @@ } ], "operationId": "UpdateDomainCertV4", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2101,6 +3277,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-----" + } + } } } } @@ -2108,6 +3296,9 @@ }, "get": { "description": "", + "tags": [ + "MessagingV1DomainCerts" + ], "parameters": [ { "name": "DomainSid", @@ -2128,6 +3319,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_cert_v4" + }, + "examples": { + "fetch": { + "value": { + "certificate_sid": "CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "https://api.example.com", + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_expires": "2021-02-06T18:02:04Z", + "date_created": "2021-02-06T18:02:04Z", + "date_updated": "2021-02-06T18:02:04Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate", + "cert_in_validation": { + "date_expires": "2021-02-06T18:02:04Z", + "status": "pending" + } + } + } } } }, @@ -2139,13 +3347,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDomainCertV4", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDomainCertV4" }, "delete": { "description": "", + "tags": [ + "MessagingV1DomainCerts" + ], "parameters": [ { "name": "DomainSid", @@ -2170,10 +3378,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDomainCertV4", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteDomainCertV4" } }, "/v1/LinkShortening/Domains/{DomainSid}/Config": { @@ -2182,7 +3387,7 @@ "url": "https://messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "config_sid", @@ -2194,11 +3399,14 @@ "url", "disable_https" ], - "pathType": "instance", - "mountName": "domain_config" + "mountName": "domain_config", + "pathType": "instance" }, "post": { "description": "", + "tags": [ + "MessagingV1DomainConfig" + ], "parameters": [ { "name": "DomainSid", @@ -2219,6 +3427,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_config" + }, + "examples": { + "update": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "config_sid": "ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fallback_url": "https://www.example.com", + "callback_url": "https://www.example.com", + "continue_on_failure": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config", + "disable_https": false + } + } } } }, @@ -2229,6 +3452,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_config" + }, + "examples": { + "create": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "config_sid": "ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fallback_url": "https://www.example.com", + "callback_url": "https://www.example.com", + "continue_on_failure": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config", + "disable_https": false + } + } } } }, @@ -2241,9 +3479,6 @@ } ], "operationId": "UpdateDomainConfig", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2270,6 +3505,24 @@ "description": "Customer's choice to send links with/without \"https://\" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified." } } + }, + "examples": { + "update": { + "value": { + "FallbackUrl": "https://www.example.com", + "CallbackUrl": "https://www.example.com", + "ContinueOnFailure": true, + "DisableHttps": false + } + }, + "create": { + "value": { + "FallbackUrl": "https://www.example.com", + "CallbackUrl": "https://www.example.com", + "DisableHttps": false, + "ContinueOnFailure": true + } + } } } } @@ -2277,6 +3530,9 @@ }, "get": { "description": "", + "tags": [ + "MessagingV1DomainConfig" + ], "parameters": [ { "name": "DomainSid", @@ -2297,6 +3553,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_config" + }, + "examples": { + "fetch": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "config_sid": "ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fallback_url": "https://www.example.com", + "callback_url": "https://www.example.com", + "continue_on_failure": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config", + "disable_https": false + } + } } } }, @@ -2308,10 +3579,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDomainConfig", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDomainConfig" } }, "/v1/LinkShortening/MessagingService/{MessagingServiceSid}/DomainConfig": { @@ -2320,7 +3588,7 @@ "url": "https://messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "domain_sid", @@ -2333,11 +3601,14 @@ "url", "messaging_service_sid" ], - "pathType": "instance", - "mountName": "domain_config_messaging_service" + "mountName": "domain_config_messaging_service", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "MessagingV1DomainConfigMessagingService" + ], "parameters": [ { "name": "MessagingServiceSid", @@ -2358,6 +3629,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_config_messaging_service" + }, + "examples": { + "fetch": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "config_sid": "ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fallback_url": "https://www.example.com", + "callback_url": "https://www.example.com", + "continue_on_failure": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/MessagingService/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DomainConfig", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2369,10 +3655,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDomainConfigMessagingService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDomainConfigMessagingService" } }, "/v1/Services/PreregisteredUsa2p": { @@ -2387,17 +3670,31 @@ "campaign_id", "messaging_service_sid" ], - "pathType": "list", - "mountName": "external_campaign" + "mountName": "external_campaign", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "MessagingV1ExternalCampaign" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.external_campaign" + }, + "examples": { + "create": { + "value": { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "campaign_id": "CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-03-21T21:31:00Z" + } + } } } }, @@ -2410,9 +3707,6 @@ } ], "operationId": "CreateExternalCampaign", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2429,13 +3723,21 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) that the resource is associated with." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with." } }, "required": [ "CampaignId", "MessagingServiceSid" ] + }, + "examples": { + "create": { + "value": { + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CampaignId": "CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2448,18 +3750,21 @@ "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": "", + "tags": [ + "MessagingV1LinkshorteningMessagingService" + ], "parameters": [ { "name": "DomainSid", @@ -2492,6 +3797,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.linkshortening_messaging_service" + }, + "examples": { + "create": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingServices/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2503,13 +3817,13 @@ "accountSid_authToken": [] } ], - "operationId": "CreateLinkshorteningMessagingService", - "x-maturity": [ - "Beta" - ] + "operationId": "CreateLinkshorteningMessagingService" }, "delete": { "description": "", + "tags": [ + "MessagingV1LinkshorteningMessagingService" + ], "parameters": [ { "name": "DomainSid", @@ -2546,10 +3860,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteLinkshorteningMessagingService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteLinkshorteningMessagingService" } }, "/v1/LinkShortening/MessagingServices/{MessagingServiceSid}/Domain": { @@ -2558,18 +3869,21 @@ "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": "", + "tags": [ + "MessagingV1LinkshorteningMessagingServiceDomainAssociation" + ], "parameters": [ { "name": "MessagingServiceSid", @@ -2590,6 +3904,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.linkshortening_messaging_service_domain_association" + }, + "examples": { + "fetch": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://messaging.twilio.com/v1/LinkShortening/MessagingServices/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Domain" + } + } } } }, @@ -2601,10 +3924,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchLinkshorteningMessagingServiceDomainAssociation", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchLinkshorteningMessagingServiceDomainAssociation" } }, "/v1/Services/{ServiceSid}/PhoneNumbers": { @@ -2620,11 +3940,14 @@ "phone_number", "country_code" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "MessagingV1PhoneNumber" + ], "parameters": [ { "name": "ServiceSid", @@ -2645,6 +3968,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.phone_number" + }, + "examples": { + "create": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "phone_number": "+987654321", + "country_code": "US", + "capabilities": [], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithCapabilities": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "phone_number": "+987654321", + "country_code": "US", + "capabilities": [ + "MMS", + "SMS", + "Voice" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2657,9 +4012,6 @@ } ], "operationId": "CreatePhoneNumber", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2678,6 +4030,18 @@ "required": [ "PhoneNumberSid" ] + }, + "examples": { + "create": { + "value": { + "PhoneNumberSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithCapabilities": { + "value": { + "PhoneNumberSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2685,6 +4049,9 @@ }, "get": { "description": "", + "tags": [ + "MessagingV1PhoneNumber" + ], "parameters": [ { "name": "ServiceSid", @@ -2741,16 +4108,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2759,18 +4128,44 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 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" + } + ] } } } @@ -2784,10 +4179,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "ListPhoneNumber" } }, "/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}": { @@ -2803,11 +4195,14 @@ "phone_number", "country_code" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "", + "tags": [ + "MessagingV1PhoneNumber" + ], "parameters": [ { "name": "ServiceSid", @@ -2841,13 +4236,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "DeletePhoneNumber" }, "get": { "description": "", + "tags": [ + "MessagingV1PhoneNumber" + ], "parameters": [ { "name": "ServiceSid", @@ -2877,6 +4272,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.phone_number" + }, + "examples": { + "fetch": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "phone_number": "12345", + "country_code": "US", + "capabilities": [], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2888,10 +4298,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPhoneNumber" } }, "/v1/Services": { @@ -2907,24 +4314,100 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "phone_number": "{service_sid: sid}", - "short_code": "{service_sid: sid}", - "alpha_sender": "{service_sid: sid}", - "messaging/v1/message": "{messaging_service_sid: sid}", - "us_app_to_person": "{messaging_service_sid: sid}", - "us_app_to_person_usecase": "{messaging_service_sid: sid}" - } + "phone_numbers": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/PhoneNumbers" + }, + "short_codes": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/ShortCodes" + }, + "alpha_senders": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/AlphaSenders" + }, + "messages": { + "mapping": { + "messaging_service_sid": "sid" + }, + "resource_url": "/v1/Services/{messaging_service_sid}/Messages" + }, + "us_app_to_person": { + "mapping": { + "messaging_service_sid": "sid" + }, + "resource_url": "/v1/Services/{messaging_service_sid}/Compliance/Usa2p" + }, + "us_app_to_person_usecases": { + "mapping": { + "messaging_service_sid": "sid" + }, + "resource_url": "/v1/Services/{messaging_service_sid}/Compliance/Usa2p/Usecases" + }, + "channel_senders": { + "mapping": { + "messaging_service_sid": "sid" + }, + "resource_url": "/v1/Services/{messaging_service_sid}/ChannelSenders" + } + }, + "pathType": "list" }, "post": { "description": "", + "tags": [ + "MessagingV1Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "friendly_name": "My Service!", + "inbound_request_url": "https://www.example.com/", + "inbound_method": "POST", + "fallback_url": "https://www.example.com", + "fallback_method": "GET", + "status_callback": "https://www.example.com", + "sticky_sender": true, + "smart_encoding": false, + "mms_converter": true, + "fallback_to_long_code": true, + "scan_message_content": "inherit", + "area_code_geomatch": true, + "validity_period": 600, + "synchronous_validation": true, + "usecase": "marketing", + "us_app_to_person_registered": false, + "use_inbound_webhook_on_number": true, + "links": { + "phone_numbers": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes", + "alpha_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders", + "messages": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "us_app_to_person": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p", + "us_app_to_person_usecases": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases", + "channel_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders" + }, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2937,9 +4420,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2994,15 +4474,15 @@ }, "StickySender": { "type": "boolean", - "description": "Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance." + "description": "Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance." }, "MmsConverter": { "type": "boolean", - "description": "Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance." + "description": "Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance." }, "SmartEncoding": { "type": "boolean", - "description": "Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance." + "description": "Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance." }, "ScanMessageContent": { "type": "string", @@ -3011,11 +4491,11 @@ }, "FallbackToLongCode": { "type": "boolean", - "description": "Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance." + "description": "[OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures." }, "AreaCodeGeomatch": { "type": "boolean", - "description": "Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance." + "description": "Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance." }, "ValidityPeriod": { "type": "integer", @@ -3027,7 +4507,7 @@ }, "Usecase": { "type": "string", - "description": "A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]." + "description": "A string that describes the scenario in which the Messaging Service will be used. Possible values are `notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`." }, "UseInboundWebhookOnNumber": { "type": "boolean", @@ -3037,6 +4517,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 + } + } } } } @@ -3044,6 +4546,9 @@ }, "get": { "description": "", + "tags": [ + "MessagingV1Service" + ], "parameters": [ { "name": "PageSize", @@ -3088,16 +4593,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3106,18 +4613,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 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, + "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" + } + ] } } } @@ -3131,10 +4686,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" } }, "/v1/Services/{Sid}": { @@ -3150,21 +4702,60 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "phone_number": "{service_sid: sid}", - "short_code": "{service_sid: sid}", - "alpha_sender": "{service_sid: sid}", - "messaging/v1/message": "{messaging_service_sid: sid}", - "us_app_to_person": "{messaging_service_sid: sid}", - "us_app_to_person_usecase": "{messaging_service_sid: sid}" - } - }, - "post": { - "description": "", - "parameters": [ - { - "name": "Sid", + "phone_numbers": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/PhoneNumbers" + }, + "short_codes": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/ShortCodes" + }, + "alpha_senders": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/AlphaSenders" + }, + "messages": { + "mapping": { + "messaging_service_sid": "sid" + }, + "resource_url": "/v1/Services/{messaging_service_sid}/Messages" + }, + "us_app_to_person": { + "mapping": { + "messaging_service_sid": "sid" + }, + "resource_url": "/v1/Services/{messaging_service_sid}/Compliance/Usa2p" + }, + "us_app_to_person_usecases": { + "mapping": { + "messaging_service_sid": "sid" + }, + "resource_url": "/v1/Services/{messaging_service_sid}/Compliance/Usa2p/Usecases" + }, + "channel_senders": { + "mapping": { + "messaging_service_sid": "sid" + }, + "resource_url": "/v1/Services/{messaging_service_sid}/ChannelSenders" + } + }, + "pathType": "instance" + }, + "post": { + "description": "", + "tags": [ + "MessagingV1Service" + ], + "parameters": [ + { + "name": "Sid", "in": "path", "description": "The SID of the Service resource to update.", "schema": { @@ -3182,6 +4773,43 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My Service!", + "sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "sticky_sender": false, + "mms_converter": true, + "smart_encoding": false, + "fallback_to_long_code": true, + "scan_message_content": "inherit", + "synchronous_validation": true, + "area_code_geomatch": true, + "validity_period": 600, + "inbound_request_url": "https://www.example.com", + "inbound_method": "POST", + "fallback_url": null, + "fallback_method": "POST", + "status_callback": "https://www.example.com", + "usecase": "marketing", + "us_app_to_person_registered": false, + "use_inbound_webhook_on_number": true, + "links": { + "phone_numbers": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes", + "alpha_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders", + "messages": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "us_app_to_person": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p", + "us_app_to_person_usecases": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases", + "channel_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders" + }, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3194,9 +4822,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3251,15 +4876,15 @@ }, "StickySender": { "type": "boolean", - "description": "Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance." + "description": "Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance." }, "MmsConverter": { "type": "boolean", - "description": "Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance." + "description": "Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance." }, "SmartEncoding": { "type": "boolean", - "description": "Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance." + "description": "Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance." }, "ScanMessageContent": { "type": "string", @@ -3268,11 +4893,11 @@ }, "FallbackToLongCode": { "type": "boolean", - "description": "Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance." + "description": "[OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures." }, "AreaCodeGeomatch": { "type": "boolean", - "description": "Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance." + "description": "Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance." }, "ValidityPeriod": { "type": "integer", @@ -3284,13 +4909,20 @@ }, "Usecase": { "type": "string", - "description": "A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]" + "description": "A string that describes the scenario in which the Messaging Service will be used. Possible values are `notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`." }, "UseInboundWebhookOnNumber": { "type": "boolean", "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 + } + } } } } @@ -3298,6 +4930,9 @@ }, "get": { "description": "", + "tags": [ + "MessagingV1Service" + ], "parameters": [ { "name": "Sid", @@ -3318,6 +4953,43 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "friendly_name": "My Service!", + "inbound_request_url": "https://www.example.com/", + "inbound_method": "POST", + "fallback_url": null, + "fallback_method": "POST", + "status_callback": "https://www.example.com", + "sticky_sender": true, + "mms_converter": true, + "smart_encoding": false, + "fallback_to_long_code": true, + "area_code_geomatch": true, + "validity_period": 600, + "scan_message_content": "inherit", + "synchronous_validation": true, + "usecase": "marketing", + "us_app_to_person_registered": false, + "use_inbound_webhook_on_number": true, + "links": { + "phone_numbers": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes", + "alpha_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders", + "messages": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "us_app_to_person": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p", + "us_app_to_person_usecases": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases", + "channel_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders" + }, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3329,13 +5001,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "delete": { "description": "", + "tags": [ + "MessagingV1Service" + ], "parameters": [ { "name": "Sid", @@ -3360,10 +5032,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" } }, "/v1/Services/{ServiceSid}/ShortCodes": { @@ -3379,11 +5048,14 @@ "short_code", "country_code" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "MessagingV1ShortCode" + ], "parameters": [ { "name": "ServiceSid", @@ -3404,6 +5076,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.short_code" + }, + "examples": { + "create": { + "value": { + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "short_code": "12345", + "country_code": "US", + "capabilities": [ + "SMS" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3416,9 +5105,6 @@ } ], "operationId": "CreateShortCode", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3437,6 +5123,13 @@ "required": [ "ShortCodeSid" ] + }, + "examples": { + "create": { + "value": { + "ShortCodeSid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3444,6 +5137,9 @@ }, "get": { "description": "", + "tags": [ + "MessagingV1ShortCode" + ], "parameters": [ { "name": "ServiceSid", @@ -3500,16 +5196,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3518,18 +5216,46 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 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" + } + ] } } } @@ -3543,10 +5269,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "ListShortCode" } }, "/v1/Services/{ServiceSid}/ShortCodes/{Sid}": { @@ -3562,11 +5285,14 @@ "short_code", "country_code" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "", + "tags": [ + "MessagingV1ShortCode" + ], "parameters": [ { "name": "ServiceSid", @@ -3600,13 +5326,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteShortCode" }, "get": { "description": "", + "tags": [ + "MessagingV1ShortCode" + ], "parameters": [ { "name": "ServiceSid", @@ -3636,6 +5362,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.short_code" + }, + "examples": { + "fetch": { + "value": { + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "short_code": "12345", + "country_code": "US", + "capabilities": [ + "SMS" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3647,55 +5390,106 @@ "accountSid_authToken": [] } ], - "operationId": "FetchShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchShortCode" } }, - "/v1/Services/{MessagingServiceSid}/Compliance/Usa2p": { + "/v1/Tollfree/Verifications/{Sid}": { "servers": [ { "url": "https://messaging.twilio.com" } ], - "description": "A service for (fetch/create/delete) A2P Campaign for a Messaging Service", + "description": "A Messaging resource to add and fetch Tollfree Verifications.", "x-twilio": { "defaultOutputProperties": [ - "brand_registration_sid", - "campaign_status", + "sid", "date_created" ], - "pathType": "list", - "parent": "/Services/{Sid}", - "mountName": "us_app_to_person" + "mountName": "tollfree_verifications", + "pathType": "instance" }, - "post": { + "get": { "description": "", + "tags": [ + "MessagingV1TollfreeVerification" + ], "parameters": [ { - "name": "MessagingServiceSid", + "name": "Sid", "in": "path", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to create the resources from.", + "description": "The unique string to identify Tollfree Verification.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^MG[0-9a-fA-F]{32}$" + "pattern": "^HH[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/messaging.v1.service.us_app_to_person" + "$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" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -3703,128 +5497,1196 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUsAppToPerson", - "x-maturity": [ - "Beta" + "operationId": "FetchTollfreeVerification" + }, + "post": { + "description": "", + "tags": [ + "MessagingV1TollfreeVerification" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The unique string to identify Tollfree Verification.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HH[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "202": { + "content": { + "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 + } + } + } + } + }, + "description": "Accepted" + } + }, + "security": [ + { + "accountSid_authToken": [] + } ], + "operationId": "UpdateTollfreeVerification", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateUsAppToPersonRequest", + "title": "UpdateTollfreeVerificationRequest", "properties": { - "BrandRegistrationSid": { + "BusinessName": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^BN[0-9a-fA-F]{32}$", - "description": "A2P Brand Registration SID" + "description": "The name of the business or organization using the Tollfree number." }, - "Description": { + "BusinessWebsite": { "type": "string", - "description": "A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters." + "description": "The website of the business or organization using the Tollfree number." }, - "MessageFlow": { + "NotificationEmail": { "type": "string", - "description": "Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum." + "description": "The email address to receive the notification about the verification result. ." }, - "MessageSamples": { + "UseCaseCategories": { "type": "array", "items": { "type": "string" }, - "description": "Message samples, at least 1 and up to 5 sample messages (at least 2 for sole proprietor), >=20 chars, <=1024 chars each." + "description": "The category of the use case for the Tollfree Number. List as many are applicable.." }, - "UsAppToPersonUsecase": { + "UseCaseSummary": { "type": "string", - "description": "A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..]" + "description": "Use this to further explain how messaging is used by the business or organization." }, - "HasEmbeddedLinks": { - "type": "boolean", - "description": "Indicates that this SMS campaign will send messages that contain links." + "ProductionMessageSample": { + "type": "string", + "description": "An example of message content, i.e. a sample message." }, - "HasEmbeddedPhone": { - "type": "boolean", - "description": "Indicates that this SMS campaign will send messages that contain phone numbers." + "OptInImageUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL." }, - "OptInMessage": { + "OptInType": { "type": "string", - "description": "If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum." + "$ref": "#/components/schemas/tollfree_verification_enum_opt_in_type", + "description": "Describe how a user opts-in to text messages." }, - "OptOutMessage": { + "MessageVolume": { "type": "string", - "description": "Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum." + "description": "Estimate monthly volume of messages from the Tollfree Number." }, - "HelpMessage": { + "BusinessStreetAddress": { "type": "string", - "description": "When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum." + "description": "The address of the business or organization using the Tollfree number." }, - "OptInKeywords": { - "type": "array", - "items": { - "type": "string" - }, - "description": "If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum." + "BusinessStreetAddress2": { + "type": "string", + "description": "The address of the business or organization using the Tollfree number." }, - "OptOutKeywords": { - "type": "array", - "items": { - "type": "string" - }, - "description": "End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum." + "BusinessCity": { + "type": "string", + "description": "The city of the business or organization using the Tollfree number." }, - "HelpKeywords": { - "type": "array", - "items": { - "type": "string" - }, - "description": "End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum." + "BusinessStateProvinceRegion": { + "type": "string", + "description": "The state/province/region of the business or organization using the Tollfree number." + }, + "BusinessPostalCode": { + "type": "string", + "description": "The postal code of the business or organization using the Tollfree number." + }, + "BusinessCountry": { + "type": "string", + "description": "The country of the business or organization using the Tollfree number." + }, + "AdditionalInformation": { + "type": "string", + "description": "Additional information to be provided for verification." + }, + "BusinessContactFirstName": { + "type": "string", + "description": "The first name of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactLastName": { + "type": "string", + "description": "The last name of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactEmail": { + "type": "string", + "description": "The email address of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactPhone": { + "type": "string", + "format": "phone-number", + "description": "The E.164 formatted phone number of the contact for the business or organization using the Tollfree number." + }, + "EditReason": { + "type": "string", + "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'." } - }, - "required": [ - "BrandRegistrationSid", - "Description", - "MessageFlow", - "MessageSamples", - "UsAppToPersonUsecase", - "HasEmbeddedLinks", - "HasEmbeddedPhone" - ] + } + }, + "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" + } + } } } } } }, - "get": { + "delete": { "description": "", + "tags": [ + "MessagingV1TollfreeVerification" + ], "parameters": [ { - "name": "MessagingServiceSid", + "name": "Sid", "in": "path", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to fetch the resource from.", + "description": "The unique string to identify Tollfree Verification.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^MG[0-9a-fA-F]{32}$" + "pattern": "^HH[0-9a-fA-F]{32}$" }, "required": true - }, + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ { - "name": "PageSize", + "accountSid_authToken": [] + } + ], + "operationId": "DeleteTollfreeVerification" + } + }, + "/v1/Tollfree/Verifications": { + "servers": [ + { + "url": "https://messaging.twilio.com" + } + ], + "description": "A Messaging resource to add and fetch Tollfree Verifications.", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "date_created" + ], + "mountName": "tollfree_verifications", + "pathType": "list" + }, + "get": { + "description": "", + "tags": [ + "MessagingV1TollfreeVerification" + ], + "parameters": [ + { + "name": "TollfreePhoneNumberSid", "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "description": "The SID of the Phone Number associated with the Tollfree Verification.", "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "read": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { - "name": "Page", + "name": "Status", "in": "query", - "description": "The page index. This value is simply for client state.", + "description": "The compliance status of the Tollfree Verification record.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/tollfree_verification_enum_status" + }, + "examples": { + "read": { + "value": "TWILIO_APPROVED" + } + } + }, + { + "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": "ListTollfreeVerificationResponse", + "properties": { + "verifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messaging.v1.tollfree_verification" + } + }, + "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": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://messaging.twilio.com/v1/Tollfree/Verifications?Status=TWILIO_APPROVED&TollfreePhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&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&TollfreePhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&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" + } + ] + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListTollfreeVerification" + }, + "post": { + "description": "", + "tags": [ + "MessagingV1TollfreeVerification" + ], + "responses": { + "201": { + "content": { + "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" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateTollfreeVerification", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateTollfreeVerificationRequest", + "properties": { + "BusinessName": { + "type": "string", + "description": "The name of the business or organization using the Tollfree number." + }, + "BusinessWebsite": { + "type": "string", + "description": "The website of the business or organization using the Tollfree number." + }, + "NotificationEmail": { + "type": "string", + "description": "The email address to receive the notification about the verification result. ." + }, + "UseCaseCategories": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The category of the use case for the Tollfree Number. List as many are applicable.." + }, + "UseCaseSummary": { + "type": "string", + "description": "Use this to further explain how messaging is used by the business or organization." + }, + "ProductionMessageSample": { + "type": "string", + "description": "An example of message content, i.e. a sample message." + }, + "OptInImageUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL." + }, + "OptInType": { + "type": "string", + "$ref": "#/components/schemas/tollfree_verification_enum_opt_in_type", + "description": "Describe how a user opts-in to text messages." + }, + "MessageVolume": { + "type": "string", + "description": "Estimate monthly volume of messages from the Tollfree Number." + }, + "TollfreePhoneNumberSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "description": "The SID of the Phone Number associated with the Tollfree Verification." + }, + "CustomerProfileSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$", + "description": "Customer's Profile Bundle BundleSid." + }, + "BusinessStreetAddress": { + "type": "string", + "description": "The address of the business or organization using the Tollfree number." + }, + "BusinessStreetAddress2": { + "type": "string", + "description": "The address of the business or organization using the Tollfree number." + }, + "BusinessCity": { + "type": "string", + "description": "The city of the business or organization using the Tollfree number." + }, + "BusinessStateProvinceRegion": { + "type": "string", + "description": "The state/province/region of the business or organization using the Tollfree number." + }, + "BusinessPostalCode": { + "type": "string", + "description": "The postal code of the business or organization using the Tollfree number." + }, + "BusinessCountry": { + "type": "string", + "description": "The country of the business or organization using the Tollfree number." + }, + "AdditionalInformation": { + "type": "string", + "description": "Additional information to be provided for verification." + }, + "BusinessContactFirstName": { + "type": "string", + "description": "The first name of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactLastName": { + "type": "string", + "description": "The last name of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactEmail": { + "type": "string", + "description": "The email address of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactPhone": { + "type": "string", + "format": "phone-number", + "description": "The E.164 formatted phone number of the contact for the business or organization using the Tollfree number." + }, + "ExternalReferenceId": { + "type": "string", + "description": "An optional external reference ID supplied by customer and echoed back on status retrieval." + } + }, + "required": [ + "BusinessName", + "BusinessWebsite", + "NotificationEmail", + "UseCaseCategories", + "UseCaseSummary", + "ProductionMessageSample", + "OptInImageUrls", + "OptInType", + "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" + } + } + } + } + } + } + } + }, + "/v1/Services/{MessagingServiceSid}/Compliance/Usa2p": { + "servers": [ + { + "url": "https://messaging.twilio.com" + } + ], + "description": "A service for (fetch/create/delete) A2P Campaign for a Messaging Service", + "x-twilio": { + "defaultOutputProperties": [ + "brand_registration_sid", + "campaign_status", + "date_created" + ], + "parent": "/Services/{Sid}", + "mountName": "us_app_to_person", + "pathType": "list" + }, + "post": { + "description": "", + "tags": [ + "MessagingV1UsAppToPerson" + ], + "parameters": [ + { + "name": "MessagingServiceSid", + "in": "path", + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to create the resources from.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.service.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": [] + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateUsAppToPerson", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateUsAppToPersonRequest", + "properties": { + "BrandRegistrationSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BN[0-9a-fA-F]{32}$", + "description": "A2P Brand Registration SID" + }, + "Description": { + "type": "string", + "description": "A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters." + }, + "MessageFlow": { + "type": "string", + "description": "Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum." + }, + "MessageSamples": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars." + }, + "UsAppToPersonUsecase": { + "type": "string", + "description": "A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..]" + }, + "HasEmbeddedLinks": { + "type": "boolean", + "description": "Indicates that this SMS campaign will send messages that contain links." + }, + "HasEmbeddedPhone": { + "type": "boolean", + "description": "Indicates that this SMS campaign will send messages that contain phone numbers." + }, + "OptInMessage": { + "type": "string", + "description": "If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum." + }, + "OptOutMessage": { + "type": "string", + "description": "Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum." + }, + "HelpMessage": { + "type": "string", + "description": "When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum." + }, + "OptInKeywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum." + }, + "OptOutKeywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum." + }, + "HelpKeywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum." + }, + "SubscriberOptIn": { + "type": "boolean", + "description": "A boolean that specifies whether campaign has Subscriber Optin or not." + }, + "AgeGated": { + "type": "boolean", + "description": "A boolean that specifies whether campaign is age gated or not." + }, + "DirectLending": { + "type": "boolean", + "description": "A boolean that specifies whether campaign allows direct lending or not." + } + }, + "required": [ + "BrandRegistrationSid", + "Description", + "MessageFlow", + "MessageSamples", + "UsAppToPersonUsecase", + "HasEmbeddedLinks", + "HasEmbeddedPhone" + ] + }, + "examples": { + "create": { + "value": { + "BrandRegistrationSid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Description": "Send marketing messages about sales to opted in customers.", + "MessageSamples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "UsAppToPersonUsecase": "MARKETING", + "MessageFlow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "OptInMessage": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "OptOutMessage": "You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number.", + "HelpMessage": "Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.", + "OptInKeywords": [ + "START" + ], + "OptOutKeywords": [ + "STOP" + ], + "HelpKeywords": [ + "HELP" + ], + "HasEmbeddedLinks": true, + "HasEmbeddedPhone": false, + "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 + } + } + } + } + } + } + }, + "get": { + "description": "", + "tags": [ + "MessagingV1UsAppToPerson" + ], + "parameters": [ + { + "name": "MessagingServiceSid", + "in": "path", + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^MG[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 @@ -3854,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" @@ -3872,17 +6736,150 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "compliance": [ + { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "brand_registration_sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Send marketing messages about sales to opted in customers.", + "message_samples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "us_app_to_person_usecase": "MARKETING", + "has_embedded_links": true, + "has_embedded_phone": false, + "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" } } } @@ -3897,10 +6894,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsAppToPerson", - "x-maturity": [ - "Beta" - ] + "operationId": "ListUsAppToPerson" } }, "/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}": { @@ -3916,17 +6910,20 @@ "campaign_status", "date_created" ], - "pathType": "instance", "parent": "/Services/{Sid}", - "mountName": "us_app_to_person" + "mountName": "us_app_to_person", + "pathType": "instance" }, "delete": { "description": "", + "tags": [ + "MessagingV1UsAppToPerson" + ], "parameters": [ { "name": "MessagingServiceSid", "in": "path", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to delete the resource from.", + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to delete the resource from.", "schema": { "type": "string", "minLength": 34, @@ -3958,18 +6955,18 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUsAppToPerson", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteUsAppToPerson" }, "get": { "description": "", + "tags": [ + "MessagingV1UsAppToPerson" + ], "parameters": [ { "name": "MessagingServiceSid", "in": "path", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to fetch the resource from.", + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from.", "schema": { "type": "string", "minLength": 34, @@ -3997,6 +6994,164 @@ "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." + } + ] + } + } } } }, @@ -4008,10 +7163,176 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsAppToPerson", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUsAppToPerson" + }, + "post": { + "description": "", + "tags": [ + "MessagingV1UsAppToPerson" + ], + "parameters": [ + { + "name": "MessagingServiceSid", + "in": "path", + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to update the resource from.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The SID of the US A2P Compliance resource to update `QE2c6890da8086d771620e9b13fadeba0b`.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^QE[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "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": [] + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateUsAppToPerson", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateUsAppToPersonRequest", + "properties": { + "HasEmbeddedLinks": { + "type": "boolean", + "description": "Indicates that this SMS campaign will send messages that contain links." + }, + "HasEmbeddedPhone": { + "type": "boolean", + "description": "Indicates that this SMS campaign will send messages that contain phone numbers." + }, + "MessageSamples": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars." + }, + "MessageFlow": { + "type": "string", + "description": "Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum." + }, + "Description": { + "type": "string", + "description": "A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters." + }, + "AgeGated": { + "type": "boolean", + "description": "A boolean that specifies whether campaign requires age gate for federally legal content." + }, + "DirectLending": { + "type": "boolean", + "description": "A boolean that specifies whether campaign allows direct lending or not." + } + }, + "required": [ + "HasEmbeddedLinks", + "HasEmbeddedPhone", + "MessageSamples", + "MessageFlow", + "Description", + "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 + } + } + } + } + } + } } }, "/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases": { @@ -4025,17 +7346,20 @@ "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": "", + "tags": [ + "MessagingV1UsAppToPersonUsecase" + ], "parameters": [ { "name": "MessagingServiceSid", "in": "path", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to fetch the resource from.", + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from.", "schema": { "type": "string", "minLength": 34, @@ -4053,6 +7377,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^BN[0-9a-fA-F]{32}$" + }, + "examples": { + "fetchWithBrandRegistrationSid": { + "value": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } } ], @@ -4062,6 +7391,260 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.us_app_to_person_usecase" + }, + "examples": { + "fetchWithBrandRegistrationSid": { + "value": { + "us_app_to_person_usecases": [ + { + "code": "2FA", + "name": "Two-Factor authentication (2FA)", + "description": "Two-Factor authentication, one-time use password, password reset", + "post_approval_required": false + }, + { + "code": "ACCOUNT_NOTIFICATION", + "name": "Account Notification", + "description": "All reminders, alerts, and notifications. (Examples include: flight delayed, hotel booked, appointment reminders.)", + "post_approval_required": false + }, + { + "code": "AGENTS_FRANCHISES", + "name": "Agents and Franchises", + "description": "For brands that have multiple agents, franchises or offices in the same brand vertical, but require individual localised numbers per agent/location/office.", + "post_approval_required": true + }, + { + "code": "CHARITY", + "name": "Charity", + "description": "Includes: 5013C Charity\nDoes not include: Religious organizations", + "post_approval_required": false + }, + { + "code": "PROXY", + "name": "Proxy", + "description": "Peer-to-peer app-based group messaging with proxy/pooled numbers (For example: GroupMe)\nSupporting personalized services and non-exposure of personal numbers for enterprise or A2P communications. (Examples include: Uber and AirBnb.)", + "post_approval_required": true + }, + { + "code": "CUSTOMER_CARE", + "name": "Customer Care", + "description": "All customer care messaging, including account management and support", + "post_approval_required": false + }, + { + "code": "DELIVERY_NOTIFICATION", + "name": "Delivery Notification", + "description": "Information about the status of the delivery of a product or service", + "post_approval_required": false + }, + { + "code": "EMERGENCY", + "name": "Emergency", + "description": "Notification services designed to support public safety / health during natural disasters, armed conflicts, pandemics and other national or regional emergencies", + "post_approval_required": true + }, + { + "code": "FRAUD_ALERT", + "name": "Fraud Alert Messaging", + "description": "Fraud alert notification", + "post_approval_required": false + }, + { + "code": "HIGHER_EDUCATION", + "name": "Higher Education", + "description": "For campaigns created on behalf of Colleges or Universities and will also include School Districts etc that fall outside of any \"free to the consumer\" messaging model", + "post_approval_required": false + }, + { + "code": "K12_EDUCATION", + "name": "K-12 Education", + "description": "Campaigns created for messaging platforms that support schools from grades K-12 and distance learning centers. This is not for Post-Secondary schools.", + "post_approval_required": true + }, + { + "code": "LOW_VOLUME", + "name": "Low Volume Mixed", + "description": "Low throughput, any combination of use-cases. Examples include: test, demo accounts", + "post_approval_required": false + }, + { + "code": "MARKETING", + "name": "Marketing", + "description": "Any communication with marketing and/or promotional content", + "post_approval_required": false + }, + { + "code": "MIXED", + "name": "Mixed", + "description": "Mixed messaging reserved for specific consumer service industry", + "post_approval_required": false + }, + { + "code": "POLITICAL", + "name": "Political", + "description": "Part of organized effort to influence decision making of specific group. All campaigns to be verified", + "post_approval_required": false + }, + { + "code": "POLLING_VOTING", + "name": "Polling and voting", + "description": "Polling and voting", + "post_approval_required": false + }, + { + "code": "PUBLIC_SERVICE_ANNOUNCEMENT", + "name": "Public Service Announcement", + "description": "An informational message that is meant to raise the audience awareness about an important issue", + "post_approval_required": false + }, + { + "code": "SECURITY_ALERT", + "name": "Security Alert", + "description": "A notification that the security of a system, either software or hardware, has been compromised in some way and there is an action you need to take", + "post_approval_required": false + }, + { + "code": "SOCIAL", + "name": "Social", + "description": "Communication within or between closed communities (For example: influencers alerts)", + "post_approval_required": true + }, + { + "code": "SWEEPSTAKE", + "name": "Sweepstake", + "description": "Sweepstake", + "post_approval_required": true + } + ] + } + }, + "fetchWithoutBrandRegistrationSid": { + "value": { + "us_app_to_person_usecases": [ + { + "code": "2FA", + "name": "Two-Factor authentication (2FA)", + "description": "Two-Factor authentication, one-time use password, password reset", + "post_approval_required": false + }, + { + "code": "ACCOUNT_NOTIFICATION", + "name": "Account Notification", + "description": "All reminders, alerts, and notifications. (Examples include: flight delayed, hotel booked, appointment reminders.)", + "post_approval_required": false + }, + { + "code": "AGENTS_FRANCHISES", + "name": "Agents and Franchises", + "description": "For brands that have multiple agents, franchises or offices in the same brand vertical, but require individual localised numbers per agent/location/office.", + "post_approval_required": true + }, + { + "code": "CHARITY", + "name": "Charity", + "description": "Includes: 5013C Charity\nDoes not include: Religious organizations", + "post_approval_required": false + }, + { + "code": "PROXY", + "name": "Proxy", + "description": "Peer-to-peer app-based group messaging with proxy/pooled numbers (For example: GroupMe)\nSupporting personalized services and non-exposure of personal numbers for enterprise or A2P communications. (Examples include: Uber and AirBnb.)", + "post_approval_required": true + }, + { + "code": "CUSTOMER_CARE", + "name": "Customer Care", + "description": "All customer care messaging, including account management and support", + "post_approval_required": false + }, + { + "code": "DELIVERY_NOTIFICATION", + "name": "Delivery Notification", + "description": "Information about the status of the delivery of a product or service", + "post_approval_required": false + }, + { + "code": "EMERGENCY", + "name": "Emergency", + "description": "Notification services designed to support public safety / health during natural disasters, armed conflicts, pandemics and other national or regional emergencies", + "post_approval_required": true + }, + { + "code": "FRAUD_ALERT", + "name": "Fraud Alert Messaging", + "description": "Fraud alert notification", + "post_approval_required": false + }, + { + "code": "HIGHER_EDUCATION", + "name": "Higher Education", + "description": "For campaigns created on behalf of Colleges or Universities and will also include School Districts etc that fall outside of any \"free to the consumer\" messaging model", + "post_approval_required": false + }, + { + "code": "K12_EDUCATION", + "name": "K-12 Education", + "description": "Campaigns created for messaging platforms that support schools from grades K-12 and distance learning centers. This is not for Post-Secondary schools.", + "post_approval_required": true + }, + { + "code": "LOW_VOLUME", + "name": "Low Volume Mixed", + "description": "Low throughput, any combination of use-cases. Examples include: test, demo accounts", + "post_approval_required": false + }, + { + "code": "MARKETING", + "name": "Marketing", + "description": "Any communication with marketing and/or promotional content", + "post_approval_required": false + }, + { + "code": "MIXED", + "name": "Mixed", + "description": "Mixed messaging reserved for specific consumer service industry", + "post_approval_required": false + }, + { + "code": "POLITICAL", + "name": "Political", + "description": "Part of organized effort to influence decision making of specific group. All campaigns to be verified", + "post_approval_required": false + }, + { + "code": "POLLING_VOTING", + "name": "Polling and voting", + "description": "Polling and voting", + "post_approval_required": false + }, + { + "code": "PUBLIC_SERVICE_ANNOUNCEMENT", + "name": "Public Service Announcement", + "description": "An informational message that is meant to raise the audience awareness about an important issue", + "post_approval_required": false + }, + { + "code": "SECURITY_ALERT", + "name": "Security Alert", + "description": "A notification that the security of a system, either software or hardware, has been compromised in some way and there is an action you need to take", + "post_approval_required": false + }, + { + "code": "SOCIAL", + "name": "Social", + "description": "Communication within or between closed communities (For example: influencers alerts)", + "post_approval_required": true + }, + { + "code": "SWEEPSTAKE", + "name": "Sweepstake", + "description": "Sweepstake", + "post_approval_required": true + } + ] + } + } } } }, @@ -4073,10 +7656,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsAppToPersonUsecase", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUsAppToPersonUsecase" } }, "/v1/Services/Usecases": { @@ -4094,12 +7674,33 @@ }, "get": { "description": "", + "tags": [ + "MessagingV1Usecase" + ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.usecase" + }, + "examples": { + "fetch": { + "value": { + "usecases": [ + { + "usecase": "notifications", + "description": "Transactional notifications and Alerts for any Delivery, Account, Reminder, Order, Fraud, Security, Public Service, or Emergency announcements.", + "purpose": "Notify my users." + }, + { + "usecase": "marketing", + "description": "Marketing messages may contain product information, offers, and calls to action to engage with your organization.", + "purpose": "Market my services." + } + ] + } + } } } }, @@ -4111,10 +7712,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsecase", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUsecase" } } }, @@ -4123,14 +7721,77 @@ "url": "https://messaging.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "MessagingV1AlphaSender" + }, + { + "name": "MessagingV1BrandRegistration" + }, + { + "name": "MessagingV1BrandRegistrationOtp" + }, + { + "name": "MessagingV1BrandVetting" + }, + { + "name": "MessagingV1ChannelSender" + }, + { + "name": "MessagingV1Deactivations" + }, + { + "name": "MessagingV1DomainCerts" + }, + { + "name": "MessagingV1DomainConfig" + }, + { + "name": "MessagingV1DomainConfigMessagingService" + }, + { + "name": "MessagingV1ExternalCampaign" + }, + { + "name": "MessagingV1LinkshorteningMessagingService" + }, + { + "name": "MessagingV1LinkshorteningMessagingServiceDomainAssociation" + }, + { + "name": "MessagingV1Message" + }, + { + "name": "MessagingV1PhoneNumber" + }, + { + "name": "MessagingV1Service" + }, + { + "name": "MessagingV1ShortCode" + }, + { + "name": "MessagingV1TollfreeVerification" + }, + { + "name": "MessagingV1UsAppToPerson" + }, + { + "name": "MessagingV1UsAppToPersonUsecase" + }, + { + "name": "MessagingV1Usecase" + }, { - "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/spec/json/twilio_microvisor_v1.json b/spec/json/twilio_microvisor_v1.json index 6794a24a..aa431f64 100644 --- a/spec/json/twilio_microvisor_v1.json +++ b/spec/json/twilio_microvisor_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "microvisor.v1.account_config": { "type": "object", @@ -252,12 +258,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -273,7 +273,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -283,14 +283,17 @@ "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.", + "tags": [ + "MicrovisorV1AccountConfig" + ], "parameters": [ { "name": "PageSize", @@ -335,16 +338,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -353,17 +358,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "configs": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", + "next_page_url": null, + "key": "configs" + } + } + }, + "readFull": { + "value": { + "configs": [ + { + "key": "first", + "value": "something", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Configs/first" + }, + { + "key": "second", + "value": "or other", + "date_updated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Configs/second" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", + "next_page_url": null, + "key": "configs" } } } @@ -378,19 +424,29 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccountConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "ListAccountConfig" }, "post": { "description": "Create a config for an Account.", + "tags": [ + "MicrovisorV1AccountConfig" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_config" + }, + "examples": { + "createAccountConfig": { + "value": { + "key": "first", + "value": "place", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Configs/first" + } + } } } }, @@ -403,9 +459,6 @@ } ], "operationId": "CreateAccountConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -426,6 +479,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountConfig": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -438,14 +499,17 @@ "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.", + "tags": [ + "MicrovisorV1AccountConfig" + ], "parameters": [ { "name": "Key", @@ -463,6 +527,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_config" + }, + "examples": { + "fetch": { + "value": { + "key": "first", + "value": "place", + "date_updated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Configs/first" + } + } } } }, @@ -474,13 +548,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccountConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchAccountConfig" }, "post": { "description": "Update a config for an Account.", + "tags": [ + "MicrovisorV1AccountConfig" + ], "parameters": [ { "name": "Key", @@ -498,6 +572,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_config" + }, + "examples": { + "update": { + "value": { + "key": "first", + "value": "place", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Configs/first" + } + } } } }, @@ -510,9 +594,6 @@ } ], "operationId": "UpdateAccountConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -528,6 +609,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -535,6 +623,9 @@ }, "delete": { "description": "Delete a config for an Account.", + "tags": [ + "MicrovisorV1AccountConfig" + ], "parameters": [ { "name": "Key", @@ -556,10 +647,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAccountConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteAccountConfig" } }, "/v1/Secrets": { @@ -568,14 +656,17 @@ "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.", + "tags": [ + "MicrovisorV1AccountSecret" + ], "parameters": [ { "name": "PageSize", @@ -620,16 +711,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -638,17 +731,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "secrets": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", + "next_page_url": null, + "key": "secrets" + } + } + }, + "readFull": { + "value": { + "secrets": [ + { + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Secrets/first" + }, + { + "key": "second", + "date_rotated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Secrets/second" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", + "next_page_url": null, + "key": "secrets" } } } @@ -663,19 +795,28 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccountSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "ListAccountSecret" }, "post": { "description": "Create a secret for an Account.", + "tags": [ + "MicrovisorV1AccountSecret" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_secret" + }, + "examples": { + "createAccountSecret": { + "value": { + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Secrets/first" + } + } } } }, @@ -688,9 +829,6 @@ } ], "operationId": "CreateAccountSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -711,6 +849,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountSecret": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -723,14 +869,17 @@ "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.", + "tags": [ + "MicrovisorV1AccountSecret" + ], "parameters": [ { "name": "Key", @@ -748,6 +897,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_secret" + }, + "examples": { + "fetch": { + "value": { + "key": "first", + "date_rotated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Secrets/first" + } + } } } }, @@ -759,13 +917,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccountSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchAccountSecret" }, "post": { "description": "Update a secret for an Account.", + "tags": [ + "MicrovisorV1AccountSecret" + ], "parameters": [ { "name": "Key", @@ -783,6 +941,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_secret" + }, + "examples": { + "update": { + "value": { + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Secrets/first" + } + } } } }, @@ -795,9 +962,6 @@ } ], "operationId": "UpdateAccountSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -813,6 +977,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -820,6 +991,9 @@ }, "delete": { "description": "Delete a secret for an Account.", + "tags": [ + "MicrovisorV1AccountSecret" + ], "parameters": [ { "name": "Key", @@ -841,10 +1015,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAccountSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteAccountSecret" } }, "/v1/Apps": { @@ -853,19 +1024,27 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "list", "dependentProperties": { - "app_manifest": "{app_sid: sid}" - } + "app_manifests": { + "mapping": { + "app_sid": "sid" + }, + "resource_url": "/v1/Apps/{app_sid}/Manifest" + } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Apps for an Account.", + "tags": [ + "MicrovisorV1App" + ], "parameters": [ { "name": "PageSize", @@ -910,16 +1089,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -928,17 +1109,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "apps": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", + "next_page_url": null, + "key": "apps" + } + } + }, + "readFull": { + "value": { + "apps": [ + { + "sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "hash": "hash", + "unique_name": "unique name", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "app_manifests": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", + "next_page_url": null, + "key": "apps" } } } @@ -953,10 +1175,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListApp", - "x-maturity": [ - "Preview" - ] + "operationId": "ListApp" } }, "/v1/Apps/{Sid}": { @@ -965,19 +1184,27 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "instance", "dependentProperties": { - "app_manifest": "{app_sid: sid}" - } + "app_manifests": { + "mapping": { + "app_sid": "sid" + }, + "resource_url": "/v1/Apps/{app_sid}/Manifest" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific App.", + "tags": [ + "MicrovisorV1App" + ], "parameters": [ { "name": "Sid", @@ -995,6 +1222,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.app" + }, + "examples": { + "fetch": { + "value": { + "sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "hash": "hash", + "unique_name": "look at this crazy app", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "app_manifests": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest" + } + } + } } } }, @@ -1006,13 +1249,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchApp", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchApp" }, "delete": { "description": "Delete a specific App.", + "tags": [ + "MicrovisorV1App" + ], "parameters": [ { "name": "Sid", @@ -1034,10 +1277,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteApp", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteApp" } }, "/v1/Apps/{AppSid}/Manifest": { @@ -1046,15 +1286,18 @@ "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.", + "tags": [ + "MicrovisorV1AppManifest" + ], "parameters": [ { "name": "AppSid", @@ -1072,6 +1315,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.app.app_manifest" + }, + "examples": { + "fetch": { + "value": { + "app_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "hash": "some hash", + "encoded_bytes": "some value", + "url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest" + } + } } } }, @@ -1083,10 +1336,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAppManifest", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchAppManifest" } }, "/v1/Devices": { @@ -1095,20 +1345,33 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "list", "dependentProperties": { - "device_config": "{device_sid: sid}", - "device_secret": "{device_sid: sid}" - } + "device_configs": { + "mapping": { + "device_sid": "sid" + }, + "resource_url": "/v1/Devices/{device_sid}/Configs" + }, + "device_secrets": { + "mapping": { + "device_sid": "sid" + }, + "resource_url": "/v1/Devices/{device_sid}/Secrets" + } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Devices registered with the Account.", + "tags": [ + "MicrovisorV1Device" + ], "parameters": [ { "name": "PageSize", @@ -1153,16 +1416,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1171,17 +1436,71 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "devices": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", + "next_page_url": null, + "key": "devices" + } + } + }, + "readFull": { + "value": { + "devices": [ + { + "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "This is my device; there are many like it.", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "app": { + "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_hash": null, + "date_targeted": "2021-01-01T12:34:56Z", + "update_status": "up-to-date", + "update_error_code": 0, + "reported_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_reported": "2021-01-01T12:34:56Z" + }, + "logging": { + "enabled": true, + "date_expires": "2021-01-01T12:34:56Z" + }, + "date_created": "2021-01-01T12:34:56Z", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", + "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", + "next_page_url": null, + "key": "devices" } } } @@ -1196,10 +1515,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDevice", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDevice" } }, "/v1/Devices/{Sid}": { @@ -1208,20 +1524,33 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "instance", "dependentProperties": { - "device_config": "{device_sid: sid}", - "device_secret": "{device_sid: sid}" - } + "device_configs": { + "mapping": { + "device_sid": "sid" + }, + "resource_url": "/v1/Devices/{device_sid}/Configs" + }, + "device_secrets": { + "mapping": { + "device_sid": "sid" + }, + "resource_url": "/v1/Devices/{device_sid}/Secrets" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Device.", + "tags": [ + "MicrovisorV1Device" + ], "parameters": [ { "name": "Sid", @@ -1239,6 +1568,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device" + }, + "examples": { + "fetch": { + "value": { + "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "This is my device; there are many like it.", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "app": { + "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_hash": null, + "date_targeted": "2021-01-01T12:34:56Z", + "update_status": "up-to-date", + "update_error_code": 0, + "reported_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_reported": "2021-01-01T12:34:56Z" + }, + "logging": { + "enabled": true, + "date_expires": "2021-01-01T12:34:56Z" + }, + "date_created": "2021-01-01T12:34:56Z", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", + "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" + } + } + } } } }, @@ -1250,13 +1608,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDevice", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDevice" }, "post": { "description": "Update a specific Device.", + "tags": [ + "MicrovisorV1Device" + ], "parameters": [ { "name": "Sid", @@ -1274,6 +1632,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device" + }, + "examples": { + "update": { + "value": { + "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "UniqueName", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "app": { + "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_hash": null, + "date_targeted": "2021-01-01T12:34:56Z", + "update_status": "pending", + "update_error_code": 0, + "reported_sid": null, + "date_reported": "2021-01-01T12:34:56Z" + }, + "logging": { + "enabled": false, + "date_expires": null + }, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", + "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" + } + } + }, + "restartApp": { + "value": { + "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "UniqueName", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "app": { + "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_hash": null, + "date_targeted": "2021-01-01T12:34:56Z", + "update_status": "pending", + "update_error_code": 0, + "reported_sid": null, + "date_reported": "2021-01-01T12:34:56Z" + }, + "logging": { + "enabled": false, + "date_expires": null + }, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", + "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" + } + } + } } } }, @@ -1286,9 +1700,6 @@ } ], "operationId": "UpdateDevice", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1307,6 +1718,24 @@ "LoggingEnabled": { "type": "boolean", "description": "A Boolean flag specifying whether to enable application logging. Logs will be enabled or extended for 24 hours." + }, + "RestartApp": { + "type": "boolean", + "description": "Set to true to restart the App running on the Device." + } + } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "TargetApp": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "LoggingEnabled": false + } + }, + "restartApp": { + "value": { + "RestartApp": true } } } @@ -1321,15 +1750,18 @@ "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.", + "tags": [ + "MicrovisorV1DeviceConfig" + ], "parameters": [ { "name": "DeviceSid", @@ -1383,16 +1815,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1401,17 +1835,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "configs": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", + "next_page_url": null, + "key": "configs" + } + } + }, + "readFull": { + "value": { + "configs": [ + { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "value": "some value", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" + }, + { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "second", + "value": "some value", + "date_updated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/second" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", + "next_page_url": null, + "key": "configs" } } } @@ -1426,13 +1903,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeviceConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeviceConfig" }, "post": { "description": "Create a config for a Microvisor Device.", + "tags": [ + "MicrovisorV1DeviceConfig" + ], "parameters": [ { "name": "DeviceSid", @@ -1450,6 +1927,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_config" + }, + "examples": { + "createAccountConfig": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "value": "some value", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" + } + } } } }, @@ -1462,9 +1950,6 @@ } ], "operationId": "CreateDeviceConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1485,6 +1970,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountConfig": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -1497,15 +1990,18 @@ "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.", + "tags": [ + "MicrovisorV1DeviceConfig" + ], "parameters": [ { "name": "DeviceSid", @@ -1532,6 +2028,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_config" + }, + "examples": { + "fetch": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "value": "some value", + "date_updated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" + } + } } } }, @@ -1543,13 +2050,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeviceConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeviceConfig" }, "post": { "description": "Update a config for a Microvisor Device.", + "tags": [ + "MicrovisorV1DeviceConfig" + ], "parameters": [ { "name": "DeviceSid", @@ -1576,6 +2083,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_config" + }, + "examples": { + "update": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "value": "place", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" + } + } } } }, @@ -1588,9 +2106,6 @@ } ], "operationId": "UpdateDeviceConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1606,6 +2121,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -1613,6 +2135,9 @@ }, "delete": { "description": "Delete a config for a Microvisor Device.", + "tags": [ + "MicrovisorV1DeviceConfig" + ], "parameters": [ { "name": "DeviceSid", @@ -1643,10 +2168,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeviceConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeviceConfig" } }, "/v1/Devices/{DeviceSid}/Secrets": { @@ -1655,15 +2177,18 @@ "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.", + "tags": [ + "MicrovisorV1DeviceSecret" + ], "parameters": [ { "name": "DeviceSid", @@ -1717,16 +2242,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1735,17 +2262,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "secrets": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", + "next_page_url": null, + "key": "secrets" + } + } + }, + "readFull": { + "value": { + "secrets": [ + { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" + }, + { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "second", + "date_rotated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/second" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", + "next_page_url": null, + "key": "secrets" } } } @@ -1760,13 +2328,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeviceSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeviceSecret" }, "post": { "description": "Create a secret for a Microvisor Device.", + "tags": [ + "MicrovisorV1DeviceSecret" + ], "parameters": [ { "name": "DeviceSid", @@ -1784,6 +2352,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_secret" + }, + "examples": { + "createAccountSecret": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" + } + } } } }, @@ -1796,9 +2374,6 @@ } ], "operationId": "CreateDeviceSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1819,6 +2394,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountSecret": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -1831,15 +2414,18 @@ "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.", + "tags": [ + "MicrovisorV1DeviceSecret" + ], "parameters": [ { "name": "DeviceSid", @@ -1866,6 +2452,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_secret" + }, + "examples": { + "fetch": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "date_rotated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" + } + } } } }, @@ -1877,13 +2473,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeviceSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeviceSecret" }, "post": { "description": "Update a secret for a Microvisor Device.", + "tags": [ + "MicrovisorV1DeviceSecret" + ], "parameters": [ { "name": "DeviceSid", @@ -1910,6 +2506,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_secret" + }, + "examples": { + "update": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" + } + } } } }, @@ -1922,9 +2528,6 @@ } ], "operationId": "UpdateDeviceSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1940,6 +2543,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -1947,6 +2557,9 @@ }, "delete": { "description": "Delete a secret for a Microvisor Device.", + "tags": [ + "MicrovisorV1DeviceSecret" + ], "parameters": [ { "name": "DeviceSid", @@ -1977,10 +2590,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeviceSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeviceSecret" } } }, @@ -1989,10 +2599,41 @@ "url": "https://microvisor.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "MicrovisorV1AccountConfig" + }, + { + "name": "MicrovisorV1AccountSecret" + }, + { + "name": "MicrovisorV1App" + }, + { + "name": "MicrovisorV1AppManifest" + }, + { + "name": "MicrovisorV1DebugToken" + }, + { + "name": "MicrovisorV1Device" + }, + { + "name": "MicrovisorV1DeviceCert" + }, + { + "name": "MicrovisorV1DeviceConfig" + }, + { + "name": "MicrovisorV1DeviceSecret" + }, + { + "name": "MicrovisorV1LoggingToken" + } + ], + "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 help@twilio.com." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_monitor_v1.json b/spec/json/twilio_monitor_v1.json index 328d69f1..9f527499 100644 --- a/spec/json/twilio_monitor_v1.json +++ b/spec/json/twilio_monitor_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "monitor.v1.alert": { "type": "object", @@ -320,12 +326,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -341,7 +341,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -363,6 +363,9 @@ }, "get": { "description": "", + "tags": [ + "MonitorV1Alert" + ], "parameters": [ { "name": "Sid", @@ -383,6 +386,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/monitor.v1.alert-instance" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "alert_text": "alert_text", + "api_version": "2010-04-01", + "date_created": "2015-07-30T20:00:00Z", + "date_generated": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "error_code": "error_code", + "log_level": "log_level", + "more_info": "more_info", + "request_method": "GET", + "request_url": "http://www.example.com", + "request_variables": "request_variables", + "resource_sid": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "response_body": "response_body", + "response_headers": "response_headers", + "request_headers": "request_headers", + "sid": "NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://monitor.twilio.com/v1/Alerts/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "PNe2cd757cd5257b0217a447933a0290d2" + } + } } } }, @@ -394,10 +422,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAlert", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAlert" } }, "/v1/Alerts": { @@ -418,6 +443,9 @@ }, "get": { "description": "", + "tags": [ + "MonitorV1Alert" + ], "parameters": [ { "name": "LogLevel", @@ -425,6 +453,14 @@ "description": "Only show alerts for this log-level. Can be: `error`, `warning`, `notice`, or `debug`.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "log_level" + }, + "readFull": { + "value": "log_level" + } } }, { @@ -434,6 +470,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2016-01-01" + }, + "readFull": { + "value": "2016-01-01" + } } }, { @@ -443,6 +487,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2016-01-01" + }, + "readFull": { + "value": "2016-01-01" + } } }, { @@ -488,16 +540,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -506,17 +560,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "alerts": [], + "meta": { + "first_page_url": "https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0", + "key": "alerts", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "alerts": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "alert_text": "alert_text", + "api_version": "2010-04-01", + "date_created": "2015-07-30T20:00:00Z", + "date_generated": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "error_code": "error_code", + "log_level": "log_level", + "more_info": "more_info", + "request_method": "GET", + "request_url": "http://www.example.com", + "resource_sid": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://monitor.twilio.com/v1/Alerts/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "PNe2cd757cd5257b0217a447933a0290d2" + } + ], + "meta": { + "first_page_url": "https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0", + "key": "alerts", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0" } } } @@ -531,10 +631,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAlert", - "x-maturity": [ - "GA" - ] + "operationId": "ListAlert" } }, "/v1/Events/{Sid}": { @@ -555,6 +652,9 @@ }, "get": { "description": "", + "tags": [ + "MonitorV1Event" + ], "parameters": [ { "name": "Sid", @@ -575,6 +675,34 @@ "application/json": { "schema": { "$ref": "#/components/schemas/monitor.v1.event" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_type": "account", + "description": null, + "event_data": { + "friendly_name": { + "previous": "SubAccount Created at 2014-10-03 09:48 am", + "updated": "Mr. Friendly" + } + }, + "event_date": "2014-10-03T16:48:25Z", + "event_type": "account.updated", + "links": { + "actor": "https://api.twilio.com/2010-04-01/Accounts/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "resource_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_type": "account", + "sid": "AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "api", + "source_ip_address": "10.86.6.250", + "url": "https://monitor.twilio.com/v1/Events/AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -586,10 +714,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEvent", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEvent" } }, "/v1/Events": { @@ -610,6 +735,9 @@ }, "get": { "description": "Returns a list of events in the account, sorted by event-date.", + "tags": [ + "MonitorV1Event" + ], "parameters": [ { "name": "ActorSid", @@ -620,6 +748,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -628,6 +764,14 @@ "description": "Only include events of this [Event Type](https://www.twilio.com/docs/usage/monitor-events#event-types).", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "event_type" + }, + "readEmpty": { + "value": "event_type" + } } }, { @@ -639,6 +783,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -647,6 +799,14 @@ "description": "Only include events that originated from this IP address. Useful for tracking suspicious activity originating from the API or the Twilio Console.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "source_ip_address" + }, + "readEmpty": { + "value": "source_ip_address" + } } }, { @@ -656,6 +816,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -665,6 +833,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -710,16 +886,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -728,17 +906,70 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "events": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_type": "account", + "description": null, + "event_data": { + "friendly_name": { + "previous": "SubAccount Created at 2014-10-03 09:48 am", + "updated": "Mr. Friendly" + } + }, + "event_date": "2014-10-03T16:48:25Z", + "event_type": "account.updated", + "links": { + "actor": "https://api.twilio.com/2010-04-01/Accounts/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "resource_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_type": "account", + "sid": "AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "api", + "source_ip_address": "10.86.6.250", + "url": "https://monitor.twilio.com/v1/Events/AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://monitor.twilio.com/v1/Events?PageSize=50&Page=0", + "key": "events", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://monitor.twilio.com/v1/Events?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "events": [], + "meta": { + "first_page_url": "https://monitor.twilio.com/v1/Events?PageSize=50&Page=0", + "key": "events", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://monitor.twilio.com/v1/Events?PageSize=50&Page=0" } } } @@ -753,10 +984,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEvent", - "x-maturity": [ - "GA" - ] + "operationId": "ListEvent" } } }, @@ -765,10 +993,17 @@ "url": "https://monitor.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "MonitorV1Alert" + }, + { + "name": "MonitorV1Event" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_notify_v1.json b/spec/json/twilio_notify_v1.json index 7e17614e..24d47d93 100644 --- a/spec/json/twilio_notify_v1.json +++ b/spec/json/twilio_notify_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "notify.v1.service.binding": { "type": "object", @@ -61,7 +67,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The `identity` value that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service." + "description": "The `identity` value that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "binding_type": { "type": "string", @@ -71,7 +83,13 @@ "address": { "type": "string", "nullable": true, - "description": "The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format." + "description": "The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 120 + } + } }, "tags": { "type": "array", @@ -79,7 +97,13 @@ "type": "string" }, "nullable": true, - "description": "The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed." + "description": "The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "url": { "type": "string", @@ -208,7 +232,13 @@ "type": "string" }, "nullable": true, - "description": "The list of `identity` values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list." + "description": "The list of `identity` values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "tags": { "type": "array", @@ -216,7 +246,13 @@ "type": "string" }, "nullable": true, - "description": "The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property." + "description": "The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "segments": { "type": "array", @@ -245,7 +281,13 @@ "body": { "type": "string", "nullable": true, - "description": "The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification." + "description": "The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "sound": { "type": "string", @@ -360,7 +402,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. In order to send SMS notifications this parameter has to be set." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. In order to send SMS notifications this parameter has to be set." }, "facebook_messenger_page_id": { "type": "string", @@ -420,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" + ] } } }, @@ -442,7 +489,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -452,7 +499,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -461,11 +508,14 @@ "binding_type", "address" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "NotifyV1Binding" + ], "parameters": [ { "name": "ServiceSid", @@ -498,6 +548,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service.binding" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73", + "binding_type": "apn", + "credential_sid": null, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "endpoint": "26607274", + "identity": "24987039", + "notification_protocol_version": "3", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tags": [ + "26607274" + ], + "links": { + "user": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039" + }, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -509,13 +583,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBinding", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBinding" }, "delete": { "description": "", + "tags": [ + "NotifyV1Binding" + ], "parameters": [ { "name": "ServiceSid", @@ -552,10 +626,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBinding", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteBinding" } }, "/v1/Services/{ServiceSid}/Bindings": { @@ -564,7 +635,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -573,11 +644,14 @@ "binding_type", "address" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "NotifyV1Binding" + ], "parameters": [ { "name": "ServiceSid", @@ -598,6 +672,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service.binding" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73", + "binding_type": "apn", + "credential_sid": null, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "endpoint": "26607274", + "identity": "24987039", + "notification_protocol_version": "3", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tags": [ + "26607274" + ], + "links": { + "user": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039" + }, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -610,9 +708,6 @@ } ], "operationId": "CreateBinding", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -661,6 +756,21 @@ "BindingType", "Address" ] + }, + "examples": { + "create": { + "value": { + "Address": "address", + "BindingType": "apn", + "CredentialSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Endpoint": "endpoint", + "Identity": "24987039", + "NotificationProtocolVersion": "notification_protocol_version", + "Tag": [ + "tag" + ] + } + } } } } @@ -668,6 +778,9 @@ }, "get": { "description": "", + "tags": [ + "NotifyV1Binding" + ], "parameters": [ { "name": "ServiceSid", @@ -708,6 +821,24 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -719,6 +850,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "tag" + ] + }, + "readFull": { + "value": [ + "tag" + ] + } } }, { @@ -764,16 +907,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -782,17 +927,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "bindings": [], + "meta": { + "first_page_url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0", + "key": "bindings", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "bindings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73", + "binding_type": "apn", + "credential_sid": null, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "endpoint": "26607274", + "identity": "24987039", + "notification_protocol_version": "3", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tags": [ + "26607274" + ], + "links": { + "user": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039" + }, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0", + "key": "bindings", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0" } } } @@ -807,10 +1001,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBinding", - "x-maturity": [ - "Beta" - ] + "operationId": "ListBinding" } }, "/v1/Credentials": { @@ -819,7 +1010,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -830,6 +1021,9 @@ }, "get": { "description": "", + "tags": [ + "NotifyV1Credential" + ], "parameters": [ { "name": "PageSize", @@ -874,16 +1068,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -892,17 +1088,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -917,19 +1152,33 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "Beta" - ] + "operationId": "ListCredential" }, "post": { "description": "", + "tags": [ + "NotifyV1Credential" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -942,9 +1191,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -985,6 +1231,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -997,7 +1250,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1008,6 +1261,9 @@ }, "get": { "description": "", + "tags": [ + "NotifyV1Credential" + ], "parameters": [ { "name": "Sid", @@ -1028,6 +1284,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1039,13 +1309,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchCredential" }, "post": { "description": "", + "tags": [ + "NotifyV1Credential" + ], "parameters": [ { "name": "Sid", @@ -1066,6 +1336,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1078,9 +1362,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1113,6 +1394,13 @@ "description": "[FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -1120,6 +1408,9 @@ }, "delete": { "description": "", + "tags": [ + "NotifyV1Credential" + ], "parameters": [ { "name": "Sid", @@ -1144,10 +1435,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteCredential" } }, "/v1/Services/{ServiceSid}/Notifications": { @@ -1156,18 +1444,21 @@ "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": "", + "tags": [ + "NotifyV1Notification" + ], "parameters": [ { "name": "ServiceSid", @@ -1188,6 +1479,58 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service.notification" + }, + "examples": { + "create": { + "value": { + "sid": "NTb8021351170b4e1286adaac3fdd6d082", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "IS699b53e02da45a1ba9d13b7d7d2766af", + "date_created": "2016-03-24T23:42:28Z", + "identities": [ + "jing" + ], + "tags": [], + "segments": [], + "priority": "high", + "ttl": 2419200, + "title": "test", + "body": "body", + "sound": null, + "action": null, + "data": null, + "apn": null, + "fcm": null, + "gcm": null, + "sms": null, + "facebook_messenger": null, + "alexa": null + } + }, + "createDirectNotification": { + "value": { + "sid": "NTb8021351170b4e1286adaac3fdd6d082", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "IS699b53e02da45a1ba9d13b7d7d2766af", + "date_created": "2016-03-24T23:42:28Z", + "identities": [], + "tags": [], + "segments": [], + "priority": "high", + "ttl": 2419200, + "title": null, + "body": "body", + "sound": null, + "action": null, + "data": null, + "apn": null, + "fcm": null, + "gcm": null, + "sms": null, + "facebook_messenger": null, + "alexa": null + } + } } } }, @@ -1200,9 +1543,6 @@ } ], "operationId": "CreateNotification", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1245,7 +1585,7 @@ "description": "The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. See the [GCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) for more details. Target parameters `to`, `registration_ids`, and `notification_key` are not allowed. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. GCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref)." }, "Sms": { - "description": "The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/send-messages) resource. These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`. The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array." + "description": "The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/quickstart) resource. These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`. The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array." }, "FacebookMessenger": { "description": "Deprecated." @@ -1289,6 +1629,23 @@ "description": "A tag that selects the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 5 tags. The implicit tag `all` is available to notify all Bindings in a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to notify all Bindings in a specific channel." } } + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "Body": "body", + "Priority": "high", + "Title": "test", + "DeliveryCallbackUrl": "hello" + } + }, + "createDirectNotification": { + "value": { + "ToBinding": "{\"binding_type\":\"apn\", \"address\":\"0efb85d06b3cc1bf290545fde4775a929d46b3541aaa4aa167e420b6c8b0ff15\"}", + "Body": "body" + } + } } } } @@ -1309,29 +1666,84 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "binding": "{service_sid: sid}", - "notification": "{service_sid: sid}", - "notify/v1/user": "{service_sid: sid}", - "notify/v1/segment": "{service_sid: sid}" - } + "bindings": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Bindings" + }, + "notifications": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Notifications" + }, + "users": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Users" + }, + "segments": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Segments" + } + }, + "pathType": "list" }, "post": { "description": "", + "tags": [ + "NotifyV1Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service" + }, + "examples": { + "create": { + "value": { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "733c7f0f-6541-42ec-84ce-e2ae1cac588c", + "date_created": "2016-03-09T20:22:31Z", + "date_updated": "2016-03-09T20:22:31Z", + "apn_credential_sid": null, + "gcm_credential_sid": null, + "fcm_credential_sid": null, + "messaging_service_sid": null, + "facebook_messenger_page_id": "4", + "alexa_skill_id": null, + "default_apn_notification_protocol_version": "3", + "default_gcm_notification_protocol_version": "3", + "default_fcm_notification_protocol_version": "3", + "default_alexa_notification_protocol_version": "3", + "log_enabled": true, + "type": "S", + "delivery_callback_url": "Hello", + "delivery_callback_enabled": true, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "bindings": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "notifications": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications", + "segments": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments", + "users": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users" + } + } + } } } }, @@ -1344,9 +1756,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1377,7 +1786,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." }, "FacebookMessengerPageId": { "type": "string", @@ -1423,6 +1832,24 @@ "description": "Callback configuration that enables delivery callbacks, default false" } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "ApnCredentialSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "GcmCredentialSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FacebookMessengerPageId": "4", + "DefaultApnNotificationProtocolVersion": "3", + "DefaultGcmNotificationProtocolVersion": "3", + "DefaultFcmNotificationProtocolVersion": "3", + "LogEnabled": "True", + "Type": "S", + "DeliveryCallbackUrl": "Hello", + "DeliveryCallbackEnabled": "True" + } + } } } } @@ -1430,6 +1857,9 @@ }, "get": { "description": "", + "tags": [ + "NotifyV1Service" + ], "parameters": [ { "name": "FriendlyName", @@ -1482,16 +1912,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1500,18 +1932,75 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0", + "next_page_url": null, + "key": "services" + }, + "services": [ + { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "733c7f0f-6541-42ec-84ce-e2ae1cac588c", + "date_created": "2016-03-09T20:22:31Z", + "date_updated": "2016-03-09T20:22:31Z", + "apn_credential_sid": null, + "gcm_credential_sid": null, + "fcm_credential_sid": null, + "messaging_service_sid": null, + "facebook_messenger_page_id": "4", + "alexa_skill_id": null, + "default_apn_notification_protocol_version": "3", + "default_gcm_notification_protocol_version": "3", + "default_fcm_notification_protocol_version": "3", + "default_alexa_notification_protocol_version": "3", + "log_enabled": true, + "type": "S", + "delivery_callback_url": "Hello", + "delivery_callback_enabled": true, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "bindings": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "notifications": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications", + "segments": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments", + "users": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0", + "next_page_url": null, + "key": "services" + }, + "services": [] } } } @@ -1525,10 +2014,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" } }, "/v1/Services/{Sid}": { @@ -1537,23 +2023,46 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "binding": "{service_sid: sid}", - "notification": "{service_sid: sid}", - "notify/v1/user": "{service_sid: sid}", - "notify/v1/segment": "{service_sid: sid}" - } + "bindings": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Bindings" + }, + "notifications": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Notifications" + }, + "users": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Users" + }, + "segments": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Segments" + } + }, + "pathType": "instance" }, "delete": { "description": "", + "tags": [ + "NotifyV1Service" + ], "parameters": [ { "name": "Sid", @@ -1578,13 +2087,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "get": { "description": "", + "tags": [ + "NotifyV1Service" + ], "parameters": [ { "name": "Sid", @@ -1605,6 +2114,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service" + }, + "examples": { + "fetch": { + "value": { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "733c7f0f-6541-42ec-84ce-e2ae1cac588c", + "date_created": "2016-03-09T20:22:31Z", + "date_updated": "2016-03-09T20:22:31Z", + "apn_credential_sid": null, + "gcm_credential_sid": null, + "fcm_credential_sid": null, + "messaging_service_sid": null, + "facebook_messenger_page_id": "4", + "alexa_skill_id": null, + "default_apn_notification_protocol_version": "3", + "default_gcm_notification_protocol_version": "3", + "default_fcm_notification_protocol_version": "3", + "default_alexa_notification_protocol_version": "3", + "log_enabled": true, + "type": "S", + "delivery_callback_url": "Hello", + "delivery_callback_enabled": true, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "bindings": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "notifications": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications", + "segments": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments", + "users": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users" + } + } + } } } }, @@ -1616,13 +2157,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "post": { "description": "", + "tags": [ + "NotifyV1Service" + ], "parameters": [ { "name": "Sid", @@ -1643,6 +2184,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service" + }, + "examples": { + "update": { + "value": { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "733c7f0f-6541-42ec-84ce-e2ae1cac588c", + "date_created": "2016-03-09T20:22:31Z", + "date_updated": "2016-03-09T20:22:31Z", + "apn_credential_sid": null, + "gcm_credential_sid": null, + "fcm_credential_sid": null, + "default_apn_notification_protocol_version": "3", + "default_gcm_notification_protocol_version": "3", + "default_fcm_notification_protocol_version": "3", + "default_alexa_notification_protocol_version": "3", + "messaging_service_sid": null, + "alexa_skill_id": null, + "facebook_messenger_page_id": "4", + "log_enabled": true, + "type": "S", + "delivery_callback_url": "Hello", + "delivery_callback_enabled": true, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "bindings": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "notifications": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications", + "segments": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments", + "users": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users" + } + } + } } } }, @@ -1655,9 +2228,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1688,7 +2258,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." }, "FacebookMessengerPageId": { "type": "string", @@ -1734,6 +2304,24 @@ "description": "Callback configuration that enables delivery callbacks, default false" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "ApnCredentialSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "GcmCredentialSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FacebookMessengerPageId": "4", + "DefaultApnNotificationProtocolVersion": "3", + "DefaultGcmNotificationProtocolVersion": "3", + "DefaultFcmNotificationProtocolVersion": "3", + "LogEnabled": "True", + "Type": "S", + "DeliveryCallbackUrl": "Hello", + "DeliveryCallbackEnabled": "True" + } + } } } } @@ -1746,10 +2334,35 @@ "url": "https://notify.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "NotifyV1Binding" + }, + { + "name": "NotifyV1Credential" + }, + { + "name": "NotifyV1Notification" + }, + { + "name": "NotifyV1Segment" + }, + { + "name": "NotifyV1SegmentMembership" + }, + { + "name": "NotifyV1Service" + }, + { + "name": "NotifyV1User" + }, + { + "name": "NotifyV1UserBinding" + } + ], + "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/spec/json/twilio_numbers_v1.json b/spec/json/twilio_numbers_v1.json index 5ae1b0fa..d21602f9 100644 --- a/spec/json/twilio_numbers_v1.json +++ b/spec/json/twilio_numbers_v1.json @@ -1,6 +1,22 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { + "authorization_document_enum_status": { + "type": "string", + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ] + }, "numbers.v1.bulk_eligibility": { "type": "object", "properties": { @@ -68,6 +84,28 @@ "eligible-by-manual-process" ] }, + "dependent_order_enum_status": { + "type": "string", + "enum": [ + "twilio-processing", + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ] + }, + "dependent_order_enum_verification_type": { + "type": "string", + "enum": [ + "phone-call", + "phone-bill" + ] + }, "numbers.v1.eligibility": { "type": "object", "properties": { @@ -99,12 +137,236 @@ "invalid-hosting-account-sid", "eligible" ] - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" + }, + "hosted_number_order_enum_status": { + "type": "string", + "enum": [ + "twilio-processing", + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ] + }, + "hosted_number_order_enum_verification_type": { + "type": "string", + "enum": [ + "phone-call", + "phone-bill" + ] + }, + "numbers.v1.porting_bulk_portability": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KZ[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this Portability check." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/porting_bulk_portability_enum_status", + "nullable": true, + "description": "The Status of this Portability check. One of `in-progress`, `completed` or `expired`." + }, + "datetime_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that the Portability check was created, given in ISO 8601 format." + }, + "phone_numbers": { + "type": "array", + "items": {}, + "nullable": true, + "description": "Contains a list with all the information of the requested phone numbers. Each phone number contains the following properties: `phone_number`: The phone number which portability is to be checked. `portable`: Boolean flag specifying if phone number is portable or not. `not_portable_reason`: Reason why the phone number cannot be ported into Twilio, `null` otherwise. `not_portable_reason_code`: The Portability Reason Code for the phone number if it cannot be ported in Twilio, `null` otherwise. `pin_and_account_number_required`: Boolean flag specifying if PIN and account number is required for the phone number. `number_type`: The type of the requested phone number. `country` Country the phone number belongs to. `messaging_carrier` Current messaging carrier of the phone number. `voice_carrier` Current voice carrier of the phone number." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "This is the url of the request that you're trying to reach out to locate the resource." + } + } + }, + "porting_bulk_portability_enum_status": { + "type": "string", + "enum": [ + "in-progress", + "completed", + "expired" + ] + }, + "numbers.v1.porting_port_in": { + "type": "object", + "properties": { + "port_in_request_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KW[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Port In request. This is a unique identifier of the port in request." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + } + }, + "numbers.v1.porting_port_in_fetch": { + "type": "object", + "properties": { + "port_in_request_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KW[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Port In request. This is a unique identifier of the port in request." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this Port In request" + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The Account SID that the numbers will be added to after they are ported into Twilio." + }, + "notification_emails": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "List of emails for getting notifications about the LOA signing process. Allowed Max 10 emails." + }, + "target_port_in_date": { + "type": "string", + "format": "date", + "nullable": true, + "description": "Minimum number of days in the future (at least 2 days) needs to be established with the Ops team for validation." + }, + "target_port_in_time_range_start": { + "type": "string", + "nullable": true, + "description": "Minimum hour in the future needs to be established with the Ops team for validation." + }, + "target_port_in_time_range_end": { + "type": "string", + "nullable": true, + "description": "Maximum hour in the future needs to be established with the Ops team for validation." + }, + "losing_carrier_information": { + "nullable": true, + "description": "The information for the losing carrier. " + }, + "phone_numbers": { + "type": "array", + "items": {}, + "nullable": true, + "description": "The list of phone numbers to Port in. Phone numbers are in E.164 format (e.g. +16175551212)." + }, + "documents": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "The list of documents SID referencing a utility bills" + } + } + }, + "numbers.v1.porting_portability": { + "type": "object", + "properties": { + "phone_number": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212)." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The target account sid to which the number will be ported" + }, + "portable": { + "type": "boolean", + "nullable": true, + "description": "Boolean flag specifying if phone number is portable or not." + }, + "pin_and_account_number_required": { + "type": "boolean", + "nullable": true, + "description": "Boolean flag specifying if PIN and account number is required for the phone number." + }, + "not_portable_reason": { + "type": "string", + "nullable": true, + "description": "Reason why the phone number cannot be ported into Twilio, `null` otherwise." + }, + "not_portable_reason_code": { + "type": "integer", + "nullable": true, + "description": "The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise. One of `22131`, `22132`, `22130`, `22133`, `22102` or `22135`." + }, + "number_type": { + "type": "string", + "$ref": "#/components/schemas/porting_portability_enum_number_type", + "nullable": true, + "description": "The type of the requested phone number. One of `LOCAL`, `UNKNOWN`, `MOBILE`, `TOLL-FREE`." + }, + "country": { + "type": "string", + "format": "iso-country-code", + "nullable": true, + "description": "Country the phone number belongs to." + }, + "messaging_carrier": { + "type": "string", + "nullable": true, + "description": "Current messaging carrier of the phone number" + }, + "voice_carrier": { + "type": "string", + "nullable": true, + "description": "Current voice carrier of the phone number" + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "This is the url of the request that you're trying to reach out to locate the resource." + } + } + }, + "porting_portability_enum_number_type": { + "type": "string", + "enum": [ + "LOCAL", + "UNKNOWN", + "MOBILE", + "TOLL-FREE" + ] } } }, @@ -121,7 +383,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -131,11 +393,59 @@ "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" + } + } + } + } + }, + "description": "Accepted" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateBulkEligibility", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateBulkEligibilityRequest", + "properties": {} + } + } + } + } } }, "/v1/HostedNumber/Eligibility/Bulk/{RequestId}": { @@ -144,14 +454,17 @@ "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.", + "tags": [ + "NumbersV1BulkEligibility" + ], "parameters": [ { "name": "RequestId", @@ -172,6 +485,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.bulk_eligibility" + }, + "examples": { + "fetch": { + "value": { + "friendly_name": "Foo", + "status": "SUCCESSFUL", + "date_created": "2023-04-24T14:47:04Z", + "date_completed": "2023-04-24T14:47:06Z", + "results": [ + { + "phone_number": "+18778894546", + "account_sid": "AC93b447ff5bd2abac37f1cbab2a871430", + "eligibility_status": "INELIGIBLE", + "eligibility_sub_status": "ALREADY_IN_TWILIO", + "ineligibility_reason": "ALREADY_IN_TWILIO_BUT_NOT_IN_USE", + "next_step": "CONTACT_SUPPORT_INELIGIBLE_INVENTORY_STATUS", + "voice_provider": null, + "messaging_provider": null, + "phone_number_type": "TOLL_FREE", + "hosting_order_sid": null, + "hosting_order_status": null, + "iso_country_code": "US", + "inventory_status": "in-testing", + "inventory_account_sid": "AC93b447ff5bd2abac37f1cbab2a871430" + } + ], + "url": "https://numbers.twilio.com/v1/HostedNumber/Eligibility/Bulk/ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "request_id": "ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -183,10 +526,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBulkEligibility", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBulkEligibility" } }, "/v1/HostedNumber/Eligibility": { @@ -195,11 +535,495 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "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 + } + ] + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateEligibility", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateEligibilityRequest", + "properties": {} + } + } + } + } + } + }, + "/v1/Porting/Portability/{Sid}": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "status" + ], + "mountName": "porting_bulk_portabilities", + "pathType": "instance" + }, + "get": { + "description": "Fetch a previous portability check. This should return the current status of the validation and the result for all the numbers provided, given that they have been validated (as this process is performed asynchronously).", + "tags": [ + "NumbersV1PortingBulkPortability" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies the Portability check.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KZ[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.porting_bulk_portability" + }, + "examples": { + "fetch": { + "value": { + "sid": "KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "datetime_created": "2015-07-30T20:00:00Z", + "phone_numbers": [ + { + "phone_number": "+14153334440", + "portable": true, + "pin_and_account_number_required": true, + "not_portable_reason": null, + "not_portable_reason_code": null, + "number_type": "LOCAL", + "country": "US", + "messaging_carrier": "string", + "voice_carrier": "string" + }, + { + "phone_number": "+18002178781", + "portable": false, + "pin_and_account_number_required": false, + "not_portable_reason": "MANUAL_PORTING_AVAILABLE", + "not_portable_reason_code": 22133, + "number_type": "TOLL-FREE", + "country": "US", + "messaging_carrier": "Verizon", + "voice_carrier": "Verizon" + } + ], + "url": "https://numbers.twilio.com/v1/Porting/Portability/KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchPortingBulkPortability" + } + }, + "/v1/Porting/Portability": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "status" + ], + "mountName": "porting_bulk_portabilities", + "pathType": "list" + }, + "post": { + "description": "Allows to check if a list of phone numbers can be ported to Twilio or not. This is done asynchronous for each phone number.", + "tags": [ + "NumbersV1PortingBulkPortability" + ], + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.porting_bulk_portability" + }, + "examples": { + "create": { + "value": { + "sid": "KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "in-progress", + "datetime_created": "2015-07-30T20:00:00Z", + "phone_numbers": [], + "url": "https://numbers.twilio.com/v1/Porting/Portability/KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Accepted" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreatePortingBulkPortability", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreatePortingBulkPortabilityRequest", + "properties": { + "PhoneNumbers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The phone numbers which portability is to be checked. This should be a list of strings. Phone numbers are in E.164 format (e.g. +16175551212). ." + } + }, + "required": [ + "PhoneNumbers" + ] + }, + "examples": { + "create": { + "value": { + "PhoneNumbers": [ + "+14153334440", + "+18002178781" + ] + } + } + } + } + } + } + } + }, + "/v1/Porting/PortIn": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "port_in_request_sid" + ], + "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", + "url": "https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Accepted" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreatePortingPortIn", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreatePortingPortInRequest", + "properties": {} + } + } + } + } + } + }, + "/v1/Porting/PortIn/{PortInRequestSid}": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "port_in_request_sid" + ], + "mountName": "porting_port_ins_fetch", + "className": "porting_port_in_fetch", + "pathType": "instance" + }, + "get": { + "description": "Fetch a port in request by SID", + "tags": [ + "NumbersV1PortingPortInFetch" + ], + "parameters": [ + { + "name": "PortInRequestSid", + "in": "path", + "description": "The SID of the Port In request. This is a unique identifier of the port in request.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KW[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.porting_port_in_fetch" + }, + "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", + "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 + } + ], + "documents": [ + "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchPortingPortInFetch" + } + }, + "/v1/Porting/Portability/PhoneNumber/{PhoneNumber}": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "mountName": "eligibilities" + "mountName": "porting_portabilities", + "pathType": "instance" + }, + "get": { + "description": "Allows to check if a single phone number can be ported to Twilio or not.", + "tags": [ + "NumbersV1PortingPortability" + ], + "parameters": [ + { + "name": "PhoneNumber", + "in": "path", + "description": "The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).", + "schema": { + "type": "string", + "format": "phone-number" + }, + "required": true + }, + { + "name": "TargetAccountSid", + "in": "query", + "description": "The SID of the account where the phone number(s) will be ported.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$" + }, + "examples": { + "fetch": { + "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + } + } + } + ], + "responses": { + "200": { + "content": { + "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", + "messaging_carrier": "Verizon", + "voice_carrier": "Verizon", + "url": "https://numbers.twilio.com/v1/Porting/Portability/PhoneNumber/+18001234567" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchPortingPortability" } } }, @@ -208,10 +1032,47 @@ "url": "https://numbers.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "NumbersV1AuthorizationDocument" + }, + { + "name": "NumbersV1BulkEligibility" + }, + { + "name": "NumbersV1DependentOrder" + }, + { + "name": "NumbersV1Documents" + }, + { + "name": "NumbersV1Eligibility" + }, + { + "name": "NumbersV1HostedNumberOrder" + }, + { + "name": "NumbersV1Identity" + }, + { + "name": "NumbersV1PortingBulkPortability" + }, + { + "name": "NumbersV1PortingPortIn" + }, + { + "name": "NumbersV1PortingPortInFetch" + }, + { + "name": "NumbersV1PortingPortability" + }, + { + "name": "NumbersV1ProofOfAddress" + } + ], + "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/spec/json/twilio_numbers_v2.json b/spec/json/twilio_numbers_v2.json index 932146cd..170424db 100644 --- a/spec/json/twilio_numbers_v2.json +++ b/spec/json/twilio_numbers_v2.json @@ -1,6 +1,180 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { + "numbers.v2.authorization_document": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this AuthorizationDocument." + }, + "address_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/authorization_document_enum_status", + "nullable": true, + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." + }, + "email": { + "type": "string", + "nullable": true, + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "cc_emails": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true + } + } + }, + "authorization_document_enum_status": { + "type": "string", + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ] + }, + "numbers.v2.bulk_hosted_number_order": { + "type": "object", + "properties": { + "bulk_hosting_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BH[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this BulkHostedNumberOrder." + }, + "request_status": { + "type": "string", + "$ref": "#/components/schemas/bulk_hosted_number_order_enum_request_status", + "nullable": true, + "description": "A string that shows the status of the current Bulk Hosting request, it can vary between these values: 'QUEUED','IN_PROGRESS','PROCESSED'" + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A 128 character string that is a human-readable text that describes this resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "notification_email": { + "type": "string", + "nullable": true, + "description": "Email address used for send notifications about this Bulk hosted number request.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_completed": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was completed, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this BulkHostedNumberOrder resource." + }, + "total_count": { + "type": "integer", + "nullable": true, + "description": "The total count of phone numbers in this Bulk hosting request." + }, + "results": { + "type": "array", + "items": {}, + "nullable": true, + "description": "Contains a list of all the individual hosting orders and their information, for this Bulk request. Each result object is grouped by its order status. To see a complete list of order status, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + } + } + }, + "bulk_hosted_number_order_enum_request_status": { + "type": "string", + "enum": [ + "QUEUED", + "IN_PROGRESS", + "PROCESSED" + ] + }, "numbers.v2.regulatory_compliance.bundle": { "type": "object", "properties": { @@ -201,6 +375,172 @@ "business" ] }, + "numbers.v2.authorization_document.dependent_hosted_number_order": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this Authorization Document" + }, + "bulk_hosting_request_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BH[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder." + }, + "next_step": { + "type": "string", + "nullable": true, + "description": "The next step you need to take to complete the hosted number order and request it successfully." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique SID identifier of the Account." + }, + "incoming_phone_number_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder." + }, + "address_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "signing_document_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder." + }, + "phone_number": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "An E164 formatted phone number hosted by this HostedNumberOrder." + }, + "capabilities": { + "type": "object", + "format": "phone-number-capabilities", + "properties": { + "mms": { + "type": "boolean" + }, + "sms": { + "type": "boolean" + }, + "voice": { + "type": "boolean" + }, + "fax": { + "type": "boolean" + } + }, + "nullable": true, + "description": "A mapping of capabilities this hosted phone number will have enabled on Twilio's platform." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A human readable description of this resource, up to 128 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status", + "nullable": true, + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." + }, + "failure_reason": { + "type": "string", + "nullable": true, + "description": "A message that explains why a hosted_number_order went to status \"action-required\"" + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "email": { + "type": "string", + "nullable": true, + "description": "Email of the owner of this phone number that is being hosted.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "cc_emails": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "contact_title": { + "type": "string", + "nullable": true, + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + }, + "contact_phone_number": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "The contact phone number of the person authorized to sign the Authorization Document." + } + } + }, + "dependent_hosted_number_order_enum_status": { + "type": "string", + "enum": [ + "received", + "verified", + "pending-loa", + "carrier-processing", + "completed", + "failed", + "action-required" + ] + }, "numbers.v2.regulatory_compliance.end_user": { "type": "object", "properties": { @@ -233,7 +573,13 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types." + "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -363,80 +709,258 @@ "noncompliant" ] }, - "numbers.v2.regulatory_compliance.bundle.item_assignment": { + "numbers.v2.hosted_number_order": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^BV[0-9a-fA-F]{32}$", + "pattern": "^HR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that we created to identify the Item Assignment resource." + "description": "A 34 character string that uniquely identifies this HostedNumberOrder." }, - "bundle_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that we created to identify the Bundle resource." + "description": "A 34 character string that uniquely identifies the account." }, - "account_sid": { + "incoming_phone_number_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource." + "description": "A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the phone number being hosted." }, - "object_sid": { + "address_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", + "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of an object bag that holds information of the different items." + "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." }, - "date_created": { + "signing_document_sid": { "type": "string", - "format": "date-time", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", "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." + "description": "A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) the user needs to sign." }, - "url": { + "phone_number": { "type": "string", - "format": "uri", + "format": "phone-number", "nullable": true, - "description": "The absolute URL of the Identity resource." - } - } - }, - "numbers.v2.regulatory_compliance.regulation": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RN[0-9a-fA-F]{32}$", + "description": "Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "capabilities": { + "type": "object", + "format": "phone-number-capabilities", + "properties": { + "mms": { + "type": "boolean" + }, + "sms": { + "type": "boolean" + }, + "voice": { + "type": "boolean" + }, + "fax": { + "type": "boolean" + } + }, "nullable": true, - "description": "The unique string that identifies the Regulation resource." + "description": "Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human-readable description that is assigned to describe the Regulation resource. Examples can include Germany: Mobile - Business." + "description": "A 128 character string that is a human-readable text that describes this resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, - "iso_country": { + "status": { "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status", "nullable": true, - "description": "The ISO country code of the phone number's country." + "description": "Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values) section for more information on each of these statuses." }, - "number_type": { + "failure_reason": { "type": "string", "nullable": true, - "description": "The type of phone number restricted by the regulatory requirement. For example, Germany mobile phone numbers provisioned by businesses require a business name with commercial register proof from the Handelsregisterauszug and a proof of address from Handelsregisterauszug or a trade license by Gewerbeanmeldung." + "description": "A message that explains why a hosted_number_order went to status \"action-required\"" + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "email": { + "type": "string", + "nullable": true, + "description": "Email of the owner of this phone number that is being hosted.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "cc_emails": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this HostedNumberOrder." + }, + "contact_title": { + "type": "string", + "nullable": true, + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + }, + "contact_phone_number": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "The contact phone number of the person authorized to sign the Authorization Document." + }, + "bulk_hosting_request_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BH[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder." + }, + "next_step": { + "type": "string", + "nullable": true, + "description": "The next step you need to take to complete the hosted number order and request it successfully." + } + } + }, + "hosted_number_order_enum_status": { + "type": "string", + "enum": [ + "received", + "verified", + "pending-loa", + "carrier-processing", + "completed", + "failed", + "action-required" + ] + }, + "numbers.v2.regulatory_compliance.bundle.item_assignment": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BV[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Item Assignment resource." + }, + "bundle_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Bundle 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/iam/api/account) that created the Item Assignment resource." + }, + "object_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of an object bag that holds information of the different items." + }, + "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." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Identity resource." + } + } + }, + "numbers.v2.regulatory_compliance.regulation": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RN[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that identifies the Regulation resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A human-readable description that is assigned to describe the Regulation resource. Examples can include Germany: Mobile - Business." + }, + "iso_country": { + "type": "string", + "nullable": true, + "description": "The ISO country code of the phone number's country." + }, + "number_type": { + "type": "string", + "nullable": true, + "description": "The type of phone number restricted by the regulatory requirement. For example, Germany mobile phone numbers provisioned by businesses require a business name with commercial register proof from the Handelsregisterauszug and a proof of address from Handelsregisterauszug or a trade license by Gewerbeanmeldung." }, "end_user_type": { "type": "string", @@ -601,7 +1125,13 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types." + "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -669,12 +1199,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -690,44 +1214,78 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { - "/v2/RegulatoryCompliance/Bundles": { + "/v2/HostedNumber/AuthorizationDocuments/{Sid}": { "servers": [ { "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { - "defaultOutputProperties": [ - "sid", - "regulation_sid", - "friendly_name" - ], - "pathType": "list", + "defaultOutputProperties": [], "dependentProperties": { - "evaluation": "{bundle_sid: sid}", - "item_assignment": "{bundle_sid: sid}", - "bundle_copy": "{bundle_sid: sid}", - "replace_items": "{bundle_sid: sid}" + "dependent_hosted_number_orders": { + "mapping": { + "signing_document_sid": "sid" + }, + "resource_url": "/v2/HostedNumber/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" + } }, - "parent": "/RegulatoryCompliance" + "pathType": "instance" }, - "post": { - "description": "Create a new Bundle.", + "get": { + "description": "Fetch a specific AuthorizationDocument.", + "tags": [ + "NumbersV2AuthorizationDocument" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" + "$ref": "#/components/schemas/numbers.v2.authorization_document" + }, + "examples": { + "fetch": { + "value": { + "address_sid": "AD11111111111111111111111111111111", + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -735,78 +1293,727 @@ "accountSid_authToken": [] } ], - "operationId": "CreateBundle", - "x-maturity": [ - "GA" + "operationId": "FetchAuthorizationDocument" + }, + "delete": { + "description": "Cancel the AuthorizationDocument request.", + "tags": [ + "NumbersV2AuthorizationDocument" ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateBundleRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "The string that you assigned to describe the resource." - }, - "Email": { - "type": "string", - "description": "The email address that will receive updates when the Bundle resource changes status." - }, - "StatusCallback": { - "type": "string", - "format": "uri", - "description": "The URL we call to inform your application of status changes." - }, - "RegulationSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RN[0-9a-fA-F]{32}$", - "description": "The unique string of a regulation that is associated to the Bundle resource." - }, - "IsoCountry": { - "type": "string", - "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request." - }, - "EndUserType": { - "type": "string", - "$ref": "#/components/schemas/bundle_enum_end_user_type", - "description": "The [type of End User](https://www.twilio.com/docs/phone-numbers/regulatory/api/end-user-types) of the Bundle resource." - }, - "NumberType": { - "type": "string", - "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll free`." - } - }, - "required": [ - "FriendlyName", - "Email" - ] - } - } + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] } + ], + "operationId": "DeleteAuthorizationDocument" + } + }, + "/v2/HostedNumber/AuthorizationDocuments": { + "servers": [ + { + "url": "https://numbers.twilio.com" } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "dependent_hosted_number_orders": { + "mapping": { + "signing_document_sid": "sid" + }, + "resource_url": "/v2/HostedNumber/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" + } + }, + "pathType": "list" }, "get": { - "description": "Retrieve a list of all Bundles for an account.", + "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", + "tags": [ + "NumbersV2AuthorizationDocument" + ], "parameters": [ { - "name": "Status", + "name": "Email", "in": "query", - "description": "The verification status of the Bundle resource. Please refer to [Bundle Statuses](https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.", + "description": "Email that this AuthorizationDocument will be sent to for signing.", "schema": { - "type": "string", - "$ref": "#/components/schemas/bundle_enum_status" - } - }, - { - "name": "FriendlyName", + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "test+hosted@twilio.com" + } + } + }, + { + "name": "Status", + "in": "query", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/authorization_document_enum_status" + }, + "examples": { + "readEmpty": { + "value": "signed" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListAuthorizationDocumentResponse", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/numbers.v2.authorization_document" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0" + }, + "items": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0" + }, + "items": [ + { + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListAuthorizationDocument" + }, + "post": { + "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", + "tags": [ + "NumbersV2AuthorizationDocument" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v2.authorization_document" + }, + "examples": { + "create": { + "value": { + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateAuthorizationDocument", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateAuthorizationDocumentRequest", + "properties": { + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." + }, + "Email": { + "type": "string", + "description": "Email that this AuthorizationDocument will be sent to for signing." + }, + "ContactPhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The contact phone number of the person authorized to sign the Authorization Document." + }, + "HostedNumberOrderSids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." + }, + "ContactTitle": { + "type": "string", + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." + } + }, + "required": [ + "AddressSid", + "Email", + "ContactPhoneNumber", + "HostedNumberOrderSids" + ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "HostedNumberOrderSids": [ + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + ], + "ContactTitle": "Mr.", + "ContactPhoneNumber": "+14155555555" + } + } + } + } + } + } + } + }, + "/v2/HostedNumber/Orders/Bulk/{BulkHostingSid}": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "mountName": "bulk_hosted_number_orders", + "pathType": "instance" + }, + "get": { + "description": "Fetch a specific BulkHostedNumberOrder.", + "tags": [ + "NumbersV2BulkHostedNumberOrder" + ], + "parameters": [ + { + "name": "BulkHostingSid", + "in": "path", + "description": "A 34 character string that uniquely identifies this BulkHostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BH[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "OrderStatus", + "in": "query", + "description": "Order status can be used for filtering on Hosted Number Order status values. To see a complete list of order statuses, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "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 + } + ] + } + ] + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchBulkHostedNumberOrder" + } + }, + "/v2/HostedNumber/Orders/Bulk": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "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": [] + } + } + } + } + }, + "description": "Accepted" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateBulkHostedNumberOrder", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateBulkHostedNumberOrderRequest", + "properties": {} + } + } + } + } + } + }, + "/v2/RegulatoryCompliance/Bundles": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "regulation_sid", + "friendly_name" + ], + "dependentProperties": { + "evaluations": { + "mapping": { + "bundle_sid": "sid" + }, + "resource_url": "/v2/RegulatoryCompliance/Bundles/{bundle_sid}/Evaluations" + }, + "item_assignments": { + "mapping": { + "bundle_sid": "sid" + }, + "resource_url": "/v2/RegulatoryCompliance/Bundles/{bundle_sid}/ItemAssignments" + }, + "bundle_copies": { + "mapping": { + "bundle_sid": "sid" + }, + "resource_url": "/v2/RegulatoryCompliance/Bundles/{bundle_sid}/Copies" + }, + "replace_items": { + "mapping": { + "bundle_sid": "sid" + }, + "resource_url": "/v2/RegulatoryCompliance/Bundles/{bundle_sid}/ReplaceItems" + } + }, + "parent": "/RegulatoryCompliance", + "pathType": "list" + }, + "post": { + "description": "Create a new Bundle.", + "tags": [ + "NumbersV2Bundle" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" + }, + "examples": { + "create": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "evaluations": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "item_assignments": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments", + "bundle_copies": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies" + } + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateBundle", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateBundleRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "The string that you assigned to describe the resource." + }, + "Email": { + "type": "string", + "description": "The email address that will receive updates when the Bundle resource changes status." + }, + "StatusCallback": { + "type": "string", + "format": "uri", + "description": "The URL we call to inform your application of status changes." + }, + "RegulationSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RN[0-9a-fA-F]{32}$", + "description": "The unique string of a regulation that is associated to the Bundle resource." + }, + "IsoCountry": { + "type": "string", + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request." + }, + "EndUserType": { + "type": "string", + "$ref": "#/components/schemas/bundle_enum_end_user_type", + "description": "The [type of End User](https://www.twilio.com/docs/phone-numbers/regulatory/api/end-user-types) of the Bundle resource." + }, + "NumberType": { + "type": "string", + "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll free`." + } + }, + "required": [ + "FriendlyName", + "Email" + ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Email": "email", + "RegulationSid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "StatusCallback": "http://www.example.com" + } + } + } + } + } + } + }, + "get": { + "description": "Retrieve a list of all Bundles for an account.", + "tags": [ + "NumbersV2Bundle" + ], + "parameters": [ + { + "name": "Status", + "in": "query", + "description": "The verification status of the Bundle resource. Please refer to [Bundle Statuses](https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/bundle_enum_status" + }, + "examples": { + "readFull": { + "value": "draft" + }, + "readApprovedAuMobileWithDate": { + "value": "twilio-approved" + }, + "readApprovedAuMobileDateLess": { + "value": "twilio-approved" + }, + "readApprovedJapanTollfreeDateBetween": { + "value": "twilio-approved" + } + } + }, + { + "name": "FriendlyName", "in": "query", "description": "The string that you assigned to describe the resource. The column can contain 255 variable characters.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + } } }, { @@ -818,6 +2025,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -826,6 +2038,20 @@ "description": "The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "US" + }, + "readApprovedAuMobileWithDate": { + "value": "AU" + }, + "readApprovedAuMobileDateLess": { + "value": "AU" + }, + "readApprovedJapanTollfreeDateBetween": { + "value": "JP" + } } }, { @@ -834,6 +2060,20 @@ "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `tollfree`.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "mobile" + }, + "readApprovedAuMobileWithDate": { + "value": "mobile" + }, + "readApprovedAuMobileDateLess": { + "value": "mobile" + }, + "readApprovedJapanTollfreeDateBetween": { + "value": "tollfree" + } } }, { @@ -842,6 +2082,11 @@ "description": "Indicates that the Bundle is a valid Bundle until a specified expiration date.", "schema": { "type": "boolean" + }, + "examples": { + "readApprovedAuMobileWithDate": { + "value": "true" + } } }, { @@ -878,6 +2123,18 @@ "schema": { "type": "string", "format": "date-time" + }, + "x-twilio": { + "shortDescription": "Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.", + "ignoreFormat": true + }, + "examples": { + "readApprovedAuMobileDateLess": { + "value": "2022-11-29T23:59:59Z" + }, + "readApprovedJapanTollfreeDateBetween": { + "value": "2022-11-29T23:59:59Z" + } } }, { @@ -887,6 +2144,15 @@ "schema": { "type": "string", "format": "date-time" + }, + "x-twilio": { + "shortDescription": "Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.", + "ignoreFormat": true + }, + "examples": { + "readApprovedJapanTollfreeDateBetween": { + "value": "2022-01-01T00:00:00Z" + } } }, { @@ -932,16 +2198,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -950,17 +2218,163 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "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" } } } @@ -975,10 +2389,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBundle", - "x-maturity": [ - "GA" - ] + "operationId": "ListBundle" } }, "/v2/RegulatoryCompliance/Bundles/{Sid}": { @@ -987,24 +2398,47 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "regulation_sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "evaluation": "{bundle_sid: sid}", - "item_assignment": "{bundle_sid: sid}", - "bundle_copy": "{bundle_sid: sid}", - "replace_items": "{bundle_sid: sid}" + "evaluations": { + "mapping": { + "bundle_sid": "sid" + }, + "resource_url": "/v2/RegulatoryCompliance/Bundles/{bundle_sid}/Evaluations" + }, + "item_assignments": { + "mapping": { + "bundle_sid": "sid" + }, + "resource_url": "/v2/RegulatoryCompliance/Bundles/{bundle_sid}/ItemAssignments" + }, + "bundle_copies": { + "mapping": { + "bundle_sid": "sid" + }, + "resource_url": "/v2/RegulatoryCompliance/Bundles/{bundle_sid}/Copies" + }, + "replace_items": { + "mapping": { + "bundle_sid": "sid" + }, + "resource_url": "/v2/RegulatoryCompliance/Bundles/{bundle_sid}/ReplaceItems" + } }, - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "instance" }, "get": { "description": "Fetch a specific Bundle instance.", + "tags": [ + "NumbersV2Bundle" + ], "parameters": [ { "name": "Sid", @@ -1025,6 +2459,28 @@ "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" + } + } + } } } }, @@ -1036,13 +2492,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBundle", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBundle" }, "post": { "description": "Updates a Bundle in an account.", + "tags": [ + "NumbersV2Bundle" + ], "parameters": [ { "name": "Sid", @@ -1063,6 +2519,28 @@ "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" + } + } + } } } }, @@ -1075,9 +2553,6 @@ } ], "operationId": "UpdateBundle", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1104,6 +2579,16 @@ "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" + } + } } } } @@ -1111,6 +2596,9 @@ }, "delete": { "description": "Delete a specific Bundle.", + "tags": [ + "NumbersV2Bundle" + ], "parameters": [ { "name": "Sid", @@ -1135,10 +2623,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBundle", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteBundle" } }, "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies": { @@ -1147,15 +2632,18 @@ "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", + "tags": [ + "NumbersV2BundleCopy" + ], "parameters": [ { "name": "BundleSid", @@ -1176,6 +2664,22 @@ "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" + } + } } } }, @@ -1188,9 +2692,6 @@ } ], "operationId": "CreateBundleCopy", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1203,6 +2704,13 @@ "description": "The string that you assigned to describe the copied bundle." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -1210,6 +2718,9 @@ }, "get": { "description": "Retrieve a list of all Bundles Copies for a Bundle.", + "tags": [ + "NumbersV2BundleCopy" + ], "parameters": [ { "name": "BundleSid", @@ -1266,16 +2777,243 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "twilio-approved", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": "2020-07-31T01:00:00Z", + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListBundleCopy" + } + }, + "/v2/HostedNumber/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/HostedNumber/AuthorizationDocuments/{Sid}", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", + "tags": [ + "NumbersV2DependentHostedNumberOrder" + ], + "parameters": [ + { + "name": "SigningDocumentSid", + "in": "path", + "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Status", + "in": "query", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } + } + }, + { + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 128 characters.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "example" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListDependentHostedNumberOrderResponse", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/numbers.v2.authorization_document.dependent_hosted_number_order" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1284,18 +3022,73 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "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" + } + ] } } } @@ -1309,10 +3102,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBundleCopy", - "x-maturity": [ - "Beta" - ] + "operationId": "ListDependentHostedNumberOrder" } }, "/v2/RegulatoryCompliance/EndUsers": { @@ -1321,23 +3111,42 @@ "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.", + "tags": [ + "NumbersV2EndUser" + ], "responses": { "201": { "content": { "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" + } + } } } }, @@ -1350,9 +3159,6 @@ } ], "operationId": "CreateEndUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1377,6 +3183,15 @@ "FriendlyName", "Type" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "individual", + "Attributes": "{}" + } + } } } } @@ -1384,6 +3199,9 @@ }, "get": { "description": "Retrieve a list of all End User for an account.", + "tags": [ + "NumbersV2EndUser" + ], "parameters": [ { "name": "PageSize", @@ -1428,16 +3246,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1446,17 +3266,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "type": "individual", + "attributes": { + "email": "foobar@twilio.com" + }, + "date_created": "2019-07-30T21:57:45Z", + "date_updated": "2019-07-30T21:57:45Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -1471,10 +3332,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListEndUser" } }, "/v2/RegulatoryCompliance/EndUsers/{Sid}": { @@ -1483,17 +3341,20 @@ "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.", + "tags": [ + "NumbersV2EndUser" + ], "parameters": [ { "name": "Sid", @@ -1514,6 +3375,22 @@ "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" + } + } } } }, @@ -1525,13 +3402,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEndUser" }, "post": { "description": "Update an existing End User.", + "tags": [ + "NumbersV2EndUser" + ], "parameters": [ { "name": "Sid", @@ -1552,6 +3429,22 @@ "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" + } + } } } }, @@ -1564,9 +3457,6 @@ } ], "operationId": "UpdateEndUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1582,6 +3472,14 @@ "description": "The set of parameters that are the attributes of the End User resource which are derived End User Types." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Attributes": "{}" + } + } } } } @@ -1589,6 +3487,9 @@ }, "delete": { "description": "Delete a specific End User.", + "tags": [ + "NumbersV2EndUser" + ], "parameters": [ { "name": "Sid", @@ -1613,10 +3514,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteEndUser" } }, "/v2/RegulatoryCompliance/EndUserTypes": { @@ -1625,18 +3523,466 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "friendly_name" + ], + "parent": "/RegulatoryCompliance", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of all End-User Types.", + "tags": [ + "NumbersV2EndUserType" + ], + "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": "ListEndUserTypeResponse", + "properties": { + "end_user_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user_type" + } + }, + "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": { + "end_user_types": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "end_user_types" + } + } + }, + "readFull": { + "value": { + "end_user_types": [ + { + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "machine_name": "machine_name", + "fields": [ + { + "friendly_name": "Business Purpose", + "machine_name": "business_purpose", + "constraint": "String" + }, + { + "friendly_name": "Last Name", + "machine_name": "last_name", + "constraint": "String" + } + ], + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "end_user_types" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListEndUserType" + } + }, + "/v2/RegulatoryCompliance/EndUserTypes/{Sid}": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "list", - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "instance" + }, + "get": { + "description": "Fetch a specific End-User Type Instance.", + "tags": [ + "NumbersV2EndUserType" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The unique string that identifies the End-User Type resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user_type" + }, + "examples": { + "fetch": { + "value": { + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "machine_name": "machine_name", + "fields": [ + { + "friendly_name": "Business Purpose", + "machine_name": "business_purpose", + "constraint": "String" + }, + { + "friendly_name": "Last Name", + "machine_name": "last_name", + "constraint": "String" + } + ], + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchEndUserType" + } + }, + "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid" + ], + "parent": "/RegulatoryCompliance/Bundles/{Sid}", + "pathType": "list" + }, + "post": { + "description": "Creates an evaluation for a bundle", + "tags": [ + "NumbersV2Evaluation" + ], + "parameters": [ + { + "name": "BundleSid", + "in": "path", + "description": "The unique string that identifies the Bundle resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" + }, + "examples": { + "create": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateEvaluation" }, "get": { - "description": "Retrieve a list of all End-User Types.", + "description": "Retrieve a list of Evaluations associated to the Bundle resource.", + "tags": [ + "NumbersV2Evaluation" + ], "parameters": [ + { + "name": "BundleSid", + "in": "path", + "description": "The unique string that identifies the Bundle resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$" + }, + "required": true + }, { "name": "PageSize", "in": "query", @@ -1671,25 +4017,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListEndUserTypeResponse", + "title": "ListEvaluationResponse", "properties": { - "end_user_types": { + "results": { "type": "array", "items": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user_type" + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1698,17 +4046,206 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -1723,36 +4260,50 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "ListEvaluation" } }, - "/v2/RegulatoryCompliance/EndUserTypes/{Sid}": { + "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}": { "servers": [ { "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid", - "friendly_name" + "sid" ], - "pathType": "instance", - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance/Bundles/{Sid}", + "pathType": "instance" }, "get": { - "description": "Fetch a specific End-User Type Instance.", + "description": "Fetch specific Evaluation Instance.", + "tags": [ + "NumbersV2Evaluation" + ], "parameters": [ + { + "name": "BundleSid", + "in": "path", + "description": "The unique string that we created to identify the Bundle resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$" + }, + "required": true + }, { "name": "Sid", "in": "path", - "description": "The unique string that identifies the End-User Type resource.", + "description": "The unique string that identifies the Evaluation resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^EL[0-9a-fA-F]{32}$" }, "required": true } @@ -1762,7 +4313,171 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user_type" + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" + }, + "examples": { + "fetch": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + } } } }, @@ -1774,52 +4489,81 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEvaluation" } }, - "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations": { + "/v2/HostedNumber/Orders/{Sid}": { "servers": [ { "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { - "defaultOutputProperties": [ - "sid" - ], - "pathType": "list", - "parent": "/RegulatoryCompliance/Bundles/{Sid}" + "defaultOutputProperties": [], + "mountName": "hosted_number_orders", + "pathType": "instance" }, - "post": { - "description": "Creates an evaluation for a bundle", + "get": { + "description": "Fetch a specific HostedNumberOrder.", + "tags": [ + "NumbersV2HostedNumberOrder" + ], "parameters": [ { - "name": "BundleSid", + "name": "Sid", "in": "path", - "description": "The unique string that identifies the Bundle resource.", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$" + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" + "$ref": "#/components/schemas/numbers.v2.hosted_number_order" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "failure_reason": "", + "bulk_hosting_request_sid": "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" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -1827,25 +4571,134 @@ "accountSid_authToken": [] } ], - "operationId": "CreateEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchHostedNumberOrder" }, - "get": { - "description": "Retrieve a list of Evaluations associated to the Bundle resource.", + "delete": { + "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", + "tags": [ + "NumbersV2HostedNumberOrder" + ], "parameters": [ { - "name": "BundleSid", + "name": "Sid", "in": "path", - "description": "The unique string that identifies the Bundle resource.", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$" + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteHostedNumberOrder" + } + }, + "/v2/HostedNumber/Orders": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "mountName": "hosted_number_orders", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", + "tags": [ + "NumbersV2HostedNumberOrder" + ], + "parameters": [ + { + "name": "Status", + "in": "query", + "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } + } + }, + { + "name": "SmsCapability", + "in": "query", + "description": "Whether the SMS capability will be hosted on our platform. Can be `true` of `false`.", + "schema": { + "type": "boolean" + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } + } + }, + { + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" + } + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 128 characters.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "example" + } + } }, { "name": "PageSize", @@ -1881,25 +4734,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListEvaluationResponse", + "title": "ListHostedNumberOrderResponse", "properties": { - "results": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" + "$ref": "#/components/schemas/numbers.v2.hosted_number_order" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1908,89 +4763,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" } } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListEvaluation", - "x-maturity": [ - "GA" - ] - } - }, - "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}": { - "servers": [ - { - "url": "https://numbers.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid" - ], - "pathType": "instance", - "parent": "/RegulatoryCompliance/Bundles/{Sid}" - }, - "get": { - "description": "Fetch specific Evaluation Instance.", - "parameters": [ - { - "name": "BundleSid", - "in": "path", - "description": "The unique string that we created to identify the Bundle resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The unique string that identifies the Evaluation resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^EL[0-9a-fA-F]{32}$" + }, + "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" + } + ] + } + } + } + } }, - "required": true + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] } ], + "operationId": "ListHostedNumberOrder" + }, + "post": { + "description": "Host a phone number's capability on Twilio's platform.", + "tags": [ + "NumbersV2HostedNumberOrder" + ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" + "$ref": "#/components/schemas/numbers.v2.hosted_number_order" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "bulk_hosting_request_sid": "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" + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -1998,10 +4922,152 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "CreateHostedNumberOrder", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateHostedNumberOrderRequest", + "properties": { + "PhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" + }, + "ContactPhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The contact phone number of the person authorized to sign the Authorization Document." + }, + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "Email": { + "type": "string", + "description": "Optional. Email of the owner of this phone number that is being hosted." + }, + "AccountSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to." + }, + "FriendlyName": { + "type": "string", + "description": "A 128 character string that is a human readable text that describes this resource." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to." + }, + "SmsUrl": { + "type": "string", + "format": "uri", + "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsFallbackUrl": { + "type": "string", + "format": "uri", + "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsCapability": { + "type": "boolean", + "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." + }, + "SmsFallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "StatusCallbackUrl": { + "type": "string", + "format": "uri", + "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." + }, + "StatusCallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource." + }, + "SmsApplicationSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application." + }, + "ContactTitle": { + "type": "string", + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + } + }, + "required": [ + "PhoneNumber", + "ContactPhoneNumber", + "AddressSid", + "Email" + ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "AD11111111111111111111111111111111", + "PhoneNumber": "+14153608311", + "ContactPhoneNumber": "+12344444444", + "ContactTitle": "contact_title_test", + "Email": "test@twilio.com" + } + }, + "createWithoutOptionalLoaFields": { + "value": { + "PhoneNumber": "+14153608311", + "ContactPhoneNumber": "+12344444444", + "Email": "test@twilio.com", + "AddressSid": "AD11111111111111111111111111111111" + } + } + } + } + } + } } }, "/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments": { @@ -2010,16 +5076,19 @@ "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.", + "tags": [ + "NumbersV2ItemAssignment" + ], "parameters": [ { "name": "BundleSid", @@ -2040,6 +5109,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment" + }, + "examples": { + "create": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2052,9 +5133,6 @@ } ], "operationId": "CreateItemAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2073,6 +5151,13 @@ "required": [ "ObjectSid" ] + }, + "examples": { + "create": { + "value": { + "ObjectSid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2080,6 +5165,9 @@ }, "get": { "description": "Retrieve a list of all Assigned Items for an account.", + "tags": [ + "NumbersV2ItemAssignment" + ], "parameters": [ { "name": "BundleSid", @@ -2136,16 +5224,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2154,17 +5244,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -2179,10 +5306,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListItemAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListItemAssignment" } }, "/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}": { @@ -2191,16 +5315,19 @@ "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.", + "tags": [ + "NumbersV2ItemAssignment" + ], "parameters": [ { "name": "BundleSid", @@ -2233,6 +5360,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment" + }, + "examples": { + "fetch": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2244,13 +5383,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchItemAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchItemAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", + "tags": [ + "NumbersV2ItemAssignment" + ], "parameters": [ { "name": "BundleSid", @@ -2287,10 +5426,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteItemAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteItemAssignment" } }, "/v2/RegulatoryCompliance/Regulations": { @@ -2299,17 +5435,20 @@ "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.", + "tags": [ + "NumbersV2Regulation" + ], "parameters": [ { "name": "EndUserType", @@ -2318,6 +5457,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/regulation_enum_end_user_type" + }, + "examples": { + "readEmpty": { + "value": "business" + } } }, { @@ -2326,6 +5470,11 @@ "description": "The ISO country code of the phone number's country.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "US" + } } }, { @@ -2334,6 +5483,11 @@ "description": "The type of phone number that the regulatory requiremnt is restricting.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "mobile" + } } }, { @@ -2379,16 +5533,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2397,17 +5553,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" + } + } + }, + "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" } } } @@ -2422,10 +5668,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRegulation", - "x-maturity": [ - "GA" - ] + "operationId": "ListRegulation" } }, "/v2/RegulatoryCompliance/Regulations/{Sid}": { @@ -2434,17 +5677,20 @@ "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.", + "tags": [ + "NumbersV2Regulation" + ], "parameters": [ { "name": "Sid", @@ -2465,6 +5711,71 @@ "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" + } + } } } }, @@ -2476,10 +5787,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRegulation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRegulation" } }, "/v2/RegulatoryCompliance": { @@ -2488,7 +5796,7 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" @@ -2500,15 +5808,18 @@ "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)", + "tags": [ + "NumbersV2ReplaceItems" + ], "parameters": [ { "name": "BundleSid", @@ -2529,6 +5840,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.replace_items" + }, + "examples": { + "create": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "valid_until": "2015-07-30T20:00:00Z", + "email": "email", + "status_callback": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -2541,9 +5868,6 @@ } ], "operationId": "CreateReplaceItems", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2562,6 +5886,13 @@ "required": [ "FromBundleSid" ] + }, + "examples": { + "create": { + "value": { + "FromBundleSid": "BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + } } } } @@ -2574,23 +5905,46 @@ "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.", + "tags": [ + "NumbersV2SupportingDocument" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document" + }, + "examples": { + "create": { + "value": { + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "mime_type": "mime_type", + "status": "draft", + "failure_reason": null, + "type": "type", + "attributes": { + "first_name": "foo", + "last_name": "bar" + }, + "date_created": "2019-07-31T02:11:52Z", + "date_updated": "2019-07-31T02:11:52Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2603,9 +5957,6 @@ } ], "operationId": "CreateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2629,6 +5980,15 @@ "FriendlyName", "Type" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "type", + "Attributes": "{}" + } + } } } } @@ -2636,6 +5996,9 @@ }, "get": { "description": "Retrieve a list of all Supporting Document for an account.", + "tags": [ + "NumbersV2SupportingDocument" + ], "parameters": [ { "name": "PageSize", @@ -2680,16 +6043,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2698,17 +6063,93 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "mime_type": "mime_type", + "status": "draft", + "failure_reason": null, + "type": "type", + "attributes": { + "first_name": "foo", + "last_name": "bar" + }, + "date_created": "2019-07-31T02:11:52Z", + "date_updated": "2019-07-31T02:11:52Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readRejectedDocument": { + "value": { + "results": [ + { + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "mime_type": "mime_type", + "status": "twilio-rejected", + "failure_reason": "Some failure reason.", + "type": "type", + "attributes": { + "first_name": "foo", + "last_name": "bar" + }, + "date_created": "2019-07-31T02:11:52Z", + "date_updated": "2019-07-31T02:11:52Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -2723,10 +6164,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocument" } }, "/v2/RegulatoryCompliance/SupportingDocuments/{Sid}": { @@ -2735,17 +6173,20 @@ "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.", + "tags": [ + "NumbersV2SupportingDocument" + ], "parameters": [ { "name": "Sid", @@ -2766,6 +6207,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document" + }, + "examples": { + "fetch": { + "value": { + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "mime_type": "mime_type", + "status": "draft", + "failure_reason": null, + "type": "type", + "attributes": { + "first_name": "foo", + "last_name": "bar" + }, + "date_created": "2019-07-31T02:11:52Z", + "date_updated": "2019-07-31T02:11:52Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2777,13 +6238,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocument" }, "post": { "description": "Update an existing Supporting Document.", + "tags": [ + "NumbersV2SupportingDocument" + ], "parameters": [ { "name": "Sid", @@ -2804,6 +6265,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document" + }, + "examples": { + "update": { + "value": { + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "mime_type": "mime_type", + "status": "draft", + "failure_reason": null, + "type": "type", + "attributes": { + "first_name": "foo", + "last_name": "bar" + }, + "date_created": "2019-07-31T02:11:52Z", + "date_updated": "2019-07-31T02:11:52Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2816,9 +6297,6 @@ } ], "operationId": "UpdateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2834,6 +6312,14 @@ "description": "The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Attributes": "{}" + } + } } } } @@ -2841,6 +6327,9 @@ }, "delete": { "description": "Delete a specific Supporting Document.", + "tags": [ + "NumbersV2SupportingDocument" + ], "parameters": [ { "name": "Sid", @@ -2865,10 +6354,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSupportingDocument" } }, "/v2/RegulatoryCompliance/SupportingDocumentTypes": { @@ -2877,17 +6363,20 @@ "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.", + "tags": [ + "NumbersV2SupportingDocumentType" + ], "parameters": [ { "name": "PageSize", @@ -2932,16 +6421,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2950,17 +6441,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "supporting_document_types": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "supporting_document_types" + } + } + }, + "readFull": { + "value": { + "supporting_document_types": [ + { + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Passport", + "machine_name": "passport", + "fields": [ + { + "friendly_name": "Last Name", + "machine_name": "last_name", + "constraint": "String" + } + ], + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "supporting_document_types" } } } @@ -2975,10 +6508,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocumentType" } }, "/v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}": { @@ -2987,17 +6517,20 @@ "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.", + "tags": [ + "NumbersV2SupportingDocumentType" + ], "parameters": [ { "name": "Sid", @@ -3015,6 +6548,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document_type" + }, + "examples": { + "fetch": { + "value": { + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Passport", + "machine_name": "passport", + "fields": [ + { + "friendly_name": "Last Name", + "machine_name": "last_name", + "constraint": "String" + } + ], + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3026,10 +6576,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocumentType" } } }, @@ -3038,14 +6585,53 @@ "url": "https://numbers.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "NumbersV2AuthorizationDocument" + }, + { + "name": "NumbersV2BulkHostedNumberOrder" + }, + { + "name": "NumbersV2Bundle" + }, + { + "name": "NumbersV2BundleCopy" + }, + { + "name": "NumbersV2DependentHostedNumberOrder" + }, + { + "name": "NumbersV2EndUser" + }, + { + "name": "NumbersV2EndUserType" + }, + { + "name": "NumbersV2Evaluation" + }, + { + "name": "NumbersV2HostedNumberOrder" + }, + { + "name": "NumbersV2ItemAssignment" + }, + { + "name": "NumbersV2Regulation" + }, + { + "name": "NumbersV2ReplaceItems" + }, { - "name": "GA", - "description": "This product is Generally Available." + "name": "NumbersV2SupportingDocument" }, { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "name": "NumbersV2SupportingDocumentType" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_oauth_v1.json b/spec/json/twilio_oauth_v1.json deleted file mode 100644 index 4118a484..00000000 --- a/spec/json/twilio_oauth_v1.json +++ /dev/null @@ -1,545 +0,0 @@ -{ - "components": { - "schemas": { - "oauth.v1.certs": { - "type": "object", - "properties": { - "keys": { - "nullable": true, - "description": "A collection of certificates where are signed Twilio-issued tokens." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - } - }, - "oauth.v1.device_code": { - "type": "object", - "properties": { - "device_code": { - "type": "string", - "nullable": true, - "description": "The device verification code." - }, - "user_code": { - "type": "string", - "nullable": true, - "description": "The verification code which end user uses to verify authorization request." - }, - "verification_uri": { - "type": "string", - "nullable": true, - "description": "The URI that the end user visits to verify authorization request." - }, - "verification_uri_complete": { - "type": "string", - "nullable": true, - "description": "The URI with user_code that the end-user alternatively visits to verify authorization request." - }, - "expires_in": { - "type": "integer", - "format": "int64", - "nullable": true, - "description": "The expiration time of the device_code and user_code in seconds." - }, - "interval": { - "type": "integer", - "nullable": true, - "description": "The minimum amount of time in seconds that the client should wait between polling requests to the token endpoint." - } - } - }, - "oauth.v1.openid_discovery": { - "type": "object", - "properties": { - "issuer": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The URL of the party that will create the token and sign it with its private key." - }, - "authorization_endpoint": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The endpoint that validates all authorization requests." - }, - "device_authorization_endpoint": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The endpoint that validates all device code related authorization requests." - }, - "token_endpoint": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The URL of the token endpoint. After a client has received an authorization code, that code is presented to the token endpoint and exchanged for an identity token, an access token, and a refresh token." - }, - "userinfo_endpoint": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The URL of the user info endpoint, which returns user profile information to a client. Keep in mind that the user info endpoint returns only the information that has been requested." - }, - "revocation_endpoint": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The endpoint used to revoke access or refresh tokens issued by the authorization server." - }, - "jwk_uri": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The URL of your JSON Web Key Set. This set is a collection of JSON Web Keys, a standard method for representing cryptographic keys in a JSON structure." - }, - "response_type_supported": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A collection of response type supported by authorization server." - }, - "subject_type_supported": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A collection of subject by authorization server." - }, - "id_token_signing_alg_values_supported": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A collection of JWS signing algorithms supported by authorization server to sign identity token." - }, - "scopes_supported": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A collection of scopes supported by authorization server for identity token" - }, - "claims_supported": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A collection of claims supported by authorization server for identity token" - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - } - }, - "oauth.v1.token": { - "type": "object", - "properties": { - "access_token": { - "type": "string", - "nullable": true, - "description": "Token which carries the necessary information to access a Twilio resource directly." - }, - "refresh_token": { - "type": "string", - "nullable": true, - "description": "Token which carries the information necessary to get a new access token." - }, - "id_token": { - "type": "string", - "nullable": true - }, - "refresh_token_expires_at": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when the refresh token expires in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "access_token_expires_at": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when the refresh token expires in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - } - } - }, - "oauth.v1.user_info": { - "type": "object", - "properties": { - "user_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^US[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The URL of the party that will create the token and sign it with its private key." - }, - "first_name": { - "type": "string", - "nullable": true, - "description": "The first name of the end-user." - }, - "last_name": { - "type": "string", - "nullable": true, - "description": "The last name of the end-user." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "The friendly name of the end-user." - }, - "email": { - "type": "string", - "nullable": true, - "description": "The end-user's preferred email address." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - } - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } - } - }, - "info": { - "title": "Twilio - Oauth", - "description": "This is the public Twilio REST API.", - "termsOfService": "https://www.twilio.com/legal/tos", - "contact": { - "name": "Twilio Support", - "url": "https://support.twilio.com", - "email": "support@twilio.com" - }, - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "version": "1.43.2" - }, - "openapi": "3.0.1", - "paths": { - "/v1/certs": { - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "keys" - ], - "pathType": "instance", - "mountName": "oauth" - }, - "get": { - "description": "Fetches public JWKs", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/oauth.v1.certs" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchCerts", - "x-maturity": [ - "GA" - ] - } - }, - "/v1/device/code": { - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "device_code", - "user_code", - "verification_uri", - "verification_uri_complete", - "expires_in", - "interval" - ], - "pathType": "list", - "mountName": "device_code" - }, - "post": { - "description": "Issues a new Access token (optionally identity_token & refresh_token) in exchange of Oauth grant", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/oauth.v1.device_code" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeviceCode", - "x-maturity": [ - "GA" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeviceCodeRequest", - "properties": { - "ClientSid": { - "type": "string", - "description": "A 34 character string that uniquely identifies this OAuth App." - }, - "Scopes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "An Array of scopes for authorization request" - }, - "Audiences": { - "type": "array", - "items": { - "type": "string" - }, - "description": "An array of intended audiences for token requests" - } - }, - "required": [ - "ClientSid", - "Scopes" - ] - } - } - } - } - } - }, - "/v1/.well-known/openid-configuration": { - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "issuer", - "authorization_endpoint", - "device_authorization_endpoint", - "token_endpoint", - "userinfo_endpoint", - "revocation_endpoint", - "jwk_uri", - "response_type_supported", - "subject_type_supported", - "id_token_signing_alg_values_supported", - "scopes_supported", - "claims_supported" - ], - "pathType": "instance", - "mountName": "openid_discovery" - }, - "get": { - "description": "Fetch configuration details about the OpenID Connect Authorization Server", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/oauth.v1.openid_discovery" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchOpenidDiscovery", - "x-maturity": [ - "GA" - ] - } - }, - "/v1/token": { - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "access_token", - "access_token_expires_at" - ], - "pathType": "list" - }, - "post": { - "description": "Issues a new Access token (optionally identity_token & refresh_token) in exchange of Oauth grant", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/oauth.v1.token" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateToken", - "x-maturity": [ - "GA" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateTokenRequest", - "properties": { - "GrantType": { - "type": "string", - "description": "Grant type is a credential representing resource owner's authorization which can be used by client to obtain access token." - }, - "ClientSid": { - "type": "string", - "description": "A 34 character string that uniquely identifies this OAuth App." - }, - "ClientSecret": { - "type": "string", - "description": "The credential for confidential OAuth App." - }, - "Code": { - "type": "string", - "description": "JWT token related to the authorization code grant type." - }, - "CodeVerifier": { - "type": "string", - "description": "A code which is generation cryptographically." - }, - "DeviceCode": { - "type": "string", - "description": "JWT token related to the device code grant type." - }, - "RefreshToken": { - "type": "string", - "description": "JWT token related to the refresh token grant type." - }, - "DeviceId": { - "type": "string", - "description": "The Id of the device associated with the token (refresh token)." - } - }, - "required": [ - "GrantType", - "ClientSid" - ] - } - } - } - } - } - }, - "/v1/userinfo": { - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "user_sid" - ], - "pathType": "instance", - "mountName": "user_info" - }, - "get": { - "description": "Retrieves the consented UserInfo and other claims about the logged-in subject (end-user).", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/oauth.v1.user_info" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchUserInfo", - "x-maturity": [ - "GA" - ] - } - } - }, - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } - ] -} \ No newline at end of file diff --git a/spec/json/twilio_preview.json b/spec/json/twilio_preview.json index cfc0e045..4a141f90 100644 --- a/spec/json/twilio_preview.json +++ b/spec/json/twilio_preview.json @@ -1,94 +1,106 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { - "preview.deployed_devices.fleet.certificate": { + "preview.hosted_numbers.authorization_document": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$", - "nullable": true, - "description": "Contains a 34 character string that uniquely identifies this Certificate credential resource." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "Contains an absolute URL for this Certificate credential resource." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "Contains a human readable descriptive text for this Certificate credential, up to 256 characters long." - }, - "fleet_sid": { - "type": "string", + "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the unique string identifier of the Fleet that the given Certificate credential belongs to." + "description": "A 34 character string that uniquely identifies this AuthorizationDocument." }, - "account_sid": { + "address_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the unique string identifier of the Account responsible for this Certificate credential." + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." }, - "device_sid": { + "status": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", + "$ref": "#/components/schemas/authorization_document_enum_status", "nullable": true, - "description": "Specifies the unique string identifier of a Device authenticated with this Certificate credential." + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." }, - "thumbprint": { + "email": { "type": "string", "nullable": true, - "description": "Contains a unique hash of the payload of this Certificate credential, used to authenticate the Device." + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "cc_emails": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "Specifies the date this Certificate credential was created, given in UTC ISO 8601 format." + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "Specifies the date this Certificate credential was last updated, given in UTC ISO 8601 format." + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true } } }, - "preview.deployed_devices.fleet.deployment": { + "authorization_document_enum_status": { + "type": "string", + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ] + }, + "preview.hosted_numbers.authorization_document.dependent_hosted_number_order": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "nullable": true, - "description": "Contains a 34 character string that uniquely identifies this Deployment resource." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "Contains an absolute URL for this Deployment resource." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "Contains a human readable descriptive text for this Deployment, up to 64 characters long" - }, - "fleet_sid": { - "type": "string", + "pattern": "^HR[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the unique string identifier of the Fleet that the given Deployment belongs to." + "description": "A 34 character string that uniquely identifies this Authorization Document" }, "account_sid": { "type": "string", @@ -96,306 +108,194 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the unique string identifier of the Account responsible for this Deployment." + "description": "The unique SID identifier of the Account." }, - "sync_service_sid": { + "incoming_phone_number_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", + "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the unique string identifier of the Twilio Sync service instance linked to and accessible by this Deployment." + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder." }, - "date_created": { + "address_sid": { "type": "string", - "format": "date-time", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the date this Deployment was created, given in UTC ISO 8601 format." + "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "Specifies the date this Deployment was last updated, given in UTC ISO 8601 format." - } - } - }, - "preview.deployed_devices.fleet.device": { - "type": "object", - "properties": { - "sid": { + "signing_document_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", + "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, - "description": "Contains a 34 character string that uniquely identifies this Device resource." + "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder." }, - "url": { + "phone_number": { "type": "string", - "format": "uri", + "format": "phone-number", "nullable": true, - "description": "Contains an absolute URL for this Device resource." + "description": "An E164 formatted phone number hosted by this HostedNumberOrder." }, - "unique_name": { - "type": "string", + "capabilities": { + "type": "object", + "format": "phone-number-capabilities", + "properties": { + "mms": { + "type": "boolean" + }, + "sms": { + "type": "boolean" + }, + "voice": { + "type": "boolean" + }, + "fax": { + "type": "boolean" + } + }, "nullable": true, - "description": "Contains a unique and addressable name of this Device, assigned by the developer, up to 128 characters long." + "description": "A mapping of capabilities this hosted phone number will have enabled on Twilio's platform." }, "friendly_name": { "type": "string", "nullable": true, - "description": "Contains a human readable descriptive text for this Device, up to 256 characters long" - }, - "fleet_sid": { - "type": "string", - "nullable": true, - "description": "Specifies the unique string identifier of the Fleet that the given Device belongs to." - }, - "enabled": { - "type": "boolean", - "nullable": true, - "description": "Contains a boolean flag indicating whether the device is enabled or not, blocks device connectivity if set to false." + "description": "A human readable description of this resource, up to 64 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, - "account_sid": { + "unique_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the unique string identifier of the Account responsible for this Device." + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, - "identity": { + "status": { "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status", "nullable": true, - "description": "Contains an arbitrary string identifier representing a human user associated with this Device, assigned by the developer, up to 256 characters long." + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." }, - "deployment_sid": { + "failure_reason": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", "nullable": true, - "description": "Specifies the unique string identifier of the Deployment group that this Device is associated with." + "description": "A message that explains why a hosted_number_order went to status \"action-required\"" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "Specifies the date this Device was created, given in UTC ISO 8601 format." + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "Specifies the date this Device was last updated, given in UTC ISO 8601 format." + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, - "date_authenticated": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "Specifies the date this Device was last authenticated, given in UTC ISO 8601 format." - } - } - }, - "preview.deployed_devices.fleet": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", + "verification_attempts": { + "type": "integer", "nullable": true, - "description": "Contains a 34 character string that uniquely identifies this Fleet resource." + "description": "The number of attempts made to verify ownership of the phone number that is being hosted." }, - "url": { + "email": { "type": "string", - "format": "uri", "nullable": true, - "description": "Contains an absolute URL for this Fleet resource." + "description": "Email of the owner of this phone number that is being hosted.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, - "unique_name": { - "type": "string", + "cc_emails": { + "type": "array", + "items": { + "type": "string" + }, "nullable": true, - "description": "Contains a unique and addressable name of this Fleet, e.g. 'default', up to 128 characters long." + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, - "friendly_name": { + "verification_type": { "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_verification_type", "nullable": true, - "description": "Contains a human readable descriptive text for this Fleet, up to 256 characters long." + "description": "The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." }, - "account_sid": { + "verification_document_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^RI[0-9a-fA-F]{32}$", "nullable": true, - "description": "Speicifies the unique string identifier of the Account responsible for this Fleet." + "description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted." }, - "default_deployment_sid": { + "extension": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", "nullable": true, - "description": "Contains the string identifier of the automatically provisioned default Deployment of this Fleet." + "description": "A numerical extension to be used when making the ownership verification call." }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "Specifies the date this Fleet was created, given in UTC ISO 8601 format." - }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "Specifies the date this Fleet was last updated, given in UTC ISO 8601 format." - }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true, - "description": "Contains a dictionary of URL links to nested resources of this Fleet." - } - } - }, - "preview.deployed_devices.fleet.key": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$", - "nullable": true, - "description": "Contains a 34 character string that uniquely identifies this Key credential resource." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "Contains an absolute URL for this Key credential resource." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "Contains a human readable descriptive text for this Key credential, up to 256 characters long." - }, - "fleet_sid": { - "type": "string", - "nullable": true, - "description": "Specifies the unique string identifier of the Fleet that the given Key credential belongs to." - }, - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "Specifies the unique string identifier of the Account responsible for this Key credential." - }, - "device_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "nullable": true, - "description": "Specifies the unique string identifier of a Device authenticated with this Key credential." - }, - "secret": { - "type": "string", - "nullable": true, - "description": "Contains the automatically generated secret belonging to this Key credential, used to authenticate the Device." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "Specifies the date this Key credential was created, given in UTC ISO 8601 format." - }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "Specifies the date this Key credential was last updated, given in UTC ISO 8601 format." - } - } - }, - "preview.hosted_numbers.authorization_document": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this AuthorizationDocument." - }, - "address_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." - }, - "status": { - "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status", + "call_delay": { + "type": "integer", "nullable": true, - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." + "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." }, - "email": { + "verification_code": { "type": "string", "nullable": true, - "description": "Email that this AuthorizationDocument will be sent to for signing." + "description": "The digits passed during the ownership verification call." }, - "cc_emails": { + "verification_call_sids": { "type": "array", "items": { "type": "string" }, "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." - }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true + "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." } } }, - "authorization_document_enum_status": { + "dependent_hosted_number_order_enum_status": { "type": "string", "enum": [ - "opened", - "signing", - "signed", - "canceled", - "failed" + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" ] }, - "preview.hosted_numbers.authorization_document.dependent_hosted_number_order": { + "dependent_hosted_number_order_enum_verification_type": { + "type": "string", + "enum": [ + "phone-call", + "phone-bill" + ] + }, + "preview.hosted_numbers.hosted_number_order": { "type": "object", "properties": { "sid": { @@ -404,7 +304,7 @@ "maxLength": 34, "pattern": "^HR[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies this Authorization Document" + "description": "A 34 character string that uniquely identifies this HostedNumberOrder." }, "account_sid": { "type": "string", @@ -412,7 +312,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID identifier of the Account." + "description": "A 34 character string that uniquely identifies the account." }, "incoming_phone_number_sid": { "type": "string", @@ -420,7 +320,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder." + "description": "A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the phone number being hosted." }, "address_sid": { "type": "string", @@ -436,13 +336,13 @@ "maxLength": 34, "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder." + "description": "A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) the user needs to sign." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "An E164 formatted phone number hosted by this HostedNumberOrder." + "description": "Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212" }, "capabilities": { "type": "object", @@ -462,23 +362,35 @@ } }, "nullable": true, - "description": "A mapping of capabilities this hosted phone number will have enabled on Twilio's platform." + "description": "Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this resource, up to 64 characters." + "description": "A 64 character string that is a human-readable text that describes this resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status": { "type": "string", - "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status", + "$ref": "#/components/schemas/hosted_number_order_enum_status", "nullable": true, - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." + "description": "Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values) section for more information on each of these statuses." }, "failure_reason": { "type": "string", @@ -505,7 +417,13 @@ "email": { "type": "string", "nullable": true, - "description": "Email of the owner of this phone number that is being hosted." + "description": "Email of the owner of this phone number that is being hosted.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "cc_emails": { "type": "array", @@ -513,13 +431,25 @@ "type": "string" }, "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" + "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this HostedNumberOrder." }, "verification_type": { "type": "string", - "$ref": "#/components/schemas/dependent_hosted_number_order_enum_verification_type", + "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", "nullable": true, - "description": "The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + "description": "The type of ownership verification required to move the number to a `verified` state. The verification methods are `phone-call` or `phone-bill`." }, "verification_document_sid": { "type": "string", @@ -542,7 +472,7 @@ "verification_code": { "type": "string", "nullable": true, - "description": "The digits passed during the ownership verification call." + "description": "A verification code provided in the response for a user to enter when they pick up the phone call." }, "verification_call_sids": { "type": "array", @@ -554,7 +484,7 @@ } } }, - "dependent_hosted_number_order_enum_status": { + "hosted_number_order_enum_status": { "type": "string", "enum": [ "received", @@ -568,266 +498,80 @@ "action-required" ] }, - "dependent_hosted_number_order_enum_verification_type": { + "hosted_number_order_enum_verification_type": { "type": "string", "enum": [ "phone-call", "phone-bill" ] }, - "preview.hosted_numbers.hosted_number_order": { + "preview.marketplace.available_add_on": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$", + "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies this HostedNumberOrder." + "description": "The unique string that we created to identify the AvailableAddOn resource." }, - "account_sid": { + "friendly_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the account." + "description": "The string that you assigned to describe the resource." }, - "incoming_phone_number_sid": { + "description": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/api/rest/incoming-phone-numbers) resource that represents the phone number being hosted." + "description": "A short description of the Add-on's functionality." }, - "address_sid": { + "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." + } + } + }, + "preview.marketplace.available_add_on.available_add_on_extension": { + "type": "object", + "properties": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", + "pattern": "^XF[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + "description": "The unique string that we created to identify the AvailableAddOnExtension resource." }, - "signing_document_sid": { + "available_add_on_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", + "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents) the user needs to sign." + "description": "The SID of the AvailableAddOn resource to which this extension applies." }, - "phone_number": { + "friendly_name": { "type": "string", - "format": "phone-number", "nullable": true, - "description": "Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212" - }, - "capabilities": { - "type": "object", - "format": "phone-number-capabilities", - "properties": { - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - }, - "fax": { - "type": "boolean" - } - }, - "nullable": true, - "description": "Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "A 64 character string that is a human-readable text that describes this resource." - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." - }, - "status": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_status", - "nullable": true, - "description": "Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-numbers#status-values) section for more information on each of these statuses." - }, - "failure_reason": { - "type": "string", - "nullable": true, - "description": "A message that explains why a hosted_number_order went to status \"action-required\"" - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." - }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." - }, - "verification_attempts": { - "type": "integer", - "nullable": true, - "description": "The number of attempts made to verify ownership of the phone number that is being hosted." - }, - "email": { - "type": "string", - "nullable": true, - "description": "Email of the owner of this phone number that is being hosted." - }, - "cc_emails": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The URL of this HostedNumberOrder." - }, - "verification_type": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", - "nullable": true, - "description": "The type of ownership verification required to move the number to a `verified` state. The verification methods are `phone-call` or `phone-bill`." - }, - "verification_document_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted." - }, - "extension": { - "type": "string", - "nullable": true, - "description": "A numerical extension to be used when making the ownership verification call." - }, - "call_delay": { - "type": "integer", - "nullable": true, - "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." - }, - "verification_code": { - "type": "string", - "nullable": true, - "description": "A verification code provided in the response for a user to enter when they pick up the phone call." - }, - "verification_call_sids": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." - } - } - }, - "hosted_number_order_enum_status": { - "type": "string", - "enum": [ - "received", - "pending-verification", - "verified", - "pending-loa", - "carrier-processing", - "testing", - "completed", - "failed", - "action-required" - ] - }, - "hosted_number_order_enum_verification_type": { - "type": "string", - "enum": [ - "phone-call", - "phone-bill" - ] - }, - "preview.marketplace.available_add_on": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the AvailableAddOn resource." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "The string that you assigned to describe the resource." - }, - "description": { - "type": "string", - "nullable": true, - "description": "A short description of the Add-on's functionality." - }, - "pricing_type": { - "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." - } - } - }, - "preview.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." + "description": "The string that you assigned to describe the resource." }, "product_name": { "type": "string", @@ -958,49 +702,51 @@ } } }, - "preview.sync.service.document": { + "preview.wireless.command": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^ET[0-9a-fA-F]{32}$", + "pattern": "^DC[0-9a-fA-F]{32}$", "nullable": true }, - "unique_name": { + "account_sid": { "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "account_sid": { + "device_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true }, - "service_sid": { + "sim_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", + "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true }, - "url": { + "command": { "type": "string", - "format": "uri", "nullable": true }, - "links": { - "type": "object", - "format": "uri-map", + "command_mode": { + "type": "string", "nullable": true }, - "revision": { + "status": { "type": "string", "nullable": true }, - "data": { + "direction": { + "type": "string", "nullable": true }, "date_created": { @@ -1013,86 +759,67 @@ "format": "date-time", "nullable": true }, - "created_by": { + "url": { "type": "string", + "format": "uri", "nullable": true } } }, - "preview.sync.service.document.document_permission": { + "preview.wireless.rate_plan": { "type": "object", "properties": { - "account_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique SID identifier of the Twilio Account." + "pattern": "^WP[0-9a-fA-F]{32}$", + "nullable": true }, - "service_sid": { + "unique_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique SID identifier of the Sync Service Instance." + "nullable": true }, - "document_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^ET[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique SID identifier of the Sync Document to which the Permission applies." + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true }, - "identity": { + "friendly_name": { "type": "string", - "nullable": true, - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." + "nullable": true }, - "read": { + "data_enabled": { "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can read the Sync Document." + "nullable": true }, - "write": { - "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can update the Sync Document." + "data_metering": { + "type": "string", + "nullable": true }, - "manage": { + "data_limit": { + "type": "integer", + "nullable": true + }, + "messaging_enabled": { "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can delete the Sync Document." + "nullable": true }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "Contains an absolute URL for this Sync Document Permission." - } - } - }, - "preview.sync.service": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", + "voice_enabled": { + "type": "boolean", "nullable": true }, - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "national_roaming_enabled": { + "type": "boolean", "nullable": true }, - "friendly_name": { - "type": "string", + "international_roaming": { + "type": "array", + "items": { + "type": "string" + }, "nullable": true }, "date_created": { @@ -1109,35 +836,17 @@ "type": "string", "format": "uri", "nullable": true - }, - "webhook_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "reachability_webhooks_enabled": { - "type": "boolean", - "nullable": true - }, - "acl_enabled": { - "type": "boolean", - "nullable": true - }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true } } }, - "preview.sync.service.sync_list": { + "preview.wireless.sim": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", + "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true }, "unique_name": { @@ -1151,81 +860,108 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "service_sid": { + "rate_plan_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", + "pattern": "^WP[0-9a-fA-F]{32}$", "nullable": true }, - "url": { + "friendly_name": { "type": "string", - "format": "uri", "nullable": true }, - "links": { - "type": "object", - "format": "uri-map", + "iccid": { + "type": "string", "nullable": true }, - "revision": { + "e_id": { "type": "string", "nullable": true }, - "date_created": { + "status": { "type": "string", - "format": "date-time", "nullable": true }, - "date_updated": { + "commands_callback_url": { "type": "string", - "format": "date-time", + "format": "uri", "nullable": true }, - "created_by": { + "commands_callback_method": { "type": "string", "nullable": true - } - } - }, - "preview.sync.service.sync_list.sync_list_item": { - "type": "object", - "properties": { - "index": { - "type": "integer", + }, + "sms_fallback_method": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], "nullable": true }, - "account_sid": { + "sms_fallback_url": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "format": "uri", "nullable": true }, - "service_sid": { + "sms_method": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], "nullable": true }, - "list_sid": { + "sms_url": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", + "format": "uri", "nullable": true }, - "url": { + "voice_fallback_method": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "nullable": true + }, + "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true }, - "revision": { + "voice_method": { "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], "nullable": true }, - "data": { + "voice_url": { + "type": "string", + "format": "uri", "nullable": true }, "date_created": { @@ -1238,559 +974,445 @@ "format": "date-time", "nullable": true }, - "created_by": { + "url": { "type": "string", + "format": "uri", + "nullable": true + }, + "links": { + "type": "object", + "format": "uri-map", "nullable": true } } }, - "sync_list_item_enum_query_result_order": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - }, - "sync_list_item_enum_query_from_bound_type": { - "type": "string", - "enum": [ - "inclusive", - "exclusive" - ] - }, - "preview.sync.service.sync_list.sync_list_permission": { + "preview.wireless.sim.usage": { "type": "object", "properties": { - "account_sid": { + "sim_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique SID identifier of the Twilio Account." + "pattern": "^DE[0-9a-fA-F]{32}$", + "nullable": true }, - "service_sid": { + "sim_unique_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique SID identifier of the Sync Service Instance." + "nullable": true }, - "list_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique SID identifier of the Sync List to which the Permission applies." + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true }, - "identity": { - "type": "string", - "nullable": true, - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." + "period": { + "nullable": true }, - "read": { - "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can read the Sync List and its Items." + "commands_usage": { + "nullable": true }, - "write": { - "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." + "commands_costs": { + "nullable": true }, - "manage": { - "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can delete the Sync List." + "data_usage": { + "nullable": true + }, + "data_costs": { + "nullable": true }, "url": { "type": "string", "format": "uri", - "nullable": true, - "description": "Contains an absolute URL for this Sync List Permission." + "nullable": true } } }, - "preview.sync.service.sync_map": { + "preview.deployed_devices.fleet.certificate": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^MP[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^CY[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Contains a 34 character string that uniquely identifies this Certificate credential resource." }, - "unique_name": { + "url": { "type": "string", - "nullable": true + "format": "uri", + "nullable": true, + "description": "Contains an absolute URL for this Certificate credential resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "Contains a human readable descriptive text for this Certificate credential, up to 256 characters long." + }, + "fleet_sid": { + "type": "string", + "nullable": true, + "description": "Specifies the unique string identifier of the Fleet that the given Certificate credential belongs to." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "Specifies the unique string identifier of the Account responsible for this Certificate credential." }, - "service_sid": { + "device_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true + "pattern": "^TH[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Specifies the unique string identifier of a Device authenticated with this Certificate credential." }, - "revision": { + "thumbprint": { "type": "string", - "nullable": true + "nullable": true, + "description": "Contains a unique hash of the payload of this Certificate credential, used to authenticate the Device." }, "date_created": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "Specifies the date this Certificate credential was created, given in UTC ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", - "nullable": true - }, - "created_by": { - "type": "string", - "nullable": true + "nullable": true, + "description": "Specifies the date this Certificate credential was last updated, given in UTC ISO 8601 format." } } }, - "preview.sync.service.sync_map.sync_map_item": { + "preview.deployed_devices.fleet.deployment": { "type": "object", "properties": { - "key": { - "type": "string", - "nullable": true - }, - "account_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^DL[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Contains a 34 character string that uniquely identifies this Deployment resource." }, - "service_sid": { + "url": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "nullable": true + "format": "uri", + "nullable": true, + "description": "Contains an absolute URL for this Deployment resource." }, - "map_sid": { + "friendly_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^MP[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "Contains a human readable descriptive text for this Deployment, up to 64 characters long" }, - "url": { + "fleet_sid": { "type": "string", - "format": "uri", - "nullable": true + "nullable": true, + "description": "Specifies the unique string identifier of the Fleet that the given Deployment belongs to." }, - "revision": { + "account_sid": { "type": "string", - "nullable": true + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Specifies the unique string identifier of the Account responsible for this Deployment." }, - "data": { - "nullable": true + "sync_service_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Specifies the unique string identifier of the Twilio Sync service instance linked to and accessible by this Deployment." }, "date_created": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "Specifies the date this Deployment was created, given in UTC ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", - "nullable": true - }, - "created_by": { - "type": "string", - "nullable": true + "nullable": true, + "description": "Specifies the date this Deployment was last updated, given in UTC ISO 8601 format." } } }, - "sync_map_item_enum_query_result_order": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - }, - "sync_map_item_enum_query_from_bound_type": { - "type": "string", - "enum": [ - "inclusive", - "exclusive" - ] - }, - "preview.sync.service.sync_map.sync_map_permission": { + "preview.deployed_devices.fleet.device": { "type": "object", "properties": { - "account_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID identifier of the Twilio Account." + "description": "Contains a 34 character string that uniquely identifies this Device resource." }, - "service_sid": { + "url": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", + "format": "uri", "nullable": true, - "description": "The unique SID identifier of the Sync Service Instance." + "description": "Contains an absolute URL for this Device resource." }, - "map_sid": { + "unique_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID identifier of the Sync Map to which the Permission applies." + "description": "Contains a unique and addressable name of this Device, assigned by the developer, up to 128 characters long." }, - "identity": { + "friendly_name": { "type": "string", "nullable": true, - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." + "description": "Contains a human readable descriptive text for this Device, up to 256 characters long" }, - "read": { - "type": "boolean", + "fleet_sid": { + "type": "string", "nullable": true, - "description": "Boolean flag specifying whether the identity can read the Sync Map and its Items." + "description": "Specifies the unique string identifier of the Fleet that the given Device belongs to." }, - "write": { + "enabled": { "type": "boolean", "nullable": true, - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." + "description": "Contains a boolean flag indicating whether the device is enabled or not, blocks device connectivity if set to false." }, - "manage": { - "type": "boolean", + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Boolean flag specifying whether the identity can delete the Sync Map." + "description": "Specifies the unique string identifier of the Account responsible for this Device." }, - "url": { + "identity": { "type": "string", - "format": "uri", "nullable": true, - "description": "Contains an absolute URL for this Sync Map Permission." - } - } - }, - "preview.understand.assistant": { - "type": "object", - "properties": { - "account_sid": { + "description": "Contains an arbitrary string identifier representing a human user associated with this Device, assigned by the developer, up to 256 characters long." + }, + "deployment_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^DL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account that created this Assistant." + "description": "Specifies the unique string identifier of the Deployment group that this Device is associated with." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this resource was created" + "description": "Specifies the date this Device was created, given in UTC ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this resource was last updated" - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long." + "description": "Specifies the date this Device was last updated, given in UTC ISO 8601 format." }, - "latest_model_build_sid": { + "date_authenticated": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID (Sid) of the latest model build. Null if no model has been built." - }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true - }, - "log_queries": { - "type": "boolean", + "format": "date-time", "nullable": true, - "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter." - }, + "description": "Specifies the date this Device was last authenticated, given in UTC ISO 8601 format." + } + } + }, + "preview.deployed_devices.fleet": { + "type": "object", + "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." - }, - "unique_name": { - "type": "string", + "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. You can use the unique name in the URL path. Unique up to 64 characters long." + "description": "Contains a 34 character string that uniquely identifies this Fleet resource." }, "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "Contains an absolute URL for this Fleet resource." }, - "callback_url": { + "unique_name": { "type": "string", - "format": "uri", "nullable": true, - "description": "A user-provided URL to send event callbacks to." + "description": "Contains a unique and addressable name of this Fleet, e.g. 'default', up to 128 characters long." }, - "callback_events": { + "friendly_name": { "type": "string", "nullable": true, - "description": "Space-separated list of callback events that will trigger callbacks." - } - } - }, - "preview.understand.assistant.assistant_fallback_actions": { - "type": "object", - "properties": { + "description": "Contains a human readable descriptive text for this Fleet, up to 256 characters long." + }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "Speicifies the unique string identifier of the Account responsible for this Fleet." }, - "assistant_sid": { + "default_deployment_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^DL[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Contains the string identifier of the automatically provisioned default Deployment of this Fleet." }, - "url": { + "date_created": { "type": "string", - "format": "uri", - "nullable": true + "format": "date-time", + "nullable": true, + "description": "Specifies the date this Fleet was created, given in UTC ISO 8601 format." }, - "data": { - "nullable": true - } - } - }, - "preview.understand.assistant.assistant_initiation_actions": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true - }, - "url": { + "date_updated": { "type": "string", - "format": "uri", - "nullable": true + "format": "date-time", + "nullable": true, + "description": "Specifies the date this Fleet was last updated, given in UTC ISO 8601 format." }, - "data": { - "nullable": true + "links": { + "type": "object", + "format": "uri-map", + "nullable": true, + "description": "Contains a dictionary of URL links to nested resources of this Fleet." } } }, - "preview.understand.assistant.dialogue": { + "preview.deployed_devices.fleet.key": { "type": "object", "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Field." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the parent Assistant." - }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UK[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Dialogue" - }, - "data": { + "pattern": "^KY[0-9a-fA-F]{32}$", "nullable": true, - "description": "The dialogue memory object as json" + "description": "Contains a 34 character string that uniquely identifies this Key credential resource." }, "url": { "type": "string", "format": "uri", - "nullable": true - } - } - }, - "preview.understand.assistant.task.field": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Field." - }, - "date_created": { - "type": "string", - "format": "date-time", "nullable": true, - "description": "The date that this resource was created" + "description": "Contains an absolute URL for this Key credential resource." }, - "date_updated": { + "friendly_name": { "type": "string", - "format": "date-time", "nullable": true, - "description": "The date that this resource was last updated" + "description": "Contains a human readable descriptive text for this Key credential, up to 256 characters long." }, - "field_type": { + "fleet_sid": { "type": "string", "nullable": true, - "description": "The Field Type of this field. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or sid of a custom Field Type." + "description": "Specifies the unique string identifier of the Fleet that the given Key credential belongs to." }, - "task_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Task associated with this Field." + "description": "Specifies the unique string identifier of the Account responsible for this Key credential." }, - "assistant_sid": { + "device_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", + "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the parent Assistant." + "description": "Specifies the unique string identifier of a Device authenticated with this Key credential." }, - "sid": { + "secret": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UE[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." + "description": "Contains the automatically generated secret belonging to this Key credential, used to authenticate the Device." }, - "unique_name": { + "date_created": { "type": "string", + "format": "date-time", "nullable": true, - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "description": "Specifies the date this Key credential was created, given in UTC ISO 8601 format." }, - "url": { + "date_updated": { "type": "string", - "format": "uri", - "nullable": true + "format": "date-time", + "nullable": true, + "description": "Specifies the date this Key credential was last updated, given in UTC ISO 8601 format." } } }, - "preview.understand.assistant.field_type": { + "preview.sync.service.document": { "type": "object", "properties": { - "account_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Field Type." + "pattern": "^ET[0-9a-fA-F]{32}$", + "nullable": true }, - "date_created": { + "unique_name": { "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was created" + "nullable": true }, - "date_updated": { + "account_sid": { "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was last updated" + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true }, - "friendly_name": { + "service_sid": { "type": "string", - "nullable": true, - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true }, - "assistant_sid": { + "revision": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Assistant." + "nullable": true }, - "sid": { + "data": { + "nullable": true + }, + "date_created": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UB[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." + "format": "date-time", + "nullable": true }, - "unique_name": { + "date_updated": { "type": "string", - "nullable": true, - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "format": "date-time", + "nullable": true }, - "url": { + "created_by": { "type": "string", - "format": "uri", "nullable": true } } }, - "preview.understand.assistant.field_type.field_value": { + "preview.sync.service.document.document_permission": { "type": "object", "properties": { "account_sid": { @@ -1799,398 +1421,237 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account that created this Field Value." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was created" + "description": "The unique SID identifier of the Twilio Account." }, - "date_updated": { + "service_sid": { "type": "string", - "format": "date-time", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The date that this resource was last updated" + "description": "The unique SID identifier of the Sync Service Instance." }, - "field_type_sid": { + "document_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UB[0-9a-fA-F]{32}$", + "pattern": "^ET[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Field Type associated with this Field Value." + "description": "The unique SID identifier of the Sync Document to which the Permission applies." }, - "language": { + "identity": { "type": "string", "nullable": true, - "description": "An ISO language-country string of the value." + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", + "read": { + "type": "boolean", "nullable": true, - "description": "The unique ID of the Assistant." + "description": "Boolean flag specifying whether the identity can read the Sync Document." }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UC[0-9a-fA-F]{32}$", + "write": { + "type": "boolean", "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." + "description": "Boolean flag specifying whether the identity can update the Sync Document." }, - "value": { - "type": "string", + "manage": { + "type": "boolean", "nullable": true, - "description": "The Field Value itself." + "description": "Boolean flag specifying whether the identity can delete the Sync Document." }, "url": { "type": "string", "format": "uri", - "nullable": true - }, - "synonym_of": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UC[0-9a-fA-F]{32}$", "nullable": true, - "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym." + "description": "Contains an absolute URL for this Sync Document Permission." } } }, - "preview.understand.assistant.model_build": { + "preview.sync.service": { "type": "object", "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "nullable": true + }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Model Build." + "nullable": true + }, + "friendly_name": { + "type": "string", + "nullable": true }, "date_created": { "type": "string", "format": "date-time", - "nullable": true, - "description": "The date that this resource was created" + "nullable": true }, "date_updated": { "type": "string", "format": "date-time", - "nullable": true, - "description": "The date that this resource was last updated" - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the parent Assistant." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." - }, - "status": { - "type": "string", - "$ref": "#/components/schemas/model_build_enum_status", - "nullable": true, - "description": "A string that described the model build status. The values can be: enqueued, building, completed, failed" + "nullable": true }, - "unique_name": { + "url": { "type": "string", - "nullable": true, - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "format": "uri", + "nullable": true }, - "url": { + "webhook_url": { "type": "string", "format": "uri", "nullable": true }, - "build_duration": { - "type": "integer", - "nullable": true, - "description": "The time in seconds it took to build the model." + "reachability_webhooks_enabled": { + "type": "boolean", + "nullable": true }, - "error_code": { - "type": "integer", + "acl_enabled": { + "type": "boolean", + "nullable": true + }, + "links": { + "type": "object", + "format": "uri-map", "nullable": true } } }, - "model_build_enum_status": { - "type": "string", - "enum": [ - "enqueued", - "building", - "completed", - "failed", - "canceled" - ] - }, - "preview.understand.assistant.query": { + "preview.sync.service.sync_list": { "type": "object", "properties": { - "account_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Query." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was created" - }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was last updated" - }, - "results": { - "nullable": true, - "description": "The natural language analysis results which include the Task recognized, the confidence score and a list of identified Fields." - }, - "language": { - "type": "string", - "nullable": true, - "description": "An ISO language-country string of the sample." - }, - "model_build_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Model Build queried." - }, - "query": { - "type": "string", - "nullable": true, - "description": "The end-user's natural language input." + "pattern": "^ES[0-9a-fA-F]{32}$", + "nullable": true }, - "sample_sid": { + "unique_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "nullable": true, - "description": "An optional reference to the Sample created from this query." + "nullable": true }, - "assistant_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the parent Assistant." + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true }, - "sid": { + "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UH[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." - }, - "status": { - "type": "string", - "nullable": true, - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded" + "pattern": "^IS[0-9a-fA-F]{32}$", + "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, - "source_channel": { - "type": "string", - "nullable": true, - "description": "The communication channel where this end-user input came from" - } - } - }, - "preview.understand.assistant.task.sample": { - "type": "object", - "properties": { - "account_sid": { + "links": { + "type": "object", + "format": "uri-map", + "nullable": true + }, + "revision": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Sample." + "nullable": true }, "date_created": { "type": "string", "format": "date-time", - "nullable": true, - "description": "The date that this resource was created" + "nullable": true }, "date_updated": { "type": "string", "format": "date-time", - "nullable": true, - "description": "The date that this resource was last updated" - }, - "task_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Task associated with this Sample." - }, - "language": { - "type": "string", - "nullable": true, - "description": "An ISO language-country string of the sample." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Assistant." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." - }, - "tagged_text": { - "type": "string", - "nullable": true, - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." - }, - "url": { - "type": "string", - "format": "uri", "nullable": true }, - "source_channel": { + "created_by": { "type": "string", - "nullable": true, - "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null" + "nullable": true } } }, - "preview.understand.assistant.style_sheet": { + "preview.sync.service.sync_list.sync_list_item": { "type": "object", "properties": { + "index": { + "type": "integer", + "nullable": true + }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Assistant" + "nullable": true }, - "assistant_sid": { + "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Assistant" + "pattern": "^IS[0-9a-fA-F]{32}$", + "nullable": true + }, + "list_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^ES[0-9a-fA-F]{32}$", + "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, - "data": { - "nullable": true, - "description": "The JSON style sheet object" - } - } - }, - "preview.understand.assistant.task": { - "type": "object", - "properties": { - "account_sid": { + "revision": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Task." + "nullable": true + }, + "data": { + "nullable": true }, "date_created": { "type": "string", "format": "date-time", - "nullable": true, - "description": "The date that this resource was created" + "nullable": true }, "date_updated": { "type": "string", "format": "date-time", - "nullable": true, - "description": "The date that this resource was last updated" - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." - }, - "links": { - "type": "object", - "format": "uri-map", "nullable": true }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Assistant." - }, - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - }, - "actions_url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "User-provided HTTP endpoint where from the assistant fetches actions" - }, - "url": { + "created_by": { "type": "string", - "format": "uri", "nullable": true } } }, - "preview.understand.assistant.task.task_actions": { + "sync_list_item_enum_query_result_order": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "sync_list_item_enum_query_from_bound_type": { + "type": "string", + "enum": [ + "inclusive", + "exclusive" + ] + }, + "preview.sync.service.sync_list.sync_list_permission": { "type": "object", "properties": { "account_sid": { @@ -2199,122 +1660,91 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account that created this Field." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the parent Assistant." + "description": "The unique SID identifier of the Twilio Account." }, - "task_sid": { + "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Task." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true + "description": "The unique SID identifier of the Sync Service Instance." }, - "data": { - "nullable": true - } - } - }, - "preview.understand.assistant.task.task_statistics": { - "type": "object", - "properties": { - "account_sid": { + "list_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account that created this Field." + "description": "The unique SID identifier of the Sync List to which the Permission applies." }, - "assistant_sid": { + "identity": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the parent Assistant." + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." }, - "task_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UD[0-9a-fA-F]{32}$", + "read": { + "type": "boolean", "nullable": true, - "description": "The unique ID of the Task associated with this Field." + "description": "Boolean flag specifying whether the identity can read the Sync List and its Items." }, - "samples_count": { - "type": "integer", + "write": { + "type": "boolean", "nullable": true, - "description": "The total number of Samples associated with this Task." + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." }, - "fields_count": { - "type": "integer", + "manage": { + "type": "boolean", "nullable": true, - "description": "The total number of Fields associated with this Task." + "description": "Boolean flag specifying whether the identity can delete the Sync List." }, "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "Contains an absolute URL for this Sync List Permission." } } }, - "preview.wireless.command": { + "preview.sync.service.sync_map": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DC[0-9a-fA-F]{32}$", + "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true }, - "account_sid": { + "unique_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "device_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "sim_sid": { + "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "nullable": true - }, - "command": { - "type": "string", + "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, - "command_mode": { + "url": { "type": "string", + "format": "uri", "nullable": true }, - "status": { - "type": "string", + "links": { + "type": "object", + "format": "uri-map", "nullable": true }, - "direction": { + "revision": { "type": "string", "nullable": true }, @@ -2328,24 +1758,16 @@ "format": "date-time", "nullable": true }, - "url": { + "created_by": { "type": "string", - "format": "uri", "nullable": true } } }, - "preview.wireless.rate_plan": { + "preview.sync.service.sync_map.sync_map_item": { "type": "object", "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WP[0-9a-fA-F]{32}$", - "nullable": true - }, - "unique_name": { + "key": { "type": "string", "nullable": true }, @@ -2356,181 +1778,30 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "friendly_name": { - "type": "string", - "nullable": true - }, - "data_enabled": { - "type": "boolean", - "nullable": true - }, - "data_metering": { - "type": "string", - "nullable": true - }, - "data_limit": { - "type": "integer", - "nullable": true - }, - "messaging_enabled": { - "type": "boolean", - "nullable": true - }, - "voice_enabled": { - "type": "boolean", - "nullable": true - }, - "national_roaming_enabled": { - "type": "boolean", - "nullable": true - }, - "international_roaming": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - } - }, - "preview.wireless.sim": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "nullable": true - }, - "unique_name": { - "type": "string", - "nullable": true - }, - "account_sid": { + "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, - "rate_plan_sid": { + "map_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^WP[0-9a-fA-F]{32}$", - "nullable": true - }, - "friendly_name": { - "type": "string", - "nullable": true - }, - "iccid": { - "type": "string", - "nullable": true - }, - "e_id": { - "type": "string", - "nullable": true - }, - "status": { - "type": "string", - "nullable": true - }, - "commands_callback_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "commands_callback_method": { - "type": "string", - "nullable": true - }, - "sms_fallback_method": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true - }, - "sms_fallback_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "sms_method": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true - }, - "sms_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "voice_fallback_method": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true }, - "voice_fallback_url": { + "url": { "type": "string", "format": "uri", "nullable": true }, - "voice_method": { + "revision": { "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], "nullable": true }, - "voice_url": { - "type": "string", - "format": "uri", + "data": { "nullable": true }, "date_created": { @@ -2543,67 +1814,81 @@ "format": "date-time", "nullable": true }, - "url": { + "created_by": { "type": "string", - "format": "uri", - "nullable": true - }, - "links": { - "type": "object", - "format": "uri-map", "nullable": true } } }, - "preview.wireless.sim.usage": { + "sync_map_item_enum_query_result_order": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "sync_map_item_enum_query_from_bound_type": { + "type": "string", + "enum": [ + "inclusive", + "exclusive" + ] + }, + "preview.sync.service.sync_map.sync_map_permission": { "type": "object", "properties": { - "sim_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique SID identifier of the Twilio Account." }, - "sim_unique_name": { + "service_sid": { "type": "string", - "nullable": true + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique SID identifier of the Sync Service Instance." }, - "account_sid": { + "map_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true - }, - "period": { - "nullable": true + "pattern": "^MP[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique SID identifier of the Sync Map to which the Permission applies." }, - "commands_usage": { - "nullable": true + "identity": { + "type": "string", + "nullable": true, + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." }, - "commands_costs": { - "nullable": true + "read": { + "type": "boolean", + "nullable": true, + "description": "Boolean flag specifying whether the identity can read the Sync Map and its Items." }, - "data_usage": { - "nullable": true + "write": { + "type": "boolean", + "nullable": true, + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." }, - "data_costs": { - "nullable": true + "manage": { + "type": "boolean", + "nullable": true, + "description": "Boolean flag specifying whether the identity can delete the Sync Map." }, "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "Contains an absolute URL for this Sync Map Permission." } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -2619,43 +1904,44 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { - "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { + "/HostedNumbers/AuthorizationDocuments/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Fleets/{Sid}" + "dependentProperties": { + "dependent_hosted_number_orders": { + "mapping": { + "signing_document_sid": "sid" + }, + "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" + } + }, + "pathType": "instance" }, "get": { - "description": "Fetch information about a specific Certificate credential in the Fleet.", + "description": "Fetch a specific AuthorizationDocument.", + "tags": [ + "PreviewHostedNumbersAuthorizationDocument" + ], "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" + "pattern": "^PX[0-9a-fA-F]{32}$" }, "required": true } @@ -2665,7 +1951,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + "$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" + } + } } } }, @@ -2677,72 +1983,23 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchHostedNumbersAuthorizationDocument" }, "post": { - "description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.", + "description": "Updates a specific AuthorizationDocument.", + "tags": [ + "PreviewHostedNumbersAuthorizationDocument" + ], "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" + "pattern": "^PX[0-9a-fA-F]{32}$" }, "required": true } @@ -2752,7 +2009,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + "$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" + } + } } } }, @@ -2764,27 +2041,70 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateHostedNumbersAuthorizationDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateDeployedDevicesCertificateRequest", + "title": "UpdateHostedNumbersAuthorizationDocumentRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." + "HostedNumberOrderSids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." }, - "DeviceSid": { + "AddressSid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." + }, + "Email": { + "type": "string", + "description": "Email that this AuthorizationDocument will be sent to for signing." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" + }, + "Status": { + "type": "string", + "$ref": "#/components/schemas/authorization_document_enum_status", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." + }, + "ContactTitle": { + "type": "string", + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + }, + "ContactPhoneNumber": { + "type": "string", + "description": "The contact phone number of the person authorized to sign the Authorization Document." + } + } + }, + "examples": { + "update": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "HostedNumberOrderSids": [ + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + ], + "Status": "signing", + "ContactTitle": "Mr.", + "ContactPhoneNumber": "+14155555555" } } } @@ -2793,104 +2113,62 @@ } } }, - "/DeployedDevices/Fleets/{FleetSid}/Certificates": { + "/HostedNumbers/AuthorizationDocuments": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Fleets/{Sid}" - }, - "post": { - "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" - } - } + "dependentProperties": { + "dependent_hosted_number_orders": { + "mapping": { + "signing_document_sid": "sid" }, - "description": "Created" + "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesCertificateRequest", - "properties": { - "CertificateData": { - "type": "string", - "description": "Provides a URL encoded representation of the public certificate in PEM format." - }, - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." - }, - "DeviceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." - } - }, - "required": [ - "CertificateData" - ] - } - } - } - } + "pathType": "list" }, "get": { - "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", + "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", + "tags": [ + "PreviewHostedNumbersAuthorizationDocument" + ], "parameters": [ { - "name": "FleetSid", - "in": "path", - "description": "", + "name": "Email", + "in": "query", + "description": "Email that this AuthorizationDocument will be sent to for signing.", "schema": { "type": "string" }, - "required": true + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "test+hosted@twilio.com" + } + } }, { - "name": "DeviceSid", + "name": "Status", "in": "query", - "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", "schema": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$" + "$ref": "#/components/schemas/authorization_document_enum_status" + }, + "examples": { + "readEmpty": { + "value": "signed" + } } }, { @@ -2927,25 +2205,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListDeployedDevicesCertificateResponse", + "title": "ListHostedNumbersAuthorizationDocumentResponse", "properties": { - "certificates": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2954,18 +2234,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0" + }, + "items": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0" + }, + "items": [ + { + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -2979,2212 +2304,39 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ] - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Fleets/{Sid}" - }, - "get": { - "description": "Fetch information about a specific Deployment in the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateDeployedDevicesDeploymentRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long" - }, - "SyncServiceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Fleets/{Sid}" - }, - "post": { - "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesDeploymentRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long." - }, - "SyncServiceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." - } - } - } - } - } - } - }, - "get": { - "description": "Retrieve a list of all Deployments belonging to the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "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": "ListDeployedDevicesDeploymentResponse", - "properties": { - "deployments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ] - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Fleets/{Sid}" - }, - "get": { - "description": "Fetch information about a specific Device in the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateDeployedDevicesDeviceRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." - }, - "Identity": { - "type": "string", - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." - }, - "DeploymentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." - }, - "Enabled": { - "type": "boolean", - "description": "" - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Devices": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Fleets/{Sid}" - }, - "post": { - "description": "Create a new Device in the Fleet, optionally giving it a unique name, friendly name, and assigning to a Deployment and/or human identity.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesDeviceRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long." - }, - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." - }, - "Identity": { - "type": "string", - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." - }, - "DeploymentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." - }, - "Enabled": { - "type": "boolean", - "description": "" - } - } - } - } - } - } - }, - "get": { - "description": "Retrieve a list of all Devices belonging to the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "DeploymentSid", - "in": "query", - "description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 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": "ListDeployedDevicesDeviceResponse", - "properties": { - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ] - } - }, - "/DeployedDevices/Fleets/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "device": "{fleet_sid: sid}", - "deployment": "{fleet_sid: sid}", - "certificate": "{fleet_sid: sid}", - "key": "{fleet_sid: sid}" - } - }, - "get": { - "description": "Fetch information about a specific Fleet in your account.", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Update the friendly name property of a specific Fleet in your account.", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateDeployedDevicesFleetRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." - }, - "DefaultDeploymentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet." - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "device": "{fleet_sid: sid}", - "deployment": "{fleet_sid: sid}", - "certificate": "{fleet_sid: sid}", - "key": "{fleet_sid: sid}" - } - }, - "post": { - "description": "Create a new Fleet for scoping of deployed devices within your account.", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesFleetRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." - } - } - } - } - } - } - }, - "get": { - "description": "Retrieve a list of all Fleets belonging to your account.", - "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": "ListDeployedDevicesFleetResponse", - "properties": { - "fleets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ] - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Fleets/{Sid}" - }, - "get": { - "description": "Fetch information about a specific Key credential in the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesKey", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesKey", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesKey", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateDeployedDevicesKeyRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." - }, - "DeviceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Keys": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Fleets/{Sid}" - }, - "post": { - "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesKey", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesKeyRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." - }, - "DeviceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." - } - } - } - } - } - } - }, - "get": { - "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "DeviceSid", - "in": "query", - "description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$" - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListDeployedDevicesKeyResponse", - "properties": { - "keys": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListDeployedDevicesKey", - "x-maturity": [ - "Preview" - ] - } - }, - "/HostedNumbers/AuthorizationDocuments/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "dependent_hosted_number_order": "{signing_document_sid: sid}" - } - }, - "get": { - "description": "Fetch a specific AuthorizationDocument.", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Updates a specific AuthorizationDocument.", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateHostedNumbersAuthorizationDocumentRequest", - "properties": { - "HostedNumberOrderSids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." - }, - "AddressSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." - }, - "Email": { - "type": "string", - "description": "Email that this AuthorizationDocument will be sent to for signing." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" - }, - "Status": { - "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." - }, - "ContactTitle": { - "type": "string", - "description": "The title of the person authorized to sign the Authorization Document for this phone number." - }, - "ContactPhoneNumber": { - "type": "string", - "description": "The contact phone number of the person authorized to sign the Authorization Document." - } - } - } - } - } - } - } - }, - "/HostedNumbers/AuthorizationDocuments": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "dependent_hosted_number_order": "{signing_document_sid: sid}" - } - }, - "get": { - "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", - "parameters": [ - { - "name": "Email", - "in": "query", - "description": "Email that this AuthorizationDocument will be sent to for signing.", - "schema": { - "type": "string" - } - }, - { - "name": "Status", - "in": "query", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status" - } - }, - { - "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": "ListHostedNumbersAuthorizationDocumentResponse", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateHostedNumbersAuthorizationDocumentRequest", - "properties": { - "HostedNumberOrderSids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." - }, - "AddressSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." - }, - "Email": { - "type": "string", - "description": "Email that this AuthorizationDocument will be sent to for signing." - }, - "ContactTitle": { - "type": "string", - "description": "The title of the person authorized to sign the Authorization Document for this phone number." - }, - "ContactPhoneNumber": { - "type": "string", - "description": "The contact phone number of the person authorized to sign the Authorization Document." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." - } - }, - "required": [ - "HostedNumberOrderSids", - "AddressSid", - "Email", - "ContactTitle", - "ContactPhoneNumber" - ] - } - } - } - } - } - }, - "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/AuthorizationDocuments/{Sid}" - }, - "get": { - "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", - "parameters": [ - { - "name": "SigningDocumentSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Status", - "in": "query", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" - } - }, - { - "name": "PhoneNumber", - "in": "query", - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", - "schema": { - "type": "string", - "format": "phone-number" - } - }, - { - "name": "IncomingPhoneNumberSid", - "in": "query", - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$" - } - }, - { - "name": "FriendlyName", - "in": "query", - "description": "A human readable description of this resource, up to 64 characters.", - "schema": { - "type": "string" - } - }, - { - "name": "UniqueName", - "in": "query", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "schema": { - "type": "string" - } - }, - { - "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": "ListHostedNumbersDependentHostedNumberOrderResponse", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListHostedNumbersDependentHostedNumberOrder", - "x-maturity": [ - "Preview" - ] - } - }, - "/HostedNumbers/HostedNumberOrders/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance" - }, - "get": { - "description": "Fetch a specific HostedNumberOrder.", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Updates a specific HostedNumberOrder.", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateHostedNumbersHostedNumberOrderRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "A 64 character string that is a human readable text that describes this resource." - }, - "UniqueName": { - "type": "string", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." - }, - "Email": { - "type": "string", - "description": "Email of the owner of this phone number that is being hosted." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." - }, - "Status": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_status", - "description": "User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill." - }, - "VerificationCode": { - "type": "string", - "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted." - }, - "VerificationType": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", - "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." - }, - "VerificationDocumentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." - }, - "Extension": { - "type": "string", - "description": "Digits to dial after connecting the verification call." - }, - "CallDelay": { - "type": "integer", - "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0." - } - } - } - } - } - } - } - }, - "/HostedNumbers/HostedNumberOrders": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list" - }, - "get": { - "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", - "parameters": [ - { - "name": "Status", - "in": "query", - "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_status" - } - }, - { - "name": "PhoneNumber", - "in": "query", - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", - "schema": { - "type": "string", - "format": "phone-number" - } - }, - { - "name": "IncomingPhoneNumberSid", - "in": "query", - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$" - } - }, - { - "name": "FriendlyName", - "in": "query", - "description": "A human readable description of this resource, up to 64 characters.", - "schema": { - "type": "string" - } - }, - { - "name": "UniqueName", - "in": "query", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "schema": { - "type": "string" - } - }, - { - "name": "PageSize", - "in": "query", - "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": "ListHostedNumbersHostedNumberOrderResponse", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ] + "operationId": "ListHostedNumbersAuthorizationDocument" }, "post": { - "description": "Host a phone number's capability on Twilio's platform.", + "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", + "tags": [ + "PreviewHostedNumbersAuthorizationDocument" + ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + "$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" + } + } } } }, @@ -5196,213 +2348,191 @@ "accountSid_authToken": [] } ], - "operationId": "CreateHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateHostedNumbersAuthorizationDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateHostedNumbersHostedNumberOrderRequest", + "title": "CreateHostedNumbersAuthorizationDocumentRequest", "properties": { - "PhoneNumber": { - "type": "string", - "format": "phone-number", - "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" - }, - "SmsCapability": { - "type": "boolean", - "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." - }, - "AccountSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to." - }, - "FriendlyName": { - "type": "string", - "description": "A 64 character string that is a human readable text that describes this resource." - }, - "UniqueName": { - "type": "string", - "description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." - }, - "CcEmails": { + "HostedNumberOrderSids": { "type": "array", "items": { "type": "string" }, - "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to." - }, - "SmsUrl": { - "type": "string", - "format": "uri", - "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsFallbackUrl": { - "type": "string", - "format": "uri", - "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsFallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." - }, - "StatusCallbackUrl": { - "type": "string", - "format": "uri", - "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." - }, - "StatusCallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource." - }, - "SmsApplicationSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application." + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." }, "AddressSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." }, "Email": { "type": "string", - "description": "Optional. Email of the owner of this phone number that is being hosted." + "description": "Email that this AuthorizationDocument will be sent to for signing." }, - "VerificationType": { + "ContactTitle": { "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", - "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + "description": "The title of the person authorized to sign the Authorization Document for this phone number." }, - "VerificationDocumentSid": { + "ContactPhoneNumber": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." + "description": "The contact phone number of the person authorized to sign the Authorization Document." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." } }, "required": [ - "PhoneNumber", - "SmsCapability" + "HostedNumberOrderSids", + "AddressSid", + "Email", + "ContactTitle", + "ContactPhoneNumber" ] - } - } - } - } - } - }, - "/marketplace/AvailableAddOns/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "available_add_on_extension": "{available_add_on_sid: sid}" - } - }, - "get": { - "description": "Fetch an instance of an Add-on currently available to be installed.", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "The SID of the AvailableAddOn resource to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on" + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "HostedNumberOrderSids": [ + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + ], + "ContactTitle": "Mr.", + "ContactPhoneNumber": "+14155555555" + } } } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] + } } - ], - "operationId": "FetchMarketplaceAvailableAddOn", - "x-maturity": [ - "Preview" - ] + } } }, - "/marketplace/AvailableAddOns": { + "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "available_add_on_extension": "{available_add_on_sid: sid}" - } + "parent": "/AuthorizationDocuments/{Sid}", + "pathType": "list" }, "get": { - "description": "Retrieve a list of Add-ons currently available to be installed.", + "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", + "tags": [ + "PreviewHostedNumbersDependentHostedNumberOrder" + ], "parameters": [ + { + "name": "SigningDocumentSid", + "in": "path", + "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Status", + "in": "query", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } + } + }, + { + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 64 characters.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "example" + } + } + }, + { + "name": "UniqueName", + "in": "query", + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "something123" + } + } + }, { "name": "PageSize", "in": "query", @@ -5437,25 +2567,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListMarketplaceAvailableAddOnResponse", + "title": "ListHostedNumbersDependentHostedNumberOrderResponse", "properties": { - "available_add_ons": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5464,18 +2596,80 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/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" + } + ] } } } @@ -5489,49 +2683,35 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceAvailableAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "ListHostedNumbersDependentHostedNumberOrder" } }, - "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { + "/HostedNumbers/HostedNumberOrders/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/AvailableAddOns/{Sid}", - "className": "available_add_on_extension" + "pathType": "instance" }, "get": { - "description": "Fetch an instance of an Extension for the Available Add-on.", + "description": "Fetch a specific HostedNumberOrder.", + "tags": [ + "PreviewHostedNumbersHostedNumberOrder" + ], "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.", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$" + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } @@ -5541,7 +2721,45 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + "$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" + } + } } } }, @@ -5553,119 +2771,30 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceAvailableAddOnExtension", - "x-maturity": [ - "Preview" - ] - } - }, - "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/AvailableAddOns/{Sid}", - "className": "available_add_on_extension" + "operationId": "FetchHostedNumbersHostedNumberOrder" }, - "get": { - "description": "Retrieve a list of Extensions for the Available Add-on.", + "delete": { + "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", + "tags": [ + "PreviewHostedNumbersHostedNumberOrder" + ], "parameters": [ { - "name": "AvailableAddOnSid", + "name": "Sid", "in": "path", - "description": "The SID of the AvailableAddOn resource with the extensions to read.", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$" + "pattern": "^HR[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/preview.marketplace.available_add_on.available_add_on_extension" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -5673,38 +2802,75 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceAvailableAddOnExtension", - "x-maturity": [ - "Preview" - ] - } - }, - "/marketplace/InstalledAddOns": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "installed_add_on_extension": "{installed_add_on_sid: sid}" - } + "operationId": "DeleteHostedNumbersHostedNumberOrder" }, "post": { - "description": "Install an Add-on for the Account specified.", + "description": "Updates a specific HostedNumberOrder.", + "tags": [ + "PreviewHostedNumbersHostedNumberOrder" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$" + }, + "required": true + } + ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "extension": "1234", + "failure_reason": "", + "friendly_name": "new friendly name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "pending-loa", + "unique_name": "new unique name", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 1, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -5712,48 +2878,184 @@ "accountSid_authToken": [] } ], - "operationId": "CreateMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateHostedNumbersHostedNumberOrder", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateMarketplaceInstalledAddOnRequest", + "title": "UpdateHostedNumbersHostedNumberOrderRequest", "properties": { - "AvailableAddOnSid": { + "FriendlyName": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "description": "The SID of the AvaliableAddOn to install." + "description": "A 64 character string that is a human readable text that describes this resource." }, - "AcceptTermsOfService": { - "type": "boolean", - "description": "Whether the Terms of Service were accepted." + "UniqueName": { + "type": "string", + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." }, - "Configuration": { - "description": "The JSON object that represents the configuration of the new Add-on being installed." + "Email": { + "type": "string", + "description": "Email of the owner of this phone number that is being hosted." }, - "UniqueName": { + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." + }, + "Status": { "type": "string", - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." + "$ref": "#/components/schemas/hosted_number_order_enum_status", + "description": "User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill." + }, + "VerificationCode": { + "type": "string", + "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted." + }, + "VerificationType": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + }, + "VerificationDocumentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." + }, + "Extension": { + "type": "string", + "description": "Digits to dial after connecting the verification call." + }, + "CallDelay": { + "type": "integer", + "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0." } - }, - "required": [ - "AvailableAddOnSid", - "AcceptTermsOfService" - ] + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "new friendly name", + "UniqueName": "new unique name", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "Status": "pending-loa", + "Extension": "1234", + "CallDelay": 15 + } + } } } } } + } + }, + "/HostedNumbers/HostedNumberOrders": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list" }, "get": { - "description": "Retrieve a list of Add-ons currently installed on this Account.", + "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", + "tags": [ + "PreviewHostedNumbersHostedNumberOrder" + ], "parameters": [ + { + "name": "Status", + "in": "query", + "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } + } + }, + { + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" + } + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 64 characters.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "example" + } + } + }, + { + "name": "UniqueName", + "in": "query", + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "something123" + } + } + }, { "name": "PageSize", "in": "query", @@ -5788,25 +3090,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListMarketplaceInstalledAddOnResponse", + "title": "ListHostedNumbersHostedNumberOrderResponse", "properties": { - "installed_add_ons": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5815,18 +3119,81 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0" + }, + "items": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0" + }, + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": "1234", + "failure_reason": "", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "unique_name": "foobar", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" + } + ] } } } @@ -5840,121 +3207,115 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ] - } - }, - "/marketplace/InstalledAddOns/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "installed_add_on_extension": "{installed_add_on_sid: sid}" - } - }, - "delete": { - "description": "Remove an Add-on installation from your account", - "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", - "x-maturity": [ - "Preview" - ] - }, - "get": { - "description": "Fetch an instance of an Add-on currently installed on this Account.", - "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/preview.marketplace.installed_add_on" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "ListHostedNumbersHostedNumberOrder" }, "post": { - "description": "Update an Add-on installation for the Account specified.", - "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 - } + "description": "Host a phone number's capability on Twilio's platform.", + "tags": [ + "PreviewHostedNumbersHostedNumberOrder" ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": null, + "verification_type": "phone-call" + } + }, + "createWithoutOptionalLoaFields": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": null, + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": null, + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": null, + "verification_type": "phone-call" + } + }, + "createWithPhoneBillVerification": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": null, + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": null, + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_type": "phone-bill" + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -5962,23 +3323,156 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateHostedNumbersHostedNumberOrder", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateMarketplaceInstalledAddOnRequest", + "title": "CreateHostedNumbersHostedNumberOrderRequest", "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" + "PhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" + }, + "SmsCapability": { + "type": "boolean", + "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." + }, + "AccountSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to." + }, + "FriendlyName": { + "type": "string", + "description": "A 64 character string that is a human readable text that describes this resource." }, "UniqueName": { "type": "string", - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." + "description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to." + }, + "SmsUrl": { + "type": "string", + "format": "uri", + "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsFallbackUrl": { + "type": "string", + "format": "uri", + "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsFallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "StatusCallbackUrl": { + "type": "string", + "format": "uri", + "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." + }, + "StatusCallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource." + }, + "SmsApplicationSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application." + }, + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "Email": { + "type": "string", + "description": "Optional. Email of the owner of this phone number that is being hosted." + }, + "VerificationType": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + }, + "VerificationDocumentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." + } + }, + "required": [ + "PhoneNumber", + "SmsCapability" + ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "AD11111111111111111111111111111111", + "PhoneNumber": "+14153608311", + "SmsCapability": true, + "Email": "test@twilio.com" + } + }, + "createWithoutOptionalLoaFields": { + "value": { + "PhoneNumber": "+14153608311", + "SmsCapability": true + } + }, + "createWithPhoneBillVerification": { + "value": { + "PhoneNumber": "+14153608311", + "SmsCapability": true, + "VerificationType": "phone-bill", + "VerificationDocumentSid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -5987,93 +3481,40 @@ } } }, - "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { + "/marketplace/AvailableAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/InstalledAddOns/{Sid}", - "className": "installed_add_on_extension" - }, - "get": { - "description": "Fetch an instance of an Extension for the Installed Add-on.", - "parameters": [ - { - "name": "InstalledAddOnSid", - "in": "path", - "description": "The SID of the InstalledAddOn resource with the extension to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The SID of the InstalledAddOn Extension resource to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" - } - } + "dependentProperties": { + "extensions": { + "mapping": { + "available_add_on_sid": "sid" }, - "description": "OK" + "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchMarketplaceInstalledAddOnExtension", - "x-maturity": [ - "Preview" - ] + "pathType": "instance" }, - "post": { - "description": "Update an Extension for an Add-on installation.", + "get": { + "description": "Fetch an instance of an Add-on currently available to be installed.", + "tags": [ + "PreviewMarketplaceAvailableAddOn" + ], "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.", + "description": "The SID of the AvailableAddOn resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$" + "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true } @@ -6083,71 +3524,71 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateMarketplaceInstalledAddOnExtension", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateMarketplaceInstalledAddOnExtensionRequest", - "properties": { - "Enabled": { - "type": "boolean", - "description": "Whether the Extension should be invoked." - } + "$ref": "#/components/schemas/preview.marketplace.available_add_on" }, - "required": [ - "Enabled" - ] + "examples": { + "fetch": { + "value": { + "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "pricing_type": "per minute", + "configuration_schema": { + "type": "object", + "properties": { + "bad_words": { + "type": "boolean" + } + }, + "required": [ + "bad_words" + ] + }, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" + } + } + } + } } - } + }, + "description": "OK" } - } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMarketplaceAvailableAddOn" } }, - "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { + "/marketplace/AvailableAddOns": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/InstalledAddOns/{Sid}", - "className": "installed_add_on_extension" + "dependentProperties": { + "extensions": { + "mapping": { + "available_add_on_sid": "sid" + }, + "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" + } + }, + "pathType": "list" }, "get": { - "description": "Retrieve a list of Extensions for the Installed Add-on.", + "description": "Retrieve a list of Add-ons currently available to be installed.", + "tags": [ + "PreviewMarketplaceAvailableAddOn" + ], "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", @@ -6182,25 +3623,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListMarketplaceInstalledAddOnExtensionResponse", + "title": "ListMarketplaceAvailableAddOnResponse", "properties": { - "extensions": { + "available_add_ons": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + "$ref": "#/components/schemas/preview.marketplace.available_add_on" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6209,17 +3652,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "available_add_ons": [ + { + "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "pricing_type": "per minute", + "configuration_schema": { + "type": "object", + "properties": { + "bad_words": { + "type": "boolean" + } + }, + "required": [ + "bad_words" + ] + }, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "available_add_ons" + } + } + }, + "readEmpty": { + "value": { + "available_add_ons": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "available_add_ons" } } } @@ -6234,145 +3727,51 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceInstalledAddOnExtension", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceAvailableAddOn" } }, - "/Sync/Services/{ServiceSid}/Documents/{Sid}": { + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "document_permission": "{service_sid: service_sid, document_sid: sid}" - }, - "parent": "/Services/{Sid}" + "parent": "/AvailableAddOns/{Sid}", + "className": "available_add_on_extension", + "pathType": "instance" }, "get": { - "description": "", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } + "description": "Fetch an instance of an Extension for the Available Add-on.", + "tags": [ + "PreviewMarketplaceAvailableAddOnExtension" ], - "operationId": "FetchSyncDocument", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "", "parameters": [ { - "name": "ServiceSid", + "name": "AvailableAddOnSid", "in": "path", - "description": "", + "description": "The SID of the AvailableAddOn resource with the extension to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncDocument", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", + "description": "The SID of the AvailableAddOn Extension resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string" + "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { @@ -6380,7 +3779,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + }, + "examples": { + "fetch": { + "value": { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -6392,114 +3803,37 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncDocument", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateSyncDocumentRequest", - "properties": { - "Data": { - "description": "" - } - }, - "required": [ - "Data" - ] - } - } - } - } + "operationId": "FetchMarketplaceAvailableAddOnExtension" } }, - "/Sync/Services/{ServiceSid}/Documents": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "document_permission": "{service_sid: service_sid, document_sid: sid}" - }, - "parent": "/Services/{Sid}" - }, - "post": { - "description": "", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateSyncDocument", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateSyncDocumentRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "" - }, - "Data": { - "description": "" - } - } - } - } - } + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { + "servers": [ + { + "url": "https://preview.twilio.com" } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/AvailableAddOns/{Sid}", + "className": "available_add_on_extension", + "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of Extensions for the Available Add-on.", + "tags": [ + "PreviewMarketplaceAvailableAddOnExtension" + ], "parameters": [ { - "name": "ServiceSid", + "name": "AvailableAddOnSid", "in": "path", - "description": "", + "description": "The SID of the AvailableAddOn resource with the extensions to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true }, @@ -6537,25 +3871,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncDocumentResponse", + "title": "ListMarketplaceAvailableAddOnExtensionResponse", "properties": { - "documents": { + "extensions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6564,17 +3900,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "extensions": [ + { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" + } + } + }, + "readEmpty": { + "value": { + "extensions": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" } } } @@ -6589,174 +3962,70 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocument", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceAvailableAddOnExtension" } }, - "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { + "/marketplace/InstalledAddOns": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions" - }, - "get": { - "description": "Fetch a specific Sync Document Permission.", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "DocumentSid", - "in": "path", - "description": "Identifier of the Sync Document. Either a SID or a unique name.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Identity", - "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchSyncDocumentPermission", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "Delete a specific Sync Document Permission.", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "DocumentSid", - "in": "path", - "description": "Identifier of the Sync Document. Either a SID or a unique name.", - "schema": { - "type": "string" + "dependentProperties": { + "extensions": { + "mapping": { + "installed_add_on_sid": "sid" }, - "required": true + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" }, - { - "name": "Identity", - "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "schema": { - "type": "string" + "usage": { + "mapping": { + "installed_add_on_sid": "sid" }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncDocumentPermission", - "x-maturity": [ - "Preview" - ] + "pathType": "list" }, "post": { - "description": "Update an identity's access to a specific Sync Document.", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "The unique SID identifier of the Sync Service Instance.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "DocumentSid", - "in": "path", - "description": "Identifier of the Sync Document. Either a SID or a unique name.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Identity", - "in": "path", - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", - "schema": { - "type": "string" - }, - "required": true - } + "description": "Install an Add-on for the Account specified.", + "tags": [ + "PreviewMarketplaceInstalledAddOn" ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + }, + "examples": { + "create": { + "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription_1", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -6764,78 +4033,58 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncDocumentPermission", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateMarketplaceInstalledAddOn", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncDocumentPermissionRequest", + "title": "CreateMarketplaceInstalledAddOnRequest", "properties": { - "Read": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can read the Sync Document." + "AvailableAddOnSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "description": "The SID of the AvaliableAddOn to install." }, - "Write": { + "AcceptTermsOfService": { "type": "boolean", - "description": "Boolean flag specifying whether the identity can update the Sync Document." + "description": "Whether the Terms of Service were accepted." }, - "Manage": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can delete the Sync Document." + "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": [ - "Read", - "Write", - "Manage" - ] - } - } - } - } - } - }, - "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions" - }, - "get": { - "description": "Retrieve a list of all Permissions applying to a Sync Document.", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "DocumentSid", - "in": "path", - "description": "Identifier of the Sync Document. Either a SID or a unique name.", - "schema": { - "type": "string" - }, - "required": true - }, + "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": [ + "PreviewMarketplaceInstalledAddOn" + ], + "parameters": [ { "name": "PageSize", "in": "query", @@ -6870,25 +4119,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncDocumentPermissionResponse", + "title": "ListMarketplaceInstalledAddOnResponse", "properties": { - "permissions": { + "installed_add_ons": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6897,17 +4148,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "installed_add_ons": [ + { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "installed_add_ons" + } + } + }, + "readEmpty": { + "value": { + "installed_add_ons": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "installed_add_ons" } } } @@ -6922,78 +4219,49 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocumentPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceInstalledAddOn" } }, - "/Sync/Services/{Sid}": { + "/marketplace/InstalledAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { - "document": "{service_sid: sid}", - "sync_list": "{service_sid: sid}", - "sync_map": "{service_sid: sid}" - } - }, - "get": { - "description": "", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "extensions": { + "mapping": { + "installed_add_on_sid": "sid" }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service" - } - } + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" + }, + "usage": { + "mapping": { + "installed_add_on_sid": "sid" }, - "description": "OK" + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchSyncService", - "x-maturity": [ - "Preview" - ] + "pathType": "instance" }, "delete": { - "description": "", + "description": "Remove an Add-on installation from your account", + "tags": [ + "PreviewMarketplaceInstalledAddOn" + ], "parameters": [ { "name": "Sid", "in": "path", - "description": "", + "description": "The SID of the InstalledAddOn resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } @@ -7008,23 +4276,23 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncService", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteMarketplaceInstalledAddOn" }, - "post": { - "description": "", + "get": { + "description": "Fetch an instance of an Add-on currently installed on this Account.", + "tags": [ + "PreviewMarketplaceInstalledAddOn" + ], "parameters": [ { "name": "Sid", "in": "path", - "description": "", + "description": "The SID of the InstalledAddOn resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } @@ -7034,7 +4302,28 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service" + "$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" + } + } + } } } }, @@ -7046,139 +4335,25 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncService", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateSyncServiceRequest", - "properties": { - "WebhookUrl": { - "type": "string", - "format": "uri", - "description": "" - }, - "FriendlyName": { - "type": "string", - "description": "" - }, - "ReachabilityWebhooksEnabled": { - "type": "boolean", - "description": "" - }, - "AclEnabled": { - "type": "boolean", - "description": "" - } - } - } - } - } - } - } - }, - "/Sync/Services": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "document": "{service_sid: sid}", - "sync_list": "{service_sid: sid}", - "sync_map": "{service_sid: sid}" - } + "operationId": "FetchMarketplaceInstalledAddOn" }, "post": { - "description": "", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateSyncService", - "x-maturity": [ - "Preview" + "description": "Update an Add-on installation for the Account specified.", + "tags": [ + "PreviewMarketplaceInstalledAddOn" ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateSyncServiceRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "" - }, - "WebhookUrl": { - "type": "string", - "format": "uri", - "description": "" - }, - "ReachabilityWebhooksEnabled": { - "type": "boolean", - "description": "" - }, - "AclEnabled": { - "type": "boolean", - "description": "" - } - } - } - } - } - } - }, - "get": { - "description": "", "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.", + "name": "Sid", + "in": "path", + "description": "The SID of the InstalledAddOn resource to update.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -7186,45 +4361,25 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSyncServiceResponse", - "properties": { - "services": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.sync.service" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } + "$ref": "#/components/schemas/preview.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" } } } @@ -7239,50 +4394,76 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncService", - "x-maturity": [ - "Preview" - ] + "operationId": "UpdateMarketplaceInstalledAddOn", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateMarketplaceInstalledAddOnRequest", + "properties": { + "Configuration": { + "description": "Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured" + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." + } + } + }, + "examples": { + "update": { + "value": { + "Configuration": "{\"bad_words\": true}", + "UniqueName": "voicebase_high_accuracy_transcription_2" + } + } + } + } + } + } } }, - "/Sync/Services/{ServiceSid}/Lists/{Sid}": { + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "sync_list_item": "{service_sid: service_sid, list_sid: sid}", - "sync_list_permission": "{service_sid: service_sid, list_sid: sid}" - }, - "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "parent": "/InstalledAddOns/{Sid}", + "className": "installed_add_on_extension", + "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch an instance of an Extension for the Installed Add-on.", + "tags": [ + "PreviewMarketplaceInstalledAddOnExtension" + ], "parameters": [ { - "name": "ServiceSid", + "name": "InstalledAddOnSid", "in": "path", - "description": "", + "description": "The SID of the InstalledAddOn resource with the extension to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", - "description": "", + "description": "The SID of the InstalledAddOn Extension resource to fetch.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } @@ -7292,7 +4473,20 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" + "$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" + } + } } } }, @@ -7304,95 +4498,62 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncList", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchMarketplaceInstalledAddOnExtension" }, - "delete": { - "description": "", + "post": { + "description": "Update an Extension for an Add-on installation.", + "tags": [ + "PreviewMarketplaceInstalledAddOnExtension" + ], "parameters": [ { - "name": "ServiceSid", + "name": "InstalledAddOnSid", "in": "path", - "description": "", + "description": "The SID of the InstalledAddOn resource with the extension to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncSyncList", - "x-maturity": [ - "Preview" - ] - } - }, - "/Sync/Services/{ServiceSid}/Lists": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "sync_list_item": "{service_sid: service_sid, list_sid: sid}", - "sync_list_permission": "{service_sid: service_sid, list_sid: sid}" - }, - "parent": "/Services/{Sid}", - "mountName": "sync_lists" - }, - "post": { - "description": "", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", + "description": "The SID of the InstalledAddOn Extension resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + }, + "examples": { + "update": { + "value": { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": false, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -7400,39 +4561,63 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncList", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateMarketplaceInstalledAddOnExtension", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncListRequest", + "title": "UpdateMarketplaceInstalledAddOnExtensionRequest", "properties": { - "UniqueName": { - "type": "string", - "description": "" + "Enabled": { + "type": "boolean", + "description": "Whether the Extension should be invoked." + } + }, + "required": [ + "Enabled" + ] + }, + "examples": { + "update": { + "value": { + "Enabled": false } } } } } } + } + }, + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/InstalledAddOns/{Sid}", + "className": "installed_add_on_extension", + "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of Extensions for the Installed Add-on.", + "tags": [ + "PreviewMarketplaceInstalledAddOnExtension" + ], "parameters": [ { - "name": "ServiceSid", + "name": "InstalledAddOnSid", "in": "path", - "description": "", + "description": "The SID of the InstalledAddOn resource with the extensions to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true }, @@ -7470,25 +4655,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncListResponse", + "title": "ListMarketplaceInstalledAddOnExtensionResponse", "properties": { - "lists": { + "extensions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7497,17 +4684,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "extensions": [ + { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": true, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" + } + } + }, + "readEmpty": { + "value": { + "extensions": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" } } } @@ -7522,126 +4747,66 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncList", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceInstalledAddOnExtension" } }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { + "/wireless/Commands/{Sid}": { "servers": [ { "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" + "pathType": "instance" }, "get": { "description": "", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Index", - "in": "path", - "description": "", - "schema": { - "type": "integer" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } + "tags": [ + "PreviewWirelessCommand" ], - "operationId": "FetchSyncSyncListItem", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, + "parameters": [ { - "name": "Index", + "name": "Sid", "in": "path", "description": "", "schema": { - "type": "integer" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DC[0-9a-fA-F]{32}$" }, "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.command" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "command_mode", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "direction", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "status", + "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" } }, "security": [ @@ -7649,48 +4814,113 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncListItem", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchWirelessCommand" + } + }, + "/wireless/Commands": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list" }, - "post": { + "get": { "description": "", + "tags": [ + "PreviewWirelessCommand" + ], "parameters": [ { - "name": "ServiceSid", - "in": "path", + "name": "Device", + "in": "query", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, - "required": true + "examples": { + "readEmpty": { + "value": "device" + }, + "readFull": { + "value": "device" + } + } }, { - "name": "ListSid", - "in": "path", + "name": "Sim", + "in": "query", "description": "", "schema": { "type": "string" }, - "required": true + "examples": { + "readEmpty": { + "value": "sim" + }, + "readFull": { + "value": "sim" + } + } }, { - "name": "Index", - "in": "path", + "name": "Status", + "in": "query", "description": "", "schema": { - "type": "integer" + "type": "string" }, - "required": true + "examples": { + "readEmpty": { + "value": "status" + }, + "readFull": { + "value": "status" + } + } }, { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", + "name": "Direction", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "direction" + }, + "readFull": { + "value": "direction" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", "schema": { "type": "string" } @@ -7701,7 +4931,92 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "type": "object", + "title": "ListWirelessCommandResponse", + "properties": { + "commands": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.wireless.command" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "commands": [], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0", + "key": "commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "commands": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "command_mode", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "direction", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "status", + "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0", + "key": "commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0" + } + } + } } } }, @@ -7713,74 +5028,36 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncListItem", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateSyncSyncListItemRequest", - "properties": { - "Data": { - "description": "" - } - }, - "required": [ - "Data" - ] - } - } - } - } - } - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items" + "operationId": "ListWirelessCommand" }, "post": { "description": "", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } + "tags": [ + "PreviewWirelessCommand" ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$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" + } + } } } }, @@ -7792,79 +5069,83 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncListItem", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateWirelessCommand", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncListItemRequest", + "title": "CreateWirelessCommandRequest", "properties": { - "Data": { + "Command": { + "type": "string", + "description": "" + }, + "Device": { + "type": "string", + "description": "" + }, + "Sim": { + "type": "string", + "description": "" + }, + "CallbackMethod": { + "type": "string", + "description": "" + }, + "CallbackUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "CommandMode": { + "type": "string", + "description": "" + }, + "IncludeSid": { + "type": "string", "description": "" } }, "required": [ - "Data" + "Command" ] + }, + "examples": { + "create": { + "value": { + "CallbackMethod": "callback_method", + "CallbackUrl": "http://www.example.com", + "Command": "command", + "CommandMode": "command_mode", + "Device": "device", + "Sim": "sim", + "IncludeSid": "include_sid" + } + } } } } } + } + }, + "/wireless/RatePlans": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list" }, "get": { "description": "", + "tags": [ + "PreviewWirelessRatePlan" + ], "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Order", - "in": "query", - "description": "", - "schema": { - "type": "string", - "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" - } - }, - { - "name": "From", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - }, - { - "name": "Bounds", - "in": "query", - "description": "", - "schema": { - "type": "string", - "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" - } - }, { "name": "PageSize", "in": "query", @@ -7899,25 +5180,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncListItemResponse", + "title": "ListWirelessRatePlanResponse", "properties": { - "items": { + "rate_plans": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$ref": "#/components/schemas/preview.wireless.rate_plan" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7926,18 +5209,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0", + "key": "rate_plans", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0" + }, + "rate_plans": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0", + "key": "rate_plans", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0" + }, + "rate_plans": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -7951,53 +5283,299 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncListItem", - "x-maturity": [ - "Preview" - ] + "operationId": "ListWirelessRatePlan" + }, + "post": { + "description": "", + "tags": [ + "PreviewWirelessRatePlan" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateWirelessRatePlan", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateWirelessRatePlanRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "" + }, + "FriendlyName": { + "type": "string", + "description": "" + }, + "DataEnabled": { + "type": "boolean", + "description": "" + }, + "DataLimit": { + "type": "integer", + "description": "" + }, + "DataMetering": { + "type": "string", + "description": "" + }, + "MessagingEnabled": { + "type": "boolean", + "description": "" + }, + "VoiceEnabled": { + "type": "boolean", + "description": "" + }, + "CommandsEnabled": { + "type": "boolean", + "description": "" + }, + "NationalRoamingEnabled": { + "type": "boolean", + "description": "" + }, + "InternationalRoaming": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + } + } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "DataEnabled": true, + "DataLimit": 1000, + "DataMetering": "pooled", + "MessagingEnabled": true, + "VoiceEnabled": true, + "FriendlyName": "friendly_name", + "NationalRoamingEnabled": true, + "InternationalRoaming": [ + "data", + "voice", + "messaging" + ], + "Status": "status" + } + } + } + } + } + } } }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { + "/wireless/RatePlans/{Sid}": { "servers": [ { "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" + "pathType": "instance" }, "get": { - "description": "Fetch a specific Sync List Permission.", + "description": "", + "tags": [ + "PreviewWirelessRatePlan" + ], "parameters": [ { - "name": "ServiceSid", + "name": "Sid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ { - "name": "ListSid", + "accountSid_authToken": [] + } + ], + "operationId": "FetchWirelessRatePlan" + }, + "post": { + "description": "", + "tags": [ + "PreviewWirelessRatePlan" + ], + "parameters": [ + { + "name": "Sid", "in": "path", - "description": "Identifier of the Sync List. Either a SID or a unique name.", + "description": "", "schema": { "type": "string" }, "required": true - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateWirelessRatePlan", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateWirelessRatePlanRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "" + }, + "FriendlyName": { + "type": "string", + "description": "" + } + } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "FriendlyName": "friendly_name" + } + } + } + } + } + } + }, + "delete": { + "description": "", + "tags": [ + "PreviewWirelessRatePlan" + ], + "parameters": [ { - "name": "Identity", + "name": "Sid", "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "description": "", "schema": { "type": "string" }, @@ -8005,15 +5583,8 @@ } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -8021,39 +5592,38 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncListPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteWirelessRatePlan" + } + }, + "/wireless/Sims/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "usage": { + "mapping": { + "sim_sid": "sid" + }, + "resource_url": "/wireless/Sims/{sim_sid}/Usage" + } + }, + "pathType": "instance" }, - "delete": { - "description": "Delete a specific Sync List Permission.", + "get": { + "description": "", + "tags": [ + "PreviewWirelessSim" + ], "parameters": [ { - "name": "ServiceSid", + "name": "Sid", "in": "path", "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", - "in": "path", - "description": "Identifier of the Sync List. Either a SID or a unique name.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Identity", - "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -8061,8 +5631,46 @@ } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "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" + } + } + } + } + }, + "description": "OK" } }, "security": [ @@ -8070,39 +5678,18 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncListPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchWirelessSim" }, "post": { - "description": "Update an identity's access to a specific Sync List.", + "description": "", + "tags": [ + "PreviewWirelessSim" + ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "The unique SID identifier of the Sync Service Instance.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", - "in": "path", - "description": "Identifier of the Sync List. Either a SID or a unique name.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Identity", + "name": "Sid", "in": "path", - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "description": "", "schema": { "type": "string" }, @@ -8114,7 +5701,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + "$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" + } + } } } }, @@ -8126,77 +5744,246 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncListPermission", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateWirelessSim", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncSyncListPermissionRequest", + "title": "UpdateWirelessSimRequest", "properties": { - "Read": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can read the Sync List." + "UniqueName": { + "type": "string", + "description": "" }, - "Write": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." + "CallbackMethod": { + "type": "string", + "description": "" }, - "Manage": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can delete the Sync List." + "CallbackUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "FriendlyName": { + "type": "string", + "description": "" + }, + "RatePlan": { + "type": "string", + "description": "" + }, + "Status": { + "type": "string", + "description": "" + }, + "CommandsCallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "" + }, + "CommandsCallbackUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "SmsFallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "" + }, + "SmsFallbackUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "SmsMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "" + }, + "SmsUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "VoiceFallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "" + }, + "VoiceFallbackUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "VoiceMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "" + }, + "VoiceUrl": { + "type": "string", + "format": "uri", + "description": "" } - }, - "required": [ - "Read", - "Write", - "Manage" - ] + } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "CallbackMethod": "callback_method", + "CallbackUrl": "http://www.example.com", + "CommandsCallbackMethod": "http_method", + "CommandsCallbackUrl": "http://www.example.com", + "VoiceMethod": "http_method", + "VoiceUrl": "http://www.example.com", + "VoiceFallbackMethod": "http_method", + "VoiceFallbackUrl": "http://www.example.com", + "SmsMethod": "http_method", + "SmsUrl": "http://www.example.com", + "SmsFallbackMethod": "http_method", + "SmsFallbackUrl": "http://www.example.com", + "FriendlyName": "friendly_name", + "RatePlan": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Status": "status" + } + } } } } } } }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { + "/wireless/Sims": { "servers": [ { "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" + "dependentProperties": { + "usage": { + "mapping": { + "sim_sid": "sid" + }, + "resource_url": "/wireless/Sims/{sim_sid}/Usage" + } + }, + "pathType": "list" }, "get": { - "description": "Retrieve a list of all Permissions applying to a Sync List.", + "description": "", + "tags": [ + "PreviewWirelessSim" + ], "parameters": [ { - "name": "ServiceSid", - "in": "path", + "name": "Status", + "in": "query", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, - "required": true + "examples": { + "readEmpty": { + "value": "status" + }, + "readFull": { + "value": "status" + } + } }, { - "name": "ListSid", - "in": "path", - "description": "Identifier of the Sync List. Either a SID or a unique name.", + "name": "Iccid", + "in": "query", + "description": "", "schema": { "type": "string" }, - "required": true + "examples": { + "readEmpty": { + "value": "iccid" + }, + "readFull": { + "value": "iccid" + } + } + }, + { + "name": "RatePlan", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "rate_plan" + }, + "readFull": { + "value": "rate_plan" + } + } + }, + { + "name": "EId", + "in": "query", + "description": "", + "schema": { + "type": "string" + } + }, + { + "name": "SimRegistrationCode", + "in": "query", + "description": "", + "schema": { + "type": "string" + } }, { "name": "PageSize", @@ -8232,25 +6019,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncListPermissionResponse", + "title": "ListWirelessSimResponse", "properties": { - "permissions": { + "sims": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + "$ref": "#/components/schemas/preview.wireless.sim" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8259,17 +6048,73 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sims": [], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "sims": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "http_method", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", + "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "status", + "sms_fallback_method": "http_method", + "sms_fallback_url": "http://www.example.com", + "sms_method": "http_method", + "sms_url": "http://www.example.com", + "voice_fallback_method": "http_method", + "voice_fallback_url": "http://www.example.com", + "voice_method": "http_method", + "voice_url": "http://www.example.com", + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" } } } @@ -8284,228 +6129,60 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncListPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "ListWirelessSim" } }, - "/Sync/Services/{ServiceSid}/Maps/{Sid}": { + "/wireless/Sims/{SimSid}/Usage": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "sync_map_item": "{service_sid: service_sid, map_sid: sid}", - "sync_map_permission": "{service_sid: service_sid, map_sid: sid}" - }, - "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "parent": "/Sims/{Sid}", + "pathType": "instance" }, "get": { "description": "", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } + "tags": [ + "PreviewWirelessUsage" ], - "operationId": "FetchSyncSyncMap", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "", "parameters": [ { - "name": "ServiceSid", + "name": "SimSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "Sid", - "in": "path", + "name": "End", + "in": "query", "description": "", "schema": { "type": "string" }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncSyncMap", - "x-maturity": [ - "Preview" - ] - } - }, - "/Sync/Services/{ServiceSid}/Maps": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "sync_map_item": "{service_sid: service_sid, map_sid: sid}", - "sync_map_permission": "{service_sid: service_sid, map_sid: sid}" - }, - "parent": "/Services/{Sid}", - "mountName": "sync_maps" - }, - "post": { - "description": "", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateSyncSyncMap", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateSyncSyncMapRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "" - } - } + "examples": { + "fetch": { + "value": "end" } } - } - } - }, - "get": { - "description": "", - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 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", + "name": "Start", "in": "query", - "description": "The page token. This is provided by the API.", + "description": "", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "start" + } } } ], @@ -8514,46 +6191,20 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSyncSyncMapResponse", - "properties": { - "maps": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } + "$ref": "#/components/schemas/preview.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" } } } @@ -8567,42 +6218,29 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMap", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchWirelessUsage" } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { + "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { "servers": [ { "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" + "parent": "/Fleets/{Sid}", + "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch information about a specific Certificate credential in the Fleet.", + "tags": [ + "PreviewDeployedDevicesCertificate" + ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { @@ -8611,11 +6249,14 @@ "required": true }, { - "name": "Key", + "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$" }, "required": true } @@ -8625,7 +6266,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$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" + } + } } } }, @@ -8637,28 +6293,16 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapItem", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesCertificate" }, "delete": { - "description": "", + "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "tags": [ + "PreviewDeployedDevicesCertificate" + ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { @@ -8667,21 +6311,16 @@ "required": true }, { - "name": "Key", + "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$" }, "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { @@ -8694,28 +6333,16 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMapItem", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeployedDevicesCertificate" }, "post": { - "description": "", + "description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.", + "tags": [ + "PreviewDeployedDevicesCertificate" + ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { @@ -8724,21 +6351,16 @@ "required": true }, { - "name": "Key", + "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$" }, "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { @@ -8746,7 +6368,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$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" + } + } } } }, @@ -8758,60 +6395,60 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncMapItem", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateDeployedDevicesCertificate", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncSyncMapItemRequest", + "title": "UpdateDeployedDevicesCertificateRequest", "properties": { - "Data": { - "description": "" + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." + }, + "DeviceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." } - }, - "required": [ - "Data" - ] + } + }, + "examples": { + "update": { + "value": { + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" + } + } } } } } } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { + "/DeployedDevices/Fleets/{FleetSid}/Certificates": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items" + "parent": "/Fleets/{Sid}", + "pathType": "list" }, "post": { - "description": "", + "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", + "tags": [ + "PreviewDeployedDevicesCertificate" + ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { @@ -8825,7 +6462,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$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" + } + } } } }, @@ -8837,82 +6489,71 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncMapItem", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateDeployedDevicesCertificate", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncMapItemRequest", + "title": "CreateDeployedDevicesCertificateRequest", "properties": { - "Key": { + "CertificateData": { "type": "string", - "description": "" + "description": "Provides a URL encoded representation of the public certificate in PEM format." }, - "Data": { - "description": "" + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." + }, + "DeviceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." } }, "required": [ - "Key", - "Data" + "CertificateData" ] + }, + "examples": { + "create": { + "value": { + "CertificateData": "12345678abcdef", + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" + } + } } } } } }, "get": { - "description": "", + "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", + "tags": [ + "PreviewDeployedDevicesCertificate" + ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Order", - "in": "query", - "description": "", - "schema": { - "type": "string", - "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" - } - }, - { - "name": "From", - "in": "query", + "name": "FleetSid", + "in": "path", "description": "", "schema": { "type": "string" - } + }, + "required": true }, { - "name": "Bounds", + "name": "DeviceSid", "in": "query", - "description": "", + "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", "schema": { "type": "string", - "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$" } }, { @@ -8949,25 +6590,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncMapItemResponse", + "title": "ListDeployedDevicesCertificateResponse", "properties": { - "items": { + "certificates": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8976,17 +6619,57 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "certificates": [], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", + "key": "certificates", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "certificates": [ + { + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", + "key": "certificates", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" } } } @@ -9001,55 +6684,45 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapItem", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeployedDevicesCertificate" } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { + "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { "servers": [ { "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" + "parent": "/Fleets/{Sid}", + "pathType": "instance" }, "get": { - "description": "Fetch a specific Sync Map Permission.", + "description": "Fetch information about a specific Deployment in the Fleet.", + "tags": [ + "PreviewDeployedDevicesDeployment" + ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", - "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Identity", + "name": "Sid", "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } @@ -9059,7 +6732,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + "$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" + } + } } } }, @@ -9071,41 +6758,32 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesDeployment" }, "delete": { - "description": "Delete a specific Sync Map Permission.", + "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", + "tags": [ + "PreviewDeployedDevicesDeployment" + ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", - "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Identity", + "name": "Sid", "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } @@ -9120,41 +6798,32 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeployedDevicesDeployment" }, "post": { - "description": "Update an identity's access to a specific Sync Map.", + "description": "Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.", + "tags": [ + "PreviewDeployedDevicesDeployment" + ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "The unique SID identifier of the Sync Service Instance.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", + "name": "FleetSid", "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "description": "", "schema": { "type": "string" }, "required": true }, { - "name": "Identity", + "name": "Sid", "in": "path", - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } @@ -9164,7 +6833,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + "$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" + } + } } } }, @@ -9176,73 +6859,142 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateDeployedDevicesDeployment", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncSyncMapPermissionRequest", + "title": "UpdateDeployedDevicesDeploymentRequest", "properties": { - "Read": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can read the Sync Map." - }, - "Write": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long" }, - "Manage": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can delete the Sync Map." + "SyncServiceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." } - }, - "required": [ - "Read", - "Write", - "Manage" - ] + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "SyncServiceSid": "sync_service_sid" + } + } } } } } } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { + "/DeployedDevices/Fleets/{FleetSid}/Deployments": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_permissions" + "parent": "/Fleets/{Sid}", + "pathType": "list" }, - "get": { - "description": "Retrieve a list of all Permissions applying to a Sync Map.", + "post": { + "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", + "tags": [ + "PreviewDeployedDevicesDeployment" + ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true - }, + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + }, + "examples": { + "create": { + "value": { + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ { - "name": "MapSid", + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeployedDevicesDeployment", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesDeploymentRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long." + }, + "SyncServiceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." + } + } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "SyncServiceSid": "sync_service_sid" + } + } + } + } + } + } + }, + "get": { + "description": "Retrieve a list of all Deployments belonging to the Fleet.", + "tags": [ + "PreviewDeployedDevicesDeployment" + ], + "parameters": [ + { + "name": "FleetSid", "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "description": "", "schema": { "type": "string" }, @@ -9282,25 +7034,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncMapPermissionResponse", + "title": "ListDeployedDevicesDeploymentResponse", "properties": { - "permissions": { + "deployments": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9309,17 +7063,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "deployments": [], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", + "key": "deployments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "deployments": [ + { + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", + "key": "deployments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" } } } @@ -9334,40 +7127,40 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeployedDevicesDeployment" } }, - "/understand/Assistants/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "field_type": "{assistant_sid: sid}", - "task": "{assistant_sid: sid}", - "model_build": "{assistant_sid: sid}", - "query": "{assistant_sid: sid}", - "assistant_fallback_actions": "{assistant_sid: sid}", - "assistant_initiation_actions": "{assistant_sid: sid}", - "dialogue": "{assistant_sid: sid}", - "style_sheet": "{assistant_sid: sid}" - } + "parent": "/Fleets/{Sid}", + "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch information about a specific Device in the Fleet.", + "tags": [ + "PreviewDeployedDevicesDevice" + ], "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { "type": "string" }, @@ -9379,7 +7172,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" + "$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" + } + } } } }, @@ -9391,18 +7202,64 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandAssistant", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesDevice" + }, + "delete": { + "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", + "tags": [ + "PreviewDeployedDevicesDevice" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesDevice" }, "post": { - "description": "", + "description": "Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.", + "tags": [ + "PreviewDeployedDevicesDevice" + ], "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { "type": "string" }, @@ -9414,7 +7271,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" + "$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" + } + } } } }, @@ -9426,60 +7301,70 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandAssistant", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateDeployedDevicesDevice", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandAssistantRequest", + "title": "UpdateDeployedDevicesDeviceRequest", "properties": { "FriendlyName": { "type": "string", - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long." - }, - "LogQueries": { - "type": "boolean", - "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided." - }, - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." }, - "CallbackUrl": { + "Identity": { "type": "string", - "format": "uri", - "description": "A user-provided URL to send event callbacks to." + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." }, - "CallbackEvents": { + "DeploymentSid": { "type": "string", - "description": "Space-separated list of callback events that will trigger callbacks." - }, - "FallbackActions": { - "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task." - }, - "InitiationActions": { - "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first." + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." }, - "StyleSheet": { - "description": "The JSON object that holds the style sheet for the assistant" + "Enabled": { + "type": "boolean", + "description": "" + } + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Identity": "identity" } } } } } } + } + }, + "/DeployedDevices/Fleets/{FleetSid}/Devices": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Fleets/{Sid}", + "pathType": "list" }, - "delete": { - "description": "", + "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.", + "tags": [ + "PreviewDeployedDevicesDevice" + ], "parameters": [ { - "name": "Sid", + "name": "FleetSid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { "type": "string" }, @@ -9487,8 +7372,33 @@ } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + }, + "examples": { + "create": { + "value": { + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" } }, "security": [ @@ -9496,36 +7406,78 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandAssistant", - "x-maturity": [ - "Preview" - ] - } - }, - "/understand/Assistants": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "field_type": "{assistant_sid: sid}", - "task": "{assistant_sid: sid}", - "model_build": "{assistant_sid: sid}", - "query": "{assistant_sid: sid}", - "assistant_fallback_actions": "{assistant_sid: sid}", - "assistant_initiation_actions": "{assistant_sid: sid}", - "dialogue": "{assistant_sid: sid}", - "style_sheet": "{assistant_sid: sid}" + "operationId": "CreateDeployedDevicesDevice", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesDeviceRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long." + }, + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." + }, + "Identity": { + "type": "string", + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." + }, + "DeploymentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." + }, + "Enabled": { + "type": "boolean", + "description": "" + } + } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Identity": "identity" + } + } + } + } + } } }, "get": { - "description": "", + "description": "Retrieve a list of all Devices belonging to the Fleet.", + "tags": [ + "PreviewDeployedDevicesDevice" + ], "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "DeploymentSid", + "in": "query", + "description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" + } + }, { "name": "PageSize", "in": "query", @@ -9560,25 +7512,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandAssistantResponse", + "title": "ListDeployedDevicesDeviceResponse", "properties": { - "assistants": { + "devices": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9587,48 +7541,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "devices": [], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", + "key": "devices", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "devices": [ + { + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", + "key": "devices", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" + } } } } } }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListUnderstandAssistant", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" - } - } - }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -9636,75 +7609,56 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandAssistant", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandAssistantRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long." - }, - "LogQueries": { - "type": "boolean", - "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided." - }, - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - }, - "CallbackUrl": { - "type": "string", - "format": "uri", - "description": "A user-provided URL to send event callbacks to." - }, - "CallbackEvents": { - "type": "string", - "description": "Space-separated list of callback events that will trigger callbacks." - }, - "FallbackActions": { - "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task." - }, - "InitiationActions": { - "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first." - }, - "StyleSheet": { - "description": "The JSON object that holds the style sheet for the assistant" - } - } - } - } - } - } + "operationId": "ListDeployedDevicesDevice" } }, - "/understand/Assistants/{AssistantSid}/FallbackActions": { + "/DeployedDevices/Fleets/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{Sid}", - "mountName": "assistant_fallback_actions", - "className": "assistant_fallback_actions" + "dependentProperties": { + "devices": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" + }, + "deployments": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" + }, + "certificates": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" + }, + "keys": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" + } + }, + "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch information about a specific Fleet in your account.", + "tags": [ + "PreviewDeployedDevicesFleet" + ], "parameters": [ { - "name": "AssistantSid", + "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", "schema": { "type": "string" }, @@ -9716,7 +7670,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + "$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" + } + } + } } } }, @@ -9728,18 +7702,46 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandAssistantFallbackActions", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesFleet" + }, + "delete": { + "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", + "tags": [ + "PreviewDeployedDevicesFleet" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesFleet" }, "post": { - "description": "", + "description": "Update the friendly name property of a specific Fleet in your account.", + "tags": [ + "PreviewDeployedDevicesFleet" + ], "parameters": [ { - "name": "AssistantSid", + "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", "schema": { "type": "string" }, @@ -9751,7 +7753,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + "$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" + } + } + } } } }, @@ -9763,19 +7785,32 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandAssistantFallbackActions", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateDeployedDevicesFleet", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandAssistantFallbackActionsRequest", + "title": "UpdateDeployedDevicesFleetRequest", "properties": { - "FallbackActions": { - "description": "" + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." + }, + "DefaultDeploymentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet." + } + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "DefaultDeploymentSid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -9784,43 +7819,78 @@ } } }, - "/understand/Assistants/{AssistantSid}/InitiationActions": { + "/DeployedDevices/Fleets": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{Sid}", - "mountName": "assistant_initiation_actions", - "className": "assistant_initiation_actions" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" + "dependentProperties": { + "devices": { + "mapping": { + "fleet_sid": "sid" }, - "required": true + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" + }, + "deployments": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" + }, + "certificates": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" + }, + "keys": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" } + }, + "pathType": "list" + }, + "post": { + "description": "Create a new Fleet for scoping of deployed devices within your account.", + "tags": [ + "PreviewDeployedDevicesFleet" ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + }, + "examples": { + "create": { + "value": { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -9828,22 +7898,63 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandAssistantInitiationActions", - "x-maturity": [ - "Preview" - ] + "operationId": "CreateDeployedDevicesFleet", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesFleetRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." + } + } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } + } + } + } + } }, - "post": { - "description": "", + "get": { + "description": "Retrieve a list of all Fleets belonging to your account.", + "tags": [ + "PreviewDeployedDevicesFleet" + ], "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "", + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", "schema": { "type": "string" - }, - "required": true + } } ], "responses": { @@ -9851,56 +7962,129 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateUnderstandAssistantInitiationActions", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateUnderstandAssistantInitiationActionsRequest", - "properties": { - "InitiationActions": { - "description": "" + "type": "object", + "title": "ListDeployedDevicesFleetResponse", + "properties": { + "fleets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + } + }, + "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": { + "fleets": [], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", + "key": "fleets", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "fleets": [ + { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", + "key": "fleets", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" + } + } } } } - } + }, + "description": "OK" } - } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListDeployedDevicesFleet" } }, - "/understand/Assistants/{AssistantSid}/Dialogues/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "parent": "/Fleets/{Sid}", + "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch information about a specific Key credential in the Fleet.", + "tags": [ + "PreviewDeployedDevicesKey" + ], "parameters": [ { - "name": "AssistantSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { @@ -9911,9 +8095,12 @@ { "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } @@ -9923,7 +8110,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.dialogue" + "$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" + } + } } } }, @@ -9935,53 +8137,18 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandDialogue", - "x-maturity": [ - "Preview" - ] - } - }, - "/understand/Assistants/{AssistantSid}/Dialogues": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{Sid}" - } - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + "operationId": "FetchDeployedDevicesKey" }, - "get": { - "description": "", + "delete": { + "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "tags": [ + "PreviewDeployedDevicesKey" + ], "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", + "name": "FleetSid", "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "description": "", "schema": { "type": "string" }, @@ -9990,23 +8157,19 @@ { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -10014,27 +8177,18 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandField", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeployedDevicesKey" }, - "delete": { - "description": "", + "post": { + "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", + "tags": [ + "PreviewDeployedDevicesKey" + ], "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", + "name": "FleetSid", "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "description": "", "schema": { "type": "string" }, @@ -10043,16 +8197,41 @@ { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + }, + "examples": { + "update": { + "value": { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" } }, "security": [ @@ -10060,45 +8239,159 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandField", - "x-maturity": [ - "Preview" - ] + "operationId": "UpdateDeployedDevicesKey", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateDeployedDevicesKeyRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." + }, + "DeviceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." + } + } + }, + "examples": { + "update": { + "value": { + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" + } + } + } + } + } + } } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { + "/DeployedDevices/Fleets/{FleetSid}/Keys": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + "parent": "/Fleets/{Sid}", + "pathType": "list" }, - "get": { - "description": "", + "post": { + "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", + "tags": [ + "PreviewDeployedDevicesKey" + ], "parameters": [ { - "name": "AssistantSid", + "name": "FleetSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { "type": "string" }, "required": true - }, + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + }, + "examples": { + "create": { + "value": { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeployedDevicesKey", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesKeyRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." + }, + "DeviceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." + } + } + }, + "examples": { + "create": { + "value": { + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" + } + } + } + } + } + } + }, + "get": { + "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", + "tags": [ + "PreviewDeployedDevicesKey" + ], + "parameters": [ { - "name": "TaskSid", + "name": "FleetSid", "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "description": "", "schema": { "type": "string" }, "required": true }, + { + "name": "DeviceSid", + "in": "query", + "description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$" + } + }, { "name": "PageSize", "in": "query", @@ -10133,25 +8426,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandFieldResponse", + "title": "ListDeployedDevicesKeyResponse", "properties": { - "fields": { + "keys": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10160,52 +8455,117 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "keys": [], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", + "key": "keys", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "keys": [ + { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", + "key": "keys", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" } } } } } }, - "description": "OK" + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListDeployedDevicesKey" + } + }, + "/Sync/Services/{ServiceSid}/Documents/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "document_permissions": { + "mapping": { + "service_sid": "service_sid", + "document_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListUnderstandField", - "x-maturity": [ - "Preview" - ] + "parent": "/Services/{Sid}", + "pathType": "instance" }, - "post": { + "get": { "description": "", + "tags": [ + "PreviewSyncDocument" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "Sid", "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "description": "", "schema": { "type": "string" }, @@ -10213,15 +8573,34 @@ } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" + "$ref": "#/components/schemas/preview.sync.service.document" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -10229,60 +8608,23 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandField", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandFieldRequest", - "properties": { - "FieldType": { - "type": "string", - "description": "The unique name or sid of the FieldType. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or the Field Type sid of a custom Field Type." - }, - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - } - }, - "required": [ - "FieldType", - "UniqueName" - ] - } - } - } - } - } - }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "field_value": "{assistant_sid: assistant_sid, field_type_sid: sid}" - }, - "parent": "/Assistants/{Sid}" + "operationId": "FetchSyncDocument" }, - "get": { + "delete": { "description": "", + "tags": [ + "PreviewSyncDocument" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, @@ -10297,15 +8639,8 @@ } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -10313,20 +8648,23 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandFieldType", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncDocument" }, "post": { "description": "", + "tags": [ + "PreviewSyncDocument" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, @@ -10338,6 +8676,14 @@ "type": "string" }, "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } } ], "responses": { @@ -10345,7 +8691,26 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" + "$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" + } + } + } } } }, @@ -10357,56 +8722,104 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandFieldType", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateSyncDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandFieldTypeRequest", + "title": "UpdateSyncDocumentRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." - }, - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "Data": { + "description": "" + } + }, + "required": [ + "Data" + ] + }, + "examples": { + "update": { + "value": { + "Data": "{}", + "UniqueName": "unique_name" } } } } } } + } + }, + "/Sync/Services/{ServiceSid}/Documents": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "document_permissions": { + "mapping": { + "service_sid": "service_sid", + "document_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "pathType": "list" }, - "delete": { + "post": { "description": "", + "tags": [ + "PreviewSyncDocument" + ], "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "201": { + "content": { + "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" + } + } + } + } + } + }, + "description": "Created" } }, "security": [ @@ -10414,36 +8827,50 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandFieldType", - "x-maturity": [ - "Preview" - ] - } - }, - "/understand/Assistants/{AssistantSid}/FieldTypes": { - "servers": [ - { - "url": "https://preview.twilio.com" + "operationId": "CreateSyncDocument", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncDocumentRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "" + }, + "Data": { + "description": "" + } + } + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "UniqueName": "unique_name" + } + } + } + } + } } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "field_value": "{assistant_sid: assistant_sid, field_type_sid: sid}" - }, - "parent": "/Assistants/{Sid}" }, "get": { "description": "", + "tags": [ + "PreviewSyncDocument" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, @@ -10481,25 +8908,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandFieldTypeResponse", + "title": "ListSyncDocumentResponse", "properties": { - "field_types": { + "documents": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" + "$ref": "#/components/schemas/preview.sync.service.document" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10508,59 +8937,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "documents": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "documents": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" + } } } } } }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListUnderstandFieldType", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" - } - } - }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -10568,72 +9006,53 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandFieldType", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandFieldTypeRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - }, - "FriendlyName": { - "type": "string", - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." - } - }, - "required": [ - "UniqueName" - ] - } - } - } - } + "operationId": "ListSyncDocument" } }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" + "parent": "/Services/{ServiceSid}/Documents/{Sid}", + "mountName": "document_permissions", + "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch a specific Sync Document Permission.", + "tags": [ + "PreviewSyncDocumentPermission" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "FieldTypeSid", + "name": "DocumentSid", "in": "path", - "description": "", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Sid", + "name": "Identity", "in": "path", - "description": "", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -10645,7 +9064,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + "$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" + } + } } } }, @@ -10657,36 +9090,39 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandFieldValue", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncDocumentPermission" }, "delete": { - "description": "", + "description": "Delete a specific Sync Document Permission.", + "tags": [ + "PreviewSyncDocumentPermission" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "FieldTypeSid", + "name": "DocumentSid", "in": "path", - "description": "", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Sid", + "name": "Identity", "in": "path", - "description": "", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -10703,53 +9139,157 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandFieldValue", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncDocumentPermission" + }, + "post": { + "description": "Update an identity's access to a specific Sync Document.", + "tags": [ + "PreviewSyncDocumentPermission" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "The unique SID identifier of the Sync Service Instance.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "DocumentSid", + "in": "path", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "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" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateSyncDocumentPermission", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateSyncDocumentPermissionRequest", + "properties": { + "Read": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can read the Sync Document." + }, + "Write": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can update the Sync Document." + }, + "Manage": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can delete the Sync Document." + } + }, + "required": [ + "Read", + "Write", + "Manage" + ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } + } + } + } + } } }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" + "parent": "/Services/{ServiceSid}/Documents/{Sid}", + "mountName": "document_permissions", + "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of all Permissions applying to a Sync Document.", + "tags": [ + "PreviewSyncDocumentPermission" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "FieldTypeSid", + "name": "DocumentSid", "in": "path", - "description": "", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, - { - "name": "Language", - "in": "query", - "description": "An ISO language-country string of the value. For example: *en-US*", - "schema": { - "type": "string" - } - }, { "name": "PageSize", "in": "query", @@ -10784,25 +9324,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandFieldValueResponse", + "title": "ListSyncDocumentPermissionResponse", "properties": { - "field_values": { + "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10811,17 +9353,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -10835,115 +9416,56 @@ { "accountSid_authToken": [] } - ], - "operationId": "ListUnderstandFieldValue", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "FieldTypeSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateUnderstandFieldValue", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandFieldValueRequest", - "properties": { - "Language": { - "type": "string", - "description": "An ISO language-country string of the value." - }, - "Value": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - }, - "SynonymOf": { - "type": "string", - "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym." - } - }, - "required": [ - "Language", - "Value" - ] - } - } - } - } + ], + "operationId": "ListSyncDocumentPermission" } }, - "/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { + "/Sync/Services/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "dependentProperties": { + "documents": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Documents" + }, + "sync_lists": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists" + }, + "sync_maps": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps" + } + }, + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "PreviewSyncService" + ], "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "Sid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } @@ -10953,7 +9475,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" + "$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 + } + } } } }, @@ -10965,29 +9507,54 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandModelBuild", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncService" }, - "post": { + "delete": { "description": "", + "tags": [ + "PreviewSyncService" + ], "parameters": [ { - "name": "AssistantSid", + "name": "Sid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true - }, + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncService" + }, + "post": { + "description": "", + "tags": [ + "PreviewSyncService" + ], + "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } @@ -10997,7 +9564,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" + "$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 + } + } } } }, @@ -11009,52 +9596,113 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandModelBuild", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateSyncService", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandModelBuildRequest", + "title": "UpdateSyncServiceRequest", "properties": { - "UniqueName": { + "WebhookUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "FriendlyName": { "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1" + "description": "" + }, + "ReachabilityWebhooksEnabled": { + "type": "boolean", + "description": "" + }, + "AclEnabled": { + "type": "boolean", + "description": "" + } + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true } } } } } } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" + } + }, + "/Sync/Services": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "documents": { + "mapping": { + "service_sid": "sid" }, - "required": true + "resource_url": "/Sync/Services/{service_sid}/Documents" }, - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string" + "sync_lists": { + "mapping": { + "service_sid": "sid" }, - "required": true + "resource_url": "/Sync/Services/{service_sid}/Lists" + }, + "sync_maps": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps" } + }, + "pathType": "list" + }, + "post": { + "description": "", + "tags": [ + "PreviewSyncService" ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": true + } + } + } + } + }, + "description": "Created" } }, "security": [ @@ -11062,36 +9710,52 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandModelBuild", - "x-maturity": [ - "Preview" - ] - } - }, - "/understand/Assistants/{AssistantSid}/ModelBuilds": { - "servers": [ - { - "url": "https://preview.twilio.com" + "operationId": "CreateSyncService", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncServiceRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "" + }, + "WebhookUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "ReachabilityWebhooksEnabled": { + "type": "boolean", + "description": "" + }, + "AclEnabled": { + "type": "boolean", + "description": "" + } + } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true + } + } + } + } + } } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{Sid}" }, "get": { "description": "", + "tags": [ + "PreviewSyncService" + ], "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "PageSize", "in": "query", @@ -11126,25 +9790,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandModelBuildResponse", + "title": "ListSyncServiceResponse", "properties": { - "model_builds": { + "services": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" + "$ref": "#/components/schemas/preview.sync.service" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -11153,121 +9819,130 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListUnderstandModelBuild", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateUnderstandModelBuild", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandModelBuildRequest", - "properties": { - "StatusCallback": { - "type": "string", - "format": "uri", - "description": "" + }, + "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": [] + } }, - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1" + "readFull": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": false + } + ] + } } } } - } + }, + "description": "OK" } - } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListSyncService" } }, - "/understand/Assistants/{AssistantSid}/Queries/{Sid}": { + "/Sync/Services/{ServiceSid}/Lists/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "dependentProperties": { + "sync_list_items": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" + }, + "sync_list_permissions": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_lists", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "PreviewSyncSyncList" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { "type": "string" }, @@ -11279,7 +9954,26 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" + "$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" + } + } } } }, @@ -11291,27 +9985,30 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandQuery", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncList" }, - "post": { + "delete": { "description": "", + "tags": [ + "PreviewSyncSyncList" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { "type": "string" }, @@ -11319,15 +10016,8 @@ } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -11335,59 +10025,86 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandQuery", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateUnderstandQueryRequest", - "properties": { - "SampleSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "description": "An optional reference to the Sample created from this query." - }, - "Status": { - "type": "string", - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded" - } - } - } - } - } + "operationId": "DeleteSyncSyncList" + } + }, + "/Sync/Services/{ServiceSid}/Lists": { + "servers": [ + { + "url": "https://preview.twilio.com" } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "sync_list_items": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" + }, + "sync_list_permissions": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_lists", + "pathType": "list" }, - "delete": { + "post": { "description": "", + "tags": [ + "PreviewSyncSyncList" + ], "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", + "name": "ServiceSid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "201": { + "content": { + "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" + } + } + } + } + }, + "description": "Created" } }, "security": [ @@ -11395,60 +10112,49 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandQuery", - "x-maturity": [ - "Preview" - ] - } - }, - "/understand/Assistants/{AssistantSid}/Queries": { - "servers": [ - { - "url": "https://preview.twilio.com" + "operationId": "CreateSyncSyncList", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncSyncListRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "" + } + } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name" + } + } + } + } + } } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{Sid}" }, "get": { "description": "", + "tags": [ + "PreviewSyncSyncList" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, - { - "name": "Language", - "in": "query", - "description": "An ISO language-country string of the sample.", - "schema": { - "type": "string" - } - }, - { - "name": "ModelBuild", - "in": "query", - "description": "The Model Build Sid or unique name of the Model Build to be queried.", - "schema": { - "type": "string" - } - }, - { - "name": "Status", - "in": "query", - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", - "schema": { - "type": "string" - } - }, { "name": "PageSize", "in": "query", @@ -11483,25 +10189,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandQueryResponse", + "title": "ListSyncSyncListResponse", "properties": { - "queries": { + "lists": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.query" + "$ref": "#/components/schemas/preview.sync.service.sync_list" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -11510,150 +10218,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" } } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListUnderstandQuery", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the parent Assistant.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateUnderstandQuery", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandQueryRequest", - "properties": { - "Language": { - "type": "string", - "description": "An ISO language-country string of the sample." - }, - "Query": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long." - }, - "Tasks": { - "type": "string", - "description": "Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated *task-unique-name-1*, *task-unique-name-2*" - }, - "ModelBuild": { - "type": "string", - "description": "The Model Build Sid or unique name of the Model Build to be queried." + }, + "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" + } + } }, - "Field": { - "type": "string", - "description": "Constraints the query to a given Field with an task. Useful when you know the Field you are expecting. It accepts one field in the format *task-unique-name-1*:*field-unique-name*" + "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" + } + } } - }, - "required": [ - "Language", - "Query" - ] + } } - } + }, + "description": "OK" } - } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListSyncSyncList" } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_items", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "PreviewSyncSyncListItem" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "ListSid", "in": "path", - "description": "The unique ID of the Task associated with this Sample.", + "description": "", "schema": { "type": "string" }, "required": true }, { - "name": "Sid", + "name": "Index", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" + "type": "integer" }, "required": true } @@ -11663,7 +10345,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + "$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" + } + } } } }, @@ -11675,43 +10373,108 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandSample", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncListItem" }, - "post": { + "delete": { "description": "", + "tags": [ + "PreviewSyncSyncListItem" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "ListSid", "in": "path", - "description": "The unique ID of the Task associated with this Sample.", + "description": "", "schema": { "type": "string" }, "required": true }, { - "name": "Sid", + "name": "Index", + "in": "path", + "description": "", + "schema": { + "type": "integer" + }, + "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncSyncListItem" + }, + "post": { + "description": "", + "tags": [ + "PreviewSyncSyncListItem" + ], + "parameters": [ + { + "name": "ServiceSid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Index", + "in": "path", + "description": "", + "schema": { + "type": "integer" }, "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } } ], "responses": { @@ -11719,7 +10482,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + "$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" + } + } } } }, @@ -11731,72 +10510,101 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandSample", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateSyncSyncListItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandSampleRequest", + "title": "UpdateSyncSyncListItemRequest", "properties": { - "Language": { - "type": "string", - "description": "An ISO language-country string of the sample." - }, - "TaggedText": { - "type": "string", - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." - }, - "SourceChannel": { - "type": "string", - "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null" + "Data": { + "description": "" + } + }, + "required": [ + "Data" + ] + }, + "examples": { + "update": { + "value": { + "Data": "{}" } } } } } } + } + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_items", + "pathType": "list" }, - "delete": { + "post": { "description": "", + "tags": [ + "PreviewSyncSyncListItem" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "ListSid", "in": "path", - "description": "The unique ID of the Task associated with this Sample.", + "description": "", "schema": { "type": "string" }, "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" - }, - "required": true } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + } + } + } + }, + "description": "Created" } }, "security": [ @@ -11804,51 +10612,108 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandSample", - "x-maturity": [ - "Preview" - ] - } - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { - "servers": [ - { - "url": "https://preview.twilio.com" + "operationId": "CreateSyncSyncListItem", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncSyncListItemRequest", + "properties": { + "Data": { + "description": "" + } + }, + "required": [ + "Data" + ] + }, + "examples": { + "create": { + "value": { + "Data": "{}" + } + } + } + } + } } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" }, "get": { "description": "", + "tags": [ + "PreviewSyncSyncListItem" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "ListSid", "in": "path", - "description": "The unique ID of the Task associated with this Sample.", + "description": "", "schema": { "type": "string" }, "required": true }, { - "name": "Language", + "name": "Order", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } + } + }, + { + "name": "From", "in": "query", - "description": "An ISO language-country string of the sample.", + "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } + } + }, + { + "name": "Bounds", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } } }, { @@ -11885,25 +10750,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandSampleResponse", + "title": "ListSyncSyncListItemResponse", "properties": { - "samples": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -11912,17 +10779,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "items": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } } @@ -11937,103 +10845,53 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandSample", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncListItem" + } + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_permissions", + "pathType": "instance" }, - "post": { - "description": "", + "get": { + "description": "Fetch a specific Sync List Permission.", + "tags": [ + "PreviewSyncSyncListPermission" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "ListSid", "in": "path", - "description": "The unique ID of the Task associated with this Sample.", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateUnderstandSample", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandSampleRequest", - "properties": { - "Language": { - "type": "string", - "description": "An ISO language-country string of the sample." - }, - "TaggedText": { - "type": "string", - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." - }, - "SourceChannel": { - "type": "string", - "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null" - } - }, - "required": [ - "Language", - "TaggedText" - ] - } - } - } - } - } - }, - "/understand/Assistants/{AssistantSid}/StyleSheet": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "Returns Style sheet JSON object for this Assistant", - "parameters": [ + }, { - "name": "AssistantSid", + "name": "Identity", "in": "path", - "description": "The unique ID of the Assistant", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -12045,7 +10903,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" + "$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" + } + } } } }, @@ -12057,96 +10929,39 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandStyleSheet", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncListPermission" }, - "post": { - "description": "Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}.", + "delete": { + "description": "Delete a specific Sync List Permission.", + "tags": [ + "PreviewSyncSyncListPermission" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateUnderstandStyleSheet", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateUnderstandStyleSheetRequest", - "properties": { - "StyleSheet": { - "description": "The JSON Style sheet string" - } - } - } - } - } - } - } - }, - "/understand/Assistants/{AssistantSid}/Tasks/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "field": "{assistant_sid: assistant_sid, task_sid: sid}", - "sample": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_actions": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_statistics": "{assistant_sid: assistant_sid, task_sid: sid}" - }, - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ + }, { - "name": "AssistantSid", + "name": "ListSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Sid", + "name": "Identity", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -12154,15 +10969,8 @@ } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -12170,27 +10978,39 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandTask", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncListPermission" }, "post": { - "description": "", + "description": "Update an identity's access to a specific Sync List.", + "tags": [ + "PreviewSyncSyncListPermission" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "The unique SID identifier of the Sync Service Instance.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Sid", + "name": "Identity", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -12202,7 +11022,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" + "$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" + } + } } } }, @@ -12214,102 +11048,82 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandTask", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateSyncSyncListPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandTaskRequest", + "title": "UpdateSyncSyncListPermissionRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." - }, - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "Read": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can read the Sync List." }, - "Actions": { - "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique." + "Write": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." }, - "ActionsUrl": { - "type": "string", - "format": "uri", - "description": "User-provided HTTP endpoint where from the assistant fetches actions" + "Manage": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can delete the Sync List." + } + }, + "required": [ + "Read", + "Write", + "Manage" + ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" } } } } } } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteUnderstandTask", - "x-maturity": [ - "Preview" - ] } }, - "/understand/Assistants/{AssistantSid}/Tasks": { + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "field": "{assistant_sid: assistant_sid, task_sid: sid}", - "sample": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_actions": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_statistics": "{assistant_sid: assistant_sid, task_sid: sid}" - }, - "parent": "/Assistants/{Sid}" + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_permissions", + "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of all Permissions applying to a Sync List.", + "tags": [ + "PreviewSyncSyncListPermission" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, @@ -12349,25 +11163,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandTaskResponse", + "title": "ListSyncSyncListPermissionResponse", "properties": { - "tasks": { + "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -12376,17 +11192,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -12401,152 +11256,60 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandTask", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateUnderstandTask", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandTaskRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - }, - "FriendlyName": { - "type": "string", - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." - }, - "Actions": { - "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique." - }, - "ActionsUrl": { - "type": "string", - "format": "uri", - "description": "User-provided HTTP endpoint where from the assistant fetches actions" - } - }, - "required": [ - "UniqueName" - ] - } - } - } - } + "operationId": "ListSyncSyncListPermission" } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { + "/Sync/Services/{ServiceSid}/Maps/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "mountName": "task_actions", - "className": "task_actions" - }, - "get": { - "description": "Returns JSON actions for this Task.", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the parent Assistant.", - "schema": { - "type": "string" + "dependentProperties": { + "sync_map_items": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" }, - "required": true + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" }, - { - "name": "TaskSid", - "in": "path", - "description": "The unique ID of the Task.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" - } - } + "sync_map_permissions": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" }, - "description": "OK" + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchUnderstandTaskActions", - "x-maturity": [ - "Preview" - ] + "parent": "/Services/{Sid}", + "mountName": "sync_maps", + "pathType": "instance" }, - "post": { - "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", + "get": { + "description": "", + "tags": [ + "PreviewSyncSyncMap" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "Sid", "in": "path", - "description": "The unique ID of the Task.", + "description": "", "schema": { "type": "string" }, @@ -12558,7 +11321,26 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" + "$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" + } + } } } }, @@ -12570,56 +11352,30 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandTaskActions", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateUnderstandTaskActionsRequest", - "properties": { - "Actions": { - "description": "The JSON actions that instruct the Assistant how to perform this task." - } - } - } - } - } - } - } - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "className": "task_statistics" + "operationId": "FetchSyncSyncMap" }, - "get": { + "delete": { "description": "", + "tags": [ + "PreviewSyncSyncMap" + ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "Sid", "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "description": "", "schema": { "type": "string" }, @@ -12627,15 +11383,8 @@ } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_statistics" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -12643,49 +11392,86 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandTaskStatistics", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncMap" } }, - "/wireless/Commands/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance" + "dependentProperties": { + "sync_map_items": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" + }, + "sync_map_permissions": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_maps", + "pathType": "list" }, - "get": { + "post": { "description": "", + "tags": [ + "PreviewSyncSyncMap" + ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DC[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.command" + "$ref": "#/components/schemas/preview.sync.service.sync_map" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -12693,57 +11479,48 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWirelessCommand", - "x-maturity": [ - "Preview" - ] - } - }, - "/wireless/Commands": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "Device", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - }, - { - "name": "Sim", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - }, - { - "name": "Status", - "in": "query", - "description": "", - "schema": { - "type": "string" + "operationId": "CreateSyncSyncMap", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncSyncMapRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "" + } + } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name" + } + } + } } - }, + } + } + }, + "get": { + "description": "", + "tags": [ + "PreviewSyncSyncMap" + ], + "parameters": [ { - "name": "Direction", - "in": "query", + "name": "ServiceSid", + "in": "path", "description": "", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true }, { "name": "PageSize", @@ -12779,25 +11556,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListWirelessCommandResponse", + "title": "ListSyncSyncMapResponse", "properties": { - "commands": { + "maps": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.wireless.command" + "$ref": "#/components/schemas/preview.sync.service.sync_map" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -12806,17 +11585,61 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "maps": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "maps": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" } } } @@ -12831,23 +11654,85 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessCommand", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncMap" + } + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_items", + "pathType": "instance" }, - "post": { + "get": { "description": "", + "tags": [ + "PreviewSyncSyncMapItem" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Key", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.command" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -12855,93 +11740,105 @@ "accountSid_authToken": [] } ], - "operationId": "CreateWirelessCommand", - "x-maturity": [ - "Preview" + "operationId": "FetchSyncSyncMapItem" + }, + "delete": { + "description": "", + "tags": [ + "PreviewSyncSyncMapItem" ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateWirelessCommandRequest", - "properties": { - "Command": { - "type": "string", - "description": "" - }, - "Device": { - "type": "string", - "description": "" - }, - "Sim": { - "type": "string", - "description": "" - }, - "CallbackMethod": { - "type": "string", - "description": "" - }, - "CallbackUrl": { - "type": "string", - "format": "uri", - "description": "" - }, - "CommandMode": { - "type": "string", - "description": "" - }, - "IncludeSid": { - "type": "string", - "description": "" - } - }, - "required": [ - "Command" - ] - } + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Key", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" } } - } - } - }, - "/wireless/RatePlans": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list" + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncSyncMapItem" }, - "get": { + "post": { "description": "", + "tags": [ + "PreviewSyncSyncMapItem" + ], "parameters": [ { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "name": "ServiceSid", + "in": "path", + "description": "", "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true }, { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", + "name": "MapSid", + "in": "path", + "description": "", "schema": { - "type": "integer", - "minimum": 0 - } + "type": "string" + }, + "required": true + }, + { + "name": "Key", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true }, { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", "schema": { "type": "string" } @@ -12952,46 +11849,21 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListWirelessRatePlanResponse", - "properties": { - "rate_plans": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } + "$ref": "#/components/schemas/preview.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" } } } @@ -13005,84 +11877,27 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessRatePlan", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateWirelessRatePlan", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateSyncSyncMapItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateWirelessRatePlanRequest", + "title": "UpdateSyncSyncMapItemRequest", "properties": { - "UniqueName": { - "type": "string", - "description": "" - }, - "FriendlyName": { - "type": "string", - "description": "" - }, - "DataEnabled": { - "type": "boolean", - "description": "" - }, - "DataLimit": { - "type": "integer", - "description": "" - }, - "DataMetering": { - "type": "string", - "description": "" - }, - "MessagingEnabled": { - "type": "boolean", - "description": "" - }, - "VoiceEnabled": { - "type": "boolean", - "description": "" - }, - "CommandsEnabled": { - "type": "boolean", - "description": "" - }, - "NationalRoamingEnabled": { - "type": "boolean", - "description": "" - }, - "InternationalRoaming": { - "type": "array", - "items": { - "type": "string" - }, + "Data": { "description": "" } + }, + "required": [ + "Data" + ] + }, + "examples": { + "update": { + "value": { + "Data": "{}" + } } } } @@ -13090,57 +11905,39 @@ } } }, - "/wireless/RatePlans/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { "servers": [ { "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", + "pathType": "list" }, - "get": { + "post": { "description": "", + "tags": [ + "PreviewSyncSyncMapItem" + ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchWirelessRatePlan", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ + }, { - "name": "Sid", + "name": "MapSid", "in": "path", "description": "", "schema": { @@ -13150,15 +11947,31 @@ } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -13166,47 +11979,238 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateWirelessRatePlan", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateSyncSyncMapItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateWirelessRatePlanRequest", + "title": "CreateSyncSyncMapItemRequest", "properties": { - "UniqueName": { + "Key": { "type": "string", "description": "" }, - "FriendlyName": { - "type": "string", + "Data": { "description": "" } + }, + "required": [ + "Key", + "Data" + ] + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "Key": "key" + } } } } } } }, - "delete": { + "get": { "description": "", + "tags": [ + "PreviewSyncSyncMapItem" + ], "parameters": [ { - "name": "Sid", - "in": "path", - "description": "", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Order", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } + } + }, + { + "name": "From", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } + } + }, + { + "name": "Bounds", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", "schema": { "type": "string" - }, - "required": true + } } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListSyncSyncMapItemResponse", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + } + }, + "meta": { + "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": { + "items": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + } + } + } + }, + "description": "OK" } }, "security": [ @@ -13214,33 +12218,53 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWirelessRatePlan", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncMapItem" } }, - "/wireless/Sims/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "usage": "{sim_sid: sid}" - } + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_permissions", + "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch a specific Sync Map Permission.", + "tags": [ + "PreviewSyncSyncMapPermission" + ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -13252,7 +12276,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.sim" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } } } }, @@ -13264,166 +12302,158 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWirelessSim", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncMapPermission" }, - "post": { - "description": "", + "delete": { + "description": "Delete a specific Sync Map Permission.", + "tags": [ + "PreviewSyncSyncMapPermission" + ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.sim" - } - } + }, + { + "name": "MapSid", + "in": "path", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "schema": { + "type": "string" }, - "description": "OK" - } - }, - "security": [ + "required": true + }, { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateWirelessSim", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateWirelessSimRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "" - }, - "CallbackMethod": { - "type": "string", - "description": "" - }, - "CallbackUrl": { - "type": "string", - "format": "uri", - "description": "" - }, - "FriendlyName": { - "type": "string", - "description": "" - }, - "RatePlan": { - "type": "string", - "description": "" - }, - "Status": { - "type": "string", - "description": "" - }, - "CommandsCallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "" - }, - "CommandsCallbackUrl": { - "type": "string", - "format": "uri", - "description": "" - }, - "SmsFallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "" - }, - "SmsFallbackUrl": { - "type": "string", - "format": "uri", - "description": "" - }, - "SmsMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "" - }, - "SmsUrl": { - "type": "string", - "format": "uri", - "description": "" - }, - "VoiceFallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "" - }, - "VoiceFallbackUrl": { - "type": "string", - "format": "uri", - "description": "" + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncSyncMapPermission" + }, + "post": { + "description": "Update an identity's access to a specific Sync Map.", + "tags": [ + "PreviewSyncSyncMapPermission" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "The unique SID identifier of the Sync Service Instance.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "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" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateSyncSyncMapPermission", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateSyncSyncMapPermissionRequest", + "properties": { + "Read": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can read the Sync Map." }, - "VoiceMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "" + "Write": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." }, - "VoiceUrl": { - "type": "string", - "format": "uri", - "description": "" + "Manage": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can delete the Sync Map." + } + }, + "required": [ + "Read", + "Write", + "Manage" + ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" } } } @@ -13432,62 +12462,45 @@ } } }, - "/wireless/Sims": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "usage": "{sim_sid: sid}" - } + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_permissions", + "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of all Permissions applying to a Sync Map.", + "tags": [ + "PreviewSyncSyncMapPermission" + ], "parameters": [ { - "name": "Status", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - }, - { - "name": "Iccid", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - }, - { - "name": "RatePlan", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - }, - { - "name": "EId", - "in": "query", + "name": "ServiceSid", + "in": "path", "description": "", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true }, { - "name": "SimRegistrationCode", - "in": "query", - "description": "", + "name": "MapSid", + "in": "path", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", "schema": { "type": "string" - } + }, + "required": true }, { "name": "PageSize", @@ -13523,25 +12536,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListWirelessSimResponse", + "title": "ListSyncSyncMapPermissionResponse", "properties": { - "sims": { + "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.wireless.sim" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -13550,17 +12565,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -13575,74 +12629,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessSim", - "x-maturity": [ - "Preview" - ] - } - }, - "/wireless/Sims/{SimSid}/Usage": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Sims/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "SimSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "End", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - }, - { - "name": "Start", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.sim.usage" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchWirelessUsage", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncMapPermission" } } }, @@ -13651,10 +12638,20 @@ "url": "https://preview.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "PreviewHostedNumbersAuthorizationDocument" + }, + { + "name": "PreviewHostedNumbersDependentHostedNumberOrder" + }, + { + "name": "PreviewHostedNumbersHostedNumberOrder" + } + ], + "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 help@twilio.com." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_pricing_v1.json b/spec/json/twilio_pricing_v1.json index 155658e3..2841e9e5 100644 --- a/spec/json/twilio_pricing_v1.json +++ b/spec/json/twilio_pricing_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "pricing.v1.messaging": { "type": "object", @@ -396,12 +402,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -417,7 +417,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -427,7 +427,7 @@ "url": "https://pricing.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "name" @@ -449,11 +449,14 @@ "inbound_sms_prices", "price_unit" ], - "pathType": "list", - "parent": "/Messaging" + "parent": "/Messaging", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "PricingV1Country" + ], "parameters": [ { "name": "PageSize", @@ -498,16 +501,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -516,17 +521,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "countries": [], + "meta": { + "first_page_url": "https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "countries": [ + { + "country": "country", + "iso_country": "US", + "url": "https://pricing.twilio.com/v1/Messaging/Countries/US" + } + ], + "meta": { + "first_page_url": "https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0" } } } @@ -541,10 +580,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessagingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessagingCountry" } }, "/v1/Messaging/Countries/{IsoCountry}": { @@ -561,11 +597,14 @@ "inbound_sms_prices", "price_unit" ], - "pathType": "instance", - "parent": "/Messaging" + "parent": "/Messaging", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "PricingV1Country" + ], "parameters": [ { "name": "IsoCountry", @@ -584,6 +623,37 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v1.messaging.messaging_country-instance" + }, + "examples": { + "fetch": { + "value": { + "country": "country", + "inbound_sms_prices": [ + { + "base_price": "0.05", + "current_price": "0.05", + "number_type": "mobile" + } + ], + "iso_country": "US", + "outbound_sms_prices": [ + { + "carrier": "att", + "mcc": "foo", + "mnc": "bar", + "prices": [ + { + "base_price": "0.05", + "current_price": "0.05", + "number_type": "mobile" + } + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v1/Messaging/Countries/US" + } + } } } }, @@ -595,10 +665,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessagingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessagingCountry" } }, "/v1/PhoneNumbers": { @@ -607,7 +674,7 @@ "url": "https://pricing.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "name" @@ -627,11 +694,14 @@ "country", "price_unit" ], - "pathType": "list", - "parent": "/PhoneNumbers" + "parent": "/PhoneNumbers", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "PricingV1Country" + ], "parameters": [ { "name": "PageSize", @@ -676,16 +746,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -694,17 +766,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "countries": [ + { + "country": "Austria", + "iso_country": "AT", + "url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries/AT" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0", + "next_page_url": null, + "key": "countries" + } + } + }, + "readEmpty": { + "value": { + "countries": [], + "meta": { + "first_page_url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0" } } } @@ -719,10 +825,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListPhoneNumberCountry" } }, "/v1/PhoneNumbers/Countries/{IsoCountry}": { @@ -737,11 +840,14 @@ "country", "price_unit" ], - "pathType": "instance", - "parent": "/PhoneNumbers" + "parent": "/PhoneNumbers", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "PricingV1Country" + ], "parameters": [ { "name": "IsoCountry", @@ -760,6 +866,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v1.phone_number.phone_number_country-instance" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "iso_country": "US", + "phone_number_prices": [ + { + "number_type": "local", + "base_price": "1.00", + "current_price": "1.00" + }, + { + "number_type": "toll free", + "base_price": "2.00", + "current_price": "2.00" + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries/US" + } + } } } }, @@ -771,10 +899,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumberCountry" } }, "/v1/Voice": { @@ -783,7 +908,7 @@ "url": "https://pricing.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "name" @@ -803,11 +928,14 @@ "country", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "PricingV1Country" + ], "parameters": [ { "name": "PageSize", @@ -852,16 +980,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -870,17 +1000,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "countries": [ + { + "country": "Andorra", + "iso_country": "AD", + "url": "https://pricing.twilio.com/v1/Voice/Countries/AD" + } + ], + "meta": { + "first_page_url": "https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "countries": [], + "meta": { + "first_page_url": "https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0" } } } @@ -895,10 +1059,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListVoiceCountry" } }, "/v1/Voice/Countries/{IsoCountry}": { @@ -913,11 +1074,14 @@ "country", "price_unit" ], - "pathType": "instance", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "PricingV1Country" + ], "parameters": [ { "name": "IsoCountry", @@ -936,6 +1100,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v1.voice.voice_country-instance" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "inbound_call_prices": [ + { + "current_price": "0.0085", + "number_type": "local", + "base_price": "0.0085" + }, + { + "current_price": "0.022", + "number_type": "toll free", + "base_price": "0.022" + } + ], + "iso_country": "US", + "outbound_prefix_prices": [ + { + "prefixes": [ + "1907" + ], + "current_price": "0.090", + "friendly_name": "Programmable Outbound Minute - United States - Alaska", + "base_price": "0.090" + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v1/Voice/Countries/US" + } + } } } }, @@ -947,10 +1143,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceCountry" } }, "/v1/Voice/Numbers/{Number}": { @@ -967,11 +1160,14 @@ "inbound_call_price", "price_unit" ], - "pathType": "instance", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "PricingV1Number" + ], "parameters": [ { "name": "Number", @@ -990,6 +1186,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v1.voice.voice_number" + }, + "examples": { + "fetch": { + "value": { + "country": "Iran", + "inbound_call_price": { + "base_price": null, + "current_price": null, + "number_type": null + }, + "iso_country": "IR", + "number": "+987654321", + "outbound_call_price": { + "base_price": "0.255", + "current_price": "0.255" + }, + "price_unit": "USD", + "url": "https://pricing.twilio.com/v1/Voice/Numbers/+987654321" + } + } } } }, @@ -1001,10 +1217,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceNumber" } }, "/v1/Voice/Numbers": { @@ -1021,8 +1234,8 @@ "inbound_call_price", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" } } }, @@ -1031,10 +1244,17 @@ "url": "https://pricing.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "PricingV1Country" + }, + { + "name": "PricingV1Number" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_pricing_v2.json b/spec/json/twilio_pricing_v2.json index 36b2bb60..6ca39b70 100644 --- a/spec/json/twilio_pricing_v2.json +++ b/spec/json/twilio_pricing_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "pricing.v2.trunking_country": { "type": "object", @@ -395,12 +401,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -416,7 +416,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -436,6 +436,9 @@ }, "get": { "description": "", + "tags": [ + "PricingV2Country" + ], "parameters": [ { "name": "PageSize", @@ -480,16 +483,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -498,17 +503,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "countries": [ + { + "country": "Andorra", + "iso_country": "AD", + "url": "https://pricing.twilio.com/v2/Trunking/Countries/AD" + } + ], + "meta": { + "first_page_url": "https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "countries": [], + "meta": { + "first_page_url": "https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0" } } } @@ -523,10 +562,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrunkingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrunkingCountry" } }, "/v2/Trunking/Countries/{IsoCountry}": { @@ -545,6 +581,9 @@ }, "get": { "description": "Fetch a specific Country.", + "tags": [ + "PricingV2Country" + ], "parameters": [ { "name": "IsoCountry", @@ -563,6 +602,79 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v2.trunking_country-instance" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "originating_call_prices": [ + { + "base_price": null, + "current_price": "0.0085", + "number_type": "local" + }, + { + "base_price": null, + "current_price": "0.022", + "number_type": "toll free" + } + ], + "iso_country": "US", + "terminating_prefix_prices": [ + { + "base_price": null, + "current_price": "0.090", + "destination_prefixes": [ + "1907" + ], + "friendly_name": "Outbound Trunking Minute - United States - Alaska", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": null, + "current_price": "0.013", + "destination_prefixes": [ + "1808" + ], + "friendly_name": "Outbound Trunking Minute - United States - Hawaii", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": null, + "current_price": "0.013", + "destination_prefixes": [ + "1800", + "1844", + "1855", + "1866", + "1877", + "1888" + ], + "friendly_name": "Outbound Trunking Minute - United States & Canada - Toll Free", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": null, + "current_price": "0.013", + "destination_prefixes": [ + "1" + ], + "friendly_name": "Outbound Trunking Minute - United States & Canada", + "origination_prefixes": [ + "ALL" + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v2/Trunking/Countries/US" + } + } } } }, @@ -574,10 +686,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunkingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunkingCountry" } }, "/v2/Trunking/Numbers/{DestinationNumber}": { @@ -597,6 +706,9 @@ }, "get": { "description": "Fetch pricing information for a specific destination and, optionally, origination phone number.", + "tags": [ + "PricingV2Number" + ], "parameters": [ { "name": "DestinationNumber", @@ -615,6 +727,11 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "fetchWithOrigination": { + "value": "+15105556789" + } } } ], @@ -624,6 +741,64 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v2.trunking_number" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "destination_number": "+18001234567", + "originating_call_price": { + "base_price": null, + "current_price": null, + "number_type": null + }, + "iso_country": "US", + "origination_number": null, + "terminating_prefix_prices": [ + { + "base_price": null, + "current_price": "0.013", + "destination_prefixes": [ + "1800" + ], + "friendly_name": "Trunking Outbound Minute - United States Zone 1b", + "origination_prefixes": [ + "ALL" + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v2/Trunking/Numbers/+18001234567" + } + }, + "fetchWithOrigination": { + "value": { + "country": "United States", + "destination_number": "+18001234567", + "originating_call_price": { + "base_price": null, + "current_price": "0.013", + "number_type": "tollfree" + }, + "iso_country": "US", + "origination_number": "+15105556789", + "terminating_prefix_prices": [ + { + "base_price": null, + "current_price": "0.001", + "destination_prefixes": [ + "1800" + ], + "friendly_name": "Trunking Outbound Minute - United States - Toll Free", + "origination_prefixes": [ + "ALL" + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v2/Trunking/Numbers/+18001234567" + } + } } } }, @@ -635,10 +810,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunkingNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunkingNumber" } }, "/v2/Trunking/Numbers": { @@ -683,11 +855,14 @@ "country", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "PricingV2Country" + ], "parameters": [ { "name": "PageSize", @@ -732,16 +907,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -750,17 +927,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "countries": [ + { + "country": "Andorra", + "iso_country": "AD", + "url": "https://pricing.twilio.com/v2/Voice/Countries/AD" + } + ], + "meta": { + "first_page_url": "https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "countries": [], + "meta": { + "first_page_url": "https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0" } } } @@ -775,10 +986,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListVoiceCountry" } }, "/v2/Voice/Countries/{IsoCountry}": { @@ -793,11 +1001,14 @@ "country", "price_unit" ], - "pathType": "instance", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "instance" }, "get": { "description": "Fetch a specific Country.", + "tags": [ + "PricingV2Country" + ], "parameters": [ { "name": "IsoCountry", @@ -816,6 +1027,79 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v2.voice.voice_country-instance" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "inbound_call_prices": [ + { + "base_price": "0.0085", + "current_price": "0.0085", + "number_type": "local" + }, + { + "base_price": "0.022", + "current_price": "0.022", + "number_type": "toll free" + } + ], + "iso_country": "US", + "outbound_prefix_prices": [ + { + "base_price": "0.090", + "current_price": "0.090", + "destination_prefixes": [ + "1907" + ], + "friendly_name": "Programmable Outbound Minute - United States - Alaska", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": "0.013", + "current_price": "0.013", + "destination_prefixes": [ + "1808" + ], + "friendly_name": "Programmable Outbound Minute - United States - Hawaii", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": "0.013", + "current_price": "0.013", + "destination_prefixes": [ + "1800", + "1844", + "1855", + "1866", + "1877", + "1888" + ], + "friendly_name": "Programmable Outbound Minute - United States & Canada - Toll Free", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": "0.013", + "current_price": "0.013", + "destination_prefixes": [ + "1" + ], + "friendly_name": "Programmable Outbound Minute - United States & Canada", + "origination_prefixes": [ + "ALL" + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v2/Voice/Countries/US" + } + } } } }, @@ -827,10 +1111,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceCountry" } }, "/v2/Voice/Numbers/{DestinationNumber}": { @@ -846,11 +1127,14 @@ "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.", + "tags": [ + "PricingV2Number" + ], "parameters": [ { "name": "DestinationNumber", @@ -869,6 +1153,11 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "fetch": { + "value": "+18001234567" + } } } ], @@ -878,6 +1167,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v2.voice.voice_number" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "destination_number": "+18001234567", + "inbound_call_price": { + "base_price": null, + "current_price": null, + "number_type": null + }, + "iso_country": "US", + "origination_number": "+987654321", + "outbound_call_prices": [ + { + "base_price": "0.013", + "current_price": "0.013", + "origination_prefixes": [ + "ALL" + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v2/Voice/Numbers/+18001234567" + } + } } } }, @@ -889,10 +1204,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceNumber" } }, "/v2/Voice/Numbers": { @@ -908,8 +1220,8 @@ "inbound_call_price", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" } } }, @@ -918,10 +1230,17 @@ "url": "https://pricing.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "PricingV2Country" + }, + { + "name": "PricingV2Number" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_proxy_v1.json b/spec/json/twilio_proxy_v1.json index 5b3ad9a0..3af9dd5b 100644 --- a/spec/json/twilio_proxy_v1.json +++ b/spec/json/twilio_proxy_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "proxy.v1.service.session.interaction": { "type": "object", @@ -39,7 +45,13 @@ "data": { "type": "string", "nullable": true, - "description": "A JSON string that includes the message body of message interactions (e.g. `{\"body\": \"hello\"}`) or the call duration (when available) of a call (e.g. `{\"duration\": \"5\"}`)." + "description": "A JSON string that includes the message body of message interactions (e.g. `{\"body\": \"hello\"}`) or the call duration (when available) of a call (e.g. `{\"duration\": \"5\"}`).", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -61,7 +73,7 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the inbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message." + "description": "The SID of the inbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message-resource)." }, "inbound_resource_status": { "type": "string", @@ -205,7 +217,13 @@ "data": { "type": "string", "nullable": true, - "description": "A JSON string that includes the message body sent to the participant. (e.g. `{\"body\": \"hello\"}`)" + "description": "A JSON string that includes the message body sent to the participant. (e.g. `{\"body\": \"hello\"}`)", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -384,7 +402,13 @@ "identifier": { "type": "string", "nullable": true, - "description": "The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters." + "description": "The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "proxy_identifier": { "type": "string", @@ -589,7 +613,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information." + "description": "The URL we call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information." }, "date_created": { "type": "string", @@ -837,12 +861,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -858,7 +876,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -868,18 +886,21 @@ "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).", + "tags": [ + "ProxyV1Interaction" + ], "parameters": [ { "name": "ServiceSid", @@ -924,6 +945,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session.interaction" + }, + "examples": { + "fetch": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": "{\"body\":\"some message\"}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "inbound_participant_sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "inbound_resource_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "inbound_resource_status": "sent", + "inbound_resource_type": "Message", + "inbound_resource_url": null, + "outbound_participant_sid": "KPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "outbound_resource_sid": "SMbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "outbound_resource_status": "sent", + "outbound_resource_type": "Message", + "outbound_resource_url": null, + "sid": "KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "message", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -935,13 +981,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchInteraction" }, "delete": { "description": "Delete a specific Interaction.", + "tags": [ + "ProxyV1Interaction" + ], "parameters": [ { "name": "ServiceSid", @@ -990,10 +1036,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions": { @@ -1002,18 +1045,21 @@ "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.", + "tags": [ + "ProxyV1Interaction" + ], "parameters": [ { "name": "ServiceSid", @@ -1082,16 +1128,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1100,17 +1148,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "interactions": [], + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0", + "page_size": 50, + "key": "interactions" } } } @@ -1125,10 +1187,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "ListInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions": { @@ -1137,18 +1196,21 @@ "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.", + "tags": [ + "ProxyV1MessageInteraction" + ], "parameters": [ { "name": "ServiceSid", @@ -1193,6 +1255,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session.participant.message_interaction" + }, + "examples": { + "create": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": "{\"body\":\"some message\"}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "participant_sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "inbound_participant_sid": null, + "inbound_resource_sid": null, + "inbound_resource_status": null, + "inbound_resource_type": null, + "inbound_resource_url": null, + "outbound_participant_sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "outbound_resource_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "outbound_resource_status": "sent", + "outbound_resource_type": "Message", + "outbound_resource_url": null, + "sid": "KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "message", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1205,9 +1293,6 @@ } ], "operationId": "CreateMessageInteraction", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1228,6 +1313,13 @@ "description": "Reserved. Not currently supported." } } + }, + "examples": { + "create": { + "value": { + "Body": "some message" + } + } } } } @@ -1243,6 +1335,9 @@ }, "get": { "description": "", + "tags": [ + "ProxyV1MessageInteraction" + ], "parameters": [ { "name": "ServiceSid", @@ -1323,16 +1418,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1341,17 +1438,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "interactions": [], + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions?PageSize=50&Page=0", + "page_size": 50, + "key": "interactions" } } } @@ -1366,10 +1477,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessageInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "ListMessageInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions/{Sid}": { @@ -1378,18 +1486,21 @@ "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": "", + "tags": [ + "ProxyV1MessageInteraction" + ], "parameters": [ { "name": "ServiceSid", @@ -1446,6 +1557,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session.participant.message_interaction" + }, + "examples": { + "fetch": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": "{\"body\":\"some message\"}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "participant_sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "inbound_participant_sid": null, + "inbound_resource_sid": null, + "inbound_resource_status": null, + "inbound_resource_type": null, + "inbound_resource_url": null, + "outbound_participant_sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "outbound_resource_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "outbound_resource_status": "sent", + "outbound_resource_type": "Message", + "outbound_resource_url": null, + "sid": "KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "message", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1457,10 +1594,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessageInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchMessageInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}": { @@ -1469,7 +1603,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1477,14 +1611,24 @@ "identifier", "proxy_identifier" ], - "pathType": "instance", "dependentProperties": { - "message_interaction": "{service_sid: service_sid, session_sid: session_sid, participant_sid: sid}" + "message_interactions": { + "mapping": { + "service_sid": "service_sid", + "session_sid": "session_sid", + "participant_sid": "sid" + }, + "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.", + "tags": [ + "ProxyV1Participant" + ], "parameters": [ { "name": "ServiceSid", @@ -1529,6 +1673,46 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session.participant" + }, + "examples": { + "fetch": { + "value": { + "sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identifier": "+14155551212", + "proxy_identifier": "+14155559999", + "proxy_identifier_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_deleted": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "message_interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions" + } + } + }, + "fetchChannel": { + "value": { + "sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identifier": "messenger:14155551212", + "proxy_identifier": "messenger:14155559999", + "proxy_identifier_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "a facebook user", + "date_deleted": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "message_interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions" + } + } + } } } }, @@ -1540,13 +1724,13 @@ "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.", + "tags": [ + "ProxyV1Participant" + ], "parameters": [ { "name": "ServiceSid", @@ -1595,10 +1779,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteParticipant", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteParticipant" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants": { @@ -1607,7 +1788,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1615,14 +1796,24 @@ "identifier", "proxy_identifier" ], - "pathType": "list", "dependentProperties": { - "message_interaction": "{service_sid: service_sid, session_sid: session_sid, participant_sid: sid}" + "message_interactions": { + "mapping": { + "service_sid": "service_sid", + "session_sid": "session_sid", + "participant_sid": "sid" + }, + "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.", + "tags": [ + "ProxyV1Participant" + ], "parameters": [ { "name": "ServiceSid", @@ -1691,16 +1882,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1709,18 +1902,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "page_size": 50, + "key": "participants" + }, + "participants": [] } } } @@ -1734,13 +1941,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListParticipant", - "x-maturity": [ - "Beta" - ] + "operationId": "ListParticipant" }, "post": { "description": "Add a new Participant to the Session", + "tags": [ + "ProxyV1Participant" + ], "parameters": [ { "name": "ServiceSid", @@ -1773,6 +1980,46 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session.participant" + }, + "examples": { + "create": { + "value": { + "sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identifier": "+14155551212", + "proxy_identifier": "+14155559999", + "proxy_identifier_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_deleted": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "message_interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions" + } + } + }, + "createChannel": { + "value": { + "sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identifier": "messenger:123456", + "proxy_identifier": "messenger:987654532", + "proxy_identifier_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "a facebook user", + "date_deleted": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "message_interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions" + } + } + } } } }, @@ -1785,9 +2032,6 @@ } ], "operationId": "CreateParticipant", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1818,6 +2062,21 @@ "required": [ "Identifier" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Identifier": "+14155551212" + } + }, + "createChannel": { + "value": { + "FriendlyName": "a facebook user", + "Identifier": "messenger:123456", + "ProxyIdentifier": "messenger:987654532" + } + } } } } @@ -1830,18 +2089,21 @@ "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.", + "tags": [ + "ProxyV1PhoneNumber" + ], "parameters": [ { "name": "ServiceSid", @@ -1862,6 +2124,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.phone_number" + }, + "examples": { + "create": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "phone_number": "+1987654321", + "friendly_name": "Friendly Name", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false, + "in_use": 0 + } + } } } }, @@ -1874,9 +2157,6 @@ } ], "operationId": "CreatePhoneNumber", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1901,6 +2181,13 @@ "description": "Whether the new phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information." } } + }, + "examples": { + "create": { + "value": { + "Sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1908,6 +2195,9 @@ }, "get": { "description": "Retrieve a list of all Phone Numbers in the Proxy Number Pool for a Service. A maximum of 100 records will be returned per page.", + "tags": [ + "ProxyV1PhoneNumber" + ], "parameters": [ { "name": "ServiceSid", @@ -1964,16 +2254,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1982,18 +2274,50 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "phone_numbers", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0" + }, + "phone_numbers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "phone_number": "+1987654321", + "friendly_name": "Friendly Name", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false, + "in_use": 0 + } + ] } } } @@ -2007,10 +2331,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "ListPhoneNumber" } }, "/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}": { @@ -2019,18 +2340,21 @@ "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.", + "tags": [ + "ProxyV1PhoneNumber" + ], "parameters": [ { "name": "ServiceSid", @@ -2067,13 +2391,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "DeletePhoneNumber" }, "get": { "description": "Fetch a specific Phone Number.", + "tags": [ + "ProxyV1PhoneNumber" + ], "parameters": [ { "name": "ServiceSid", @@ -2106,6 +2430,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.phone_number" + }, + "examples": { + "fetch": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "phone_number": "12345", + "friendly_name": "Friendly Name", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false, + "in_use": 0 + } + } } } }, @@ -2117,13 +2462,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPhoneNumber" }, "post": { "description": "Update a specific Proxy Number.", + "tags": [ + "ProxyV1PhoneNumber" + ], "parameters": [ { "name": "ServiceSid", @@ -2156,6 +2501,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.phone_number" + }, + "examples": { + "update": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "phone_number": "12345", + "friendly_name": "Friendly Name", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": true, + "in_use": 0 + } + } } } }, @@ -2168,9 +2534,6 @@ } ], "operationId": "UpdatePhoneNumber", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2183,6 +2546,13 @@ "description": "Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information." } } + }, + "examples": { + "update": { + "value": { + "IsReserved": true + } + } } } } @@ -2195,22 +2565,40 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "session": "{service_sid: sid}", - "phone_number": "{service_sid: sid}", - "short_code": "{service_sid: sid}" - } + "sessions": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Sessions" + }, + "phone_numbers": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/PhoneNumbers" + }, + "short_codes": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/ShortCodes" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Service.", + "tags": [ + "ProxyV1Service" + ], "parameters": [ { "name": "Sid", @@ -2228,6 +2616,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service" + }, + "examples": { + "fetch": { + "value": { + "sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My Service", + "default_ttl": 3600, + "callback_url": "http://www.example.com", + "geo_match_level": "country", + "number_selection_behavior": "prefer-sticky", + "intercept_callback_url": "http://www.example.com", + "out_of_session_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sessions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions", + "phone_numbers": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes" + } + } + } } } }, @@ -2239,13 +2651,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "delete": { "description": "Delete a specific Service.", + "tags": [ + "ProxyV1Service" + ], "parameters": [ { "name": "Sid", @@ -2270,13 +2682,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "post": { "description": "Update a specific Service.", + "tags": [ + "ProxyV1Service" + ], "parameters": [ { "name": "Sid", @@ -2297,6 +2709,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service" + }, + "examples": { + "update": { + "value": { + "sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My Service", + "default_ttl": 3600, + "callback_url": "http://www.example.com", + "geo_match_level": "country", + "number_selection_behavior": "prefer-sticky", + "intercept_callback_url": "http://www.example.com", + "out_of_session_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sessions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions", + "phone_numbers": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes" + } + } + } } } }, @@ -2309,9 +2745,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2350,7 +2783,7 @@ "OutOfSessionCallbackUrl": { "type": "string", "format": "uri", - "description": "The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information." + "description": "The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information." }, "ChatInstanceSid": { "type": "string", @@ -2360,6 +2793,16 @@ "description": "The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship." } } + }, + "examples": { + "update": { + "value": { + "DefaultTtl": 3600, + "CallbackUrl": "http://www.example.com", + "UniqueName": "My Service", + "ChatInstanceSid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2372,22 +2815,40 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "session": "{service_sid: sid}", - "phone_number": "{service_sid: sid}", - "short_code": "{service_sid: sid}" - } + "sessions": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Sessions" + }, + "phone_numbers": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/PhoneNumbers" + }, + "short_codes": { + "mapping": { + "service_sid": "sid" + }, + "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.", + "tags": [ + "ProxyV1Service" + ], "parameters": [ { "name": "PageSize", @@ -2432,16 +2893,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2450,17 +2913,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "services": [], + "meta": { + "first_page_url": "https://proxy.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://proxy.twilio.com/v1/Services?PageSize=50&Page=0" } } } @@ -2475,19 +2952,43 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" }, "post": { "description": "Create a new Service for Twilio Proxy", + "tags": [ + "ProxyV1Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service" + }, + "examples": { + "create": { + "value": { + "sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My Service", + "default_ttl": 3600, + "callback_url": "http://www.example.com", + "geo_match_level": "country", + "number_selection_behavior": "prefer-sticky", + "intercept_callback_url": "http://www.example.com", + "out_of_session_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sessions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions", + "phone_numbers": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes" + } + } + } } } }, @@ -2500,9 +3001,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2541,7 +3039,7 @@ "OutOfSessionCallbackUrl": { "type": "string", "format": "uri", - "description": "The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information." + "description": "The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information." }, "ChatInstanceSid": { "type": "string", @@ -2554,6 +3052,16 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "DefaultTtl": 3600, + "CallbackUrl": "http://www.example.com", + "UniqueName": "My Service", + "ChatInstanceSid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2566,7 +3074,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2574,15 +3082,30 @@ "date_started", "date_ended" ], - "pathType": "instance", "dependentProperties": { - "interaction": "{service_sid: service_sid, session_sid: sid}", - "participant": "{service_sid: service_sid, session_sid: sid}" + "interactions": { + "mapping": { + "service_sid": "service_sid", + "session_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Sessions/{session_sid}/Interactions" + }, + "participants": { + "mapping": { + "service_sid": "service_sid", + "session_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Sessions/{session_sid}/Participants" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch a specific Session.", + "tags": [ + "ProxyV1Session" + ], "parameters": [ { "name": "ServiceSid", @@ -2612,6 +3135,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session" + }, + "examples": { + "fetch": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "open", + "unique_name": "Order #1234", + "date_started": "2015-07-30T20:00:00Z", + "date_ended": "2015-07-30T20:00:00Z", + "date_last_interaction": "2015-07-30T20:00:00Z", + "date_expiry": "2015-07-30T20:00:00Z", + "ttl": 3600, + "mode": "voice-and-message", + "closed_reason": "", + "sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions", + "participants": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + } } } }, @@ -2623,13 +3171,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSession", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSession" }, "delete": { "description": "Delete a specific Session.", + "tags": [ + "ProxyV1Session" + ], "parameters": [ { "name": "ServiceSid", @@ -2666,13 +3214,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSession", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSession" }, "post": { "description": "Update a specific Session.", + "tags": [ + "ProxyV1Session" + ], "parameters": [ { "name": "ServiceSid", @@ -2705,6 +3253,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session" + }, + "examples": { + "update": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "in-progress", + "unique_name": "Order #1234", + "date_started": "2015-07-30T20:00:00Z", + "date_ended": "2015-07-30T20:00:00Z", + "date_last_interaction": "2015-07-30T20:00:00Z", + "date_expiry": "2015-07-30T20:00:00Z", + "ttl": 3600, + "mode": "voice-and-message", + "closed_reason": "", + "sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions", + "participants": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + } } } }, @@ -2717,9 +3290,6 @@ } ], "operationId": "UpdateSession", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2742,6 +3312,14 @@ "description": "The new status of the resource. Can be: `in-progress` to re-open a session or `closed` to close a session." } } + }, + "examples": { + "update": { + "value": { + "Ttl": 3600, + "Status": "in-progress" + } + } } } } @@ -2754,7 +3332,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2762,15 +3340,30 @@ "date_started", "date_ended" ], - "pathType": "list", "dependentProperties": { - "interaction": "{service_sid: service_sid, session_sid: sid}", - "participant": "{service_sid: service_sid, session_sid: sid}" + "interactions": { + "mapping": { + "service_sid": "service_sid", + "session_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Sessions/{session_sid}/Interactions" + }, + "participants": { + "mapping": { + "service_sid": "service_sid", + "session_sid": "sid" + }, + "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.", + "tags": [ + "ProxyV1Session" + ], "parameters": [ { "name": "ServiceSid", @@ -2827,16 +3420,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2845,17 +3440,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sessions": [], + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0", + "page_size": 50, + "key": "sessions" } } } @@ -2870,13 +3479,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListSession", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSession" }, "post": { "description": "Create a new Session", + "tags": [ + "ProxyV1Session" + ], "parameters": [ { "name": "ServiceSid", @@ -2897,6 +3506,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session" + }, + "examples": { + "create": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "open", + "unique_name": "Order #1234", + "date_started": "2015-07-30T20:00:00Z", + "date_ended": "2015-07-30T20:00:00Z", + "date_last_interaction": "2015-07-30T20:00:00Z", + "date_expiry": "2015-07-30T20:00:00Z", + "ttl": 3600, + "mode": "voice-and-message", + "closed_reason": "", + "sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions", + "participants": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + } } } }, @@ -2909,9 +3543,6 @@ } ], "operationId": "CreateSession", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2948,6 +3579,14 @@ "description": "The Participant objects to include in the new session." } } + }, + "examples": { + "create": { + "value": { + "Ttl": 3600, + "UniqueName": "Order #1234" + } + } } } } @@ -2960,18 +3599,21 @@ "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.", + "tags": [ + "ProxyV1ShortCode" + ], "parameters": [ { "name": "ServiceSid", @@ -2992,6 +3634,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.short_code" + }, + "examples": { + "create": { + "value": { + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "short_code": "12345", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false + } + } } } }, @@ -3004,9 +3665,6 @@ } ], "operationId": "CreateShortCode", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3019,12 +3677,19 @@ "minLength": 34, "maxLength": 34, "pattern": "^SC[0-9a-fA-F]{32}$", - "description": "The SID of a Twilio [ShortCode](https://www.twilio.com/docs/sms/api/short-code) resource that represents the short code you would like to assign to your Proxy Service." + "description": "The SID of a Twilio [ShortCode](https://www.twilio.com/en-us/messaging/channels/sms/short-codes) resource that represents the short code you would like to assign to your Proxy Service." } }, "required": [ "Sid" ] + }, + "examples": { + "create": { + "value": { + "Sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3032,6 +3697,9 @@ }, "get": { "description": "Retrieve a list of all Short Codes in the Proxy Number Pool for the Service. A maximum of 100 records will be returned per page.", + "tags": [ + "ProxyV1ShortCode" + ], "parameters": [ { "name": "ServiceSid", @@ -3088,16 +3756,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3106,18 +3776,48 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "short_codes", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0" + }, + "short_codes": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "short_code": "12345", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false + } + ] } } } @@ -3131,10 +3831,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "ListShortCode" } }, "/v1/Services/{ServiceSid}/ShortCodes/{Sid}": { @@ -3143,18 +3840,21 @@ "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.", + "tags": [ + "ProxyV1ShortCode" + ], "parameters": [ { "name": "ServiceSid", @@ -3191,13 +3891,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteShortCode" }, "get": { "description": "Fetch a specific Short Code.", + "tags": [ + "ProxyV1ShortCode" + ], "parameters": [ { "name": "ServiceSid", @@ -3230,6 +3930,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.short_code" + }, + "examples": { + "fetch": { + "value": { + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "short_code": "12345", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false + } + } } } }, @@ -3241,13 +3960,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchShortCode" }, "post": { "description": "Update a specific Short Code.", + "tags": [ + "ProxyV1ShortCode" + ], "parameters": [ { "name": "ServiceSid", @@ -3280,6 +3999,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.short_code" + }, + "examples": { + "update": { + "value": { + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "short_code": "12345", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": true + } + } } } }, @@ -3292,9 +4030,6 @@ } ], "operationId": "UpdateShortCode", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3307,6 +4042,13 @@ "description": "Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information." } } + }, + "examples": { + "update": { + "value": { + "IsReserved": true + } + } } } } @@ -3319,10 +4061,32 @@ "url": "https://proxy.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "ProxyV1Interaction" + }, + { + "name": "ProxyV1MessageInteraction" + }, + { + "name": "ProxyV1Participant" + }, + { + "name": "ProxyV1PhoneNumber" + }, + { + "name": "ProxyV1Service" + }, + { + "name": "ProxyV1Session" + }, + { + "name": "ProxyV1ShortCode" + } + ], + "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/spec/json/twilio_routes_v2.json b/spec/json/twilio_routes_v2.json index 0a2a6904..4139b001 100644 --- a/spec/json/twilio_routes_v2.json +++ b/spec/json/twilio_routes_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "routes.v2.phone_number": { "type": "object", @@ -155,12 +161,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -176,7 +176,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -186,7 +186,7 @@ "url": "https://routes.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -197,6 +197,9 @@ }, "post": { "description": "Assign an Inbound Processing Region to a phone number.", + "tags": [ + "RoutesV2PhoneNumber" + ], "parameters": [ { "name": "PhoneNumber", @@ -214,6 +217,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.phone_number" + }, + "examples": { + "update": { + "value": { + "phone_number": "+18001234567", + "url": "https://routes.twilio.com/v2/PhoneNumbers/+18001234567", + "sid": "QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_region": "au1", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -226,9 +243,6 @@ } ], "operationId": "UpdatePhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -245,6 +259,14 @@ "description": "A human readable description of this resource, up to 64 characters." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "VoiceRegion": "au1" + } + } } } } @@ -252,6 +274,9 @@ }, "get": { "description": "Fetch the Inbound Processing Region assigned to a phone number.", + "tags": [ + "RoutesV2PhoneNumber" + ], "parameters": [ { "name": "PhoneNumber", @@ -269,6 +294,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.phone_number" + }, + "examples": { + "fetch": { + "value": { + "phone_number": "+18001234567", + "url": "https://routes.twilio.com/v2/PhoneNumbers/+18001234567", + "sid": "QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_region": "au1", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -280,10 +319,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumber" } }, "/v2/SipDomains/{SipDomain}": { @@ -292,7 +328,7 @@ "url": "https://routes.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -303,6 +339,9 @@ }, "post": { "description": "", + "tags": [ + "RoutesV2SipDomain" + ], "parameters": [ { "name": "SipDomain", @@ -320,6 +359,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.sip_domain" + }, + "examples": { + "update": { + "value": { + "url": "https://routes.twilio.com/v2/SipDomains/test.sip.twilio.com", + "sip_domain": "test.sip.twilio.com", + "sid": "QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_region": "au1", + "date_created": "2020-08-07T22:29:24Z", + "date_updated": "2020-08-07T22:29:24Z" + } + } } } }, @@ -332,9 +385,6 @@ } ], "operationId": "UpdateSipDomain", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -351,6 +401,14 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "VoiceRegion": "au1" + } + } } } } @@ -358,6 +416,9 @@ }, "get": { "description": "", + "tags": [ + "RoutesV2SipDomain" + ], "parameters": [ { "name": "SipDomain", @@ -375,6 +436,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.sip_domain" + }, + "examples": { + "fetch": { + "value": { + "url": "https://routes.twilio.com/v2/SipDomains/test.sip.twilio.com", + "account_sid": "AC00000000000000000000000000000000", + "sid": "QQ00000000000000000000000000000000", + "sip_domain": "test.sip.twilio.com", + "friendly_name": "string", + "voice_region": "string", + "date_created": "2022-06-02T22:33:47Z", + "date_updated": "2022-06-02T22:33:47Z" + } + } } } }, @@ -386,10 +461,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipDomain" } }, "/v2/Trunks/{SipTrunkDomain}": { @@ -398,7 +470,7 @@ "url": "https://routes.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -409,6 +481,9 @@ }, "post": { "description": "Assign an Inbound Processing Region to a SIP Trunk", + "tags": [ + "RoutesV2Trunk" + ], "parameters": [ { "name": "SipTrunkDomain", @@ -426,6 +501,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.trunks" + }, + "examples": { + "update": { + "value": { + "sip_trunk_domain": "test.pstn.twilio.com", + "url": "https://routes.twilio.com/v2/Trunks/test.pstn.twilio.com", + "sid": "QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_region": "au1", + "date_created": "2020-08-07T22:29:24Z", + "date_updated": "2020-08-07T22:29:24Z" + } + } } } }, @@ -438,9 +527,6 @@ } ], "operationId": "UpdateTrunks", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -457,6 +543,14 @@ "description": "A human readable description of this resource, up to 64 characters." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "VoiceRegion": "au1" + } + } } } } @@ -464,6 +558,9 @@ }, "get": { "description": "Fetch the Inbound Processing Region assigned to a SIP Trunk.", + "tags": [ + "RoutesV2Trunk" + ], "parameters": [ { "name": "SipTrunkDomain", @@ -481,6 +578,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.trunks" + }, + "examples": { + "fetch": { + "value": { + "sip_trunk_domain": "test.pstn.twilio.com", + "url": "https://routes.twilio.com/v2/Trunks/test.pstn.twilio.com", + "account_sid": "AC00000000000000000000000000000000", + "sid": "QQ00000000000000000000000000000000", + "friendly_name": "string", + "voice_region": "string", + "date_created": "2022-06-02T22:33:47Z", + "date_updated": "2022-06-02T22:33:47Z" + } + } } } }, @@ -492,10 +603,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunks", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunks" } } }, @@ -504,10 +612,20 @@ "url": "https://routes.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "RoutesV2PhoneNumber" + }, + { + "name": "RoutesV2SipDomain" + }, + { + "name": "RoutesV2Trunk" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_serverless_v1.json b/spec/json/twilio_serverless_v1.json index 77bc10b9..d4ee7485 100644 --- a/spec/json/twilio_serverless_v1.json +++ b/spec/json/twilio_serverless_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "serverless.v1.service.asset": { "type": "object", @@ -31,7 +37,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters." + "description": "The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "date_created": { "type": "string", @@ -97,7 +109,13 @@ "path": { "type": "string", "nullable": true, - "description": "The URL-friendly string by which the Asset Version can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If an Asset Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one." + "description": "The URL-friendly string by which the Asset Version can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If an Asset Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "visibility": { "type": "string", @@ -224,7 +242,8 @@ "node10", "node12", "node14", - "node16" + "node16", + "node18" ] }, "serverless.v1.service.build.build_status": { @@ -377,17 +396,35 @@ "unique_name": { "type": "string", "nullable": true, - "description": "A user-defined string that uniquely identifies the Environment resource." + "description": "A user-defined string that uniquely identifies the Environment resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "domain_suffix": { "type": "string", "nullable": true, - "description": "A URL-friendly name that represents the environment and forms part of the domain name." + "description": "A URL-friendly name that represents the environment and forms part of the domain name.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "domain_name": { "type": "string", "nullable": true, - "description": "The domain name for all Functions and Assets deployed in the Environment, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix." + "description": "The domain name for all Functions and Assets deployed in the Environment, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "date_created": { "type": "string", @@ -445,7 +482,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Function resource. It can be a maximum of 255 characters." + "description": "The string that you assigned to describe the Function resource. It can be a maximum of 255 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "date_created": { "type": "string", @@ -511,7 +554,13 @@ "path": { "type": "string", "nullable": true, - "description": "The URL-friendly string by which the Function Version resource can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If a Function Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one." + "description": "The URL-friendly string by which the Function Version resource can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If a Function Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "visibility": { "type": "string", @@ -715,12 +764,24 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Service resource." + "description": "The string that you assigned to describe the Service resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "A user-defined string that uniquely identifies the Service resource. It can be used in place of the Service resource's `sid` in the URL to address the Service resource." + "description": "A user-defined string that uniquely identifies the Service resource. It can be used in place of the Service resource's `sid` in the URL to address the Service resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "include_credentials": { "type": "boolean", @@ -801,12 +862,24 @@ "key": { "type": "string", "nullable": true, - "description": "A string by which the Variable resource can be referenced." + "description": "A string by which the Variable resource can be referenced.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "value": { "type": "string", "nullable": true, - "description": "A string that contains the actual value of the Variable." + "description": "A string that contains the actual value of the Variable.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "date_created": { "type": "string", @@ -828,12 +901,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -849,7 +916,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -866,14 +933,23 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "asset_version": "{service_sid: service_sid, asset_sid: sid}" + "asset_versions": { + "mapping": { + "service_sid": "service_sid", + "asset_sid": "sid" + }, + "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.", + "tags": [ + "ServerlessV1Asset" + ], "parameters": [ { "name": "ServiceSid", @@ -927,16 +1003,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -945,17 +1023,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "assets": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0", + "key": "assets", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0" } } } @@ -970,13 +1062,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListAsset", - "x-maturity": [ - "Beta" - ] + "operationId": "ListAsset" }, "post": { "description": "Create a new Asset resource.", + "tags": [ + "ServerlessV1Asset" + ], "parameters": [ { "name": "ServiceSid", @@ -994,6 +1086,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset" + }, + "examples": { + "create": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "asset-friendly", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000", + "links": { + "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -1006,9 +1114,6 @@ } ], "operationId": "CreateAsset", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1024,6 +1129,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "asset-friendly" + } + } } } } @@ -1043,14 +1155,23 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "asset_version": "{service_sid: service_sid, asset_sid: sid}" + "asset_versions": { + "mapping": { + "service_sid": "service_sid", + "asset_sid": "sid" + }, + "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.", + "tags": [ + "ServerlessV1Asset" + ], "parameters": [ { "name": "ServiceSid", @@ -1080,6 +1201,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "test-asset", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000", + "links": { + "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -1091,13 +1228,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAsset", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAsset" }, "delete": { "description": "Delete an Asset resource.", + "tags": [ + "ServerlessV1Asset" + ], "parameters": [ { "name": "ServiceSid", @@ -1131,13 +1268,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAsset", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteAsset" }, "post": { "description": "Update a specific Asset resource.", + "tags": [ + "ServerlessV1Asset" + ], "parameters": [ { "name": "ServiceSid", @@ -1167,6 +1304,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset" + }, + "examples": { + "update": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "asset-friendly-update", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000", + "links": { + "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -1179,9 +1332,6 @@ } ], "operationId": "UpdateAsset", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1197,6 +1347,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "asset-friendly-update" + } + } } } } @@ -1217,12 +1374,15 @@ "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.", + "tags": [ + "ServerlessV1AssetVersion" + ], "parameters": [ { "name": "ServiceSid", @@ -1288,16 +1448,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1306,17 +1468,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "asset_versions": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0", + "key": "asset_versions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0" } } } @@ -1331,10 +1507,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAssetVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "ListAssetVersion" } }, "/v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid}": { @@ -1351,12 +1524,15 @@ "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.", + "tags": [ + "ServerlessV1AssetVersion" + ], "parameters": [ { "name": "ServiceSid", @@ -1398,6 +1574,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset.asset_version" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZN00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "asset_sid": "ZH00000000000000000000000000000000", + "path": "/test-path", + "visibility": "public", + "date_created": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000" + } + } } } }, @@ -1409,10 +1599,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAssetVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAssetVersion" } }, "/v1/Services/{ServiceSid}/Builds": { @@ -1428,14 +1615,23 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { - "build_status": "{service_sid: service_sid, sid: sid}" + "build_status": { + "mapping": { + "service_sid": "service_sid", + "sid": "sid" + }, + "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.", + "tags": [ + "ServerlessV1Build" + ], "parameters": [ { "name": "ServiceSid", @@ -1489,16 +1685,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1507,17 +1705,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "builds": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds?PageSize=50&Page=0", + "key": "builds", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds?PageSize=50&Page=0" } } } @@ -1532,13 +1744,13 @@ "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.", + "tags": [ + "ServerlessV1Build" + ], "parameters": [ { "name": "ServiceSid", @@ -1556,6 +1768,55 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.build" + }, + "examples": { + "create": { + "value": { + "sid": "ZB00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "asset_versions": [ + { + "sid": "ZN00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "asset_sid": "ZH00000000000000000000000000000000", + "date_created": "2018-11-10T20:00:00Z", + "path": "/asset-path", + "visibility": "PUBLIC" + } + ], + "function_versions": [ + { + "sid": "ZN00000000000000000000000000000001", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "function_sid": "ZH00000000000000000000000000000001", + "date_created": "2018-11-10T20:00:00Z", + "path": "/function-path", + "visibility": "PUBLIC" + } + ], + "dependencies": [ + { + "name": "twilio", + "version": "3.29.2" + }, + { + "name": "@twilio/runtime-handler", + "version": "1.0.1" + } + ], + "runtime": "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" + } + } + } } } }, @@ -1568,9 +1829,6 @@ } ], "operationId": "CreateBuild", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1607,6 +1865,19 @@ "description": "The Runtime version that will be used to run the Build resource when it is deployed." } } + }, + "examples": { + "create": { + "value": { + "AssetVersions": [ + "ZN00000000000000000000000000000000" + ], + "FunctionVersions": [ + "ZN00000000000000000000000000000001" + ], + "Dependencies": "[{\"name\":\"twilio\", \"version\":\"3.29.2\"}, {\"name\":\"@twilio/runtime-handler\", \"version\": \"1.0.1\"}]" + } + } } } } @@ -1626,14 +1897,23 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { - "build_status": "{service_sid: service_sid, sid: sid}" + "build_status": { + "mapping": { + "service_sid": "service_sid", + "sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Builds/{sid}/Status" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Build resource.", + "tags": [ + "ServerlessV1Build" + ], "parameters": [ { "name": "ServiceSid", @@ -1663,6 +1943,55 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.build" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZB00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "asset_versions": [ + { + "sid": "ZN00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "asset_sid": "ZH00000000000000000000000000000000", + "date_created": "2018-11-10T20:00:00Z", + "path": "/asset-path", + "visibility": "PUBLIC" + } + ], + "function_versions": [ + { + "sid": "ZN00000000000000000000000000000001", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "function_sid": "ZH00000000000000000000000000000001", + "date_created": "2018-11-10T20:00:00Z", + "path": "/function-path", + "visibility": "PUBLIC" + } + ], + "dependencies": [ + { + "name": "twilio", + "version": "3.29.2" + }, + { + "name": "@twilio/runtime-handler", + "version": "1.0.1" + } + ], + "runtime": "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" + } + } + } } } }, @@ -1674,13 +2003,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBuild", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBuild" }, "delete": { "description": "Delete a Build resource.", + "tags": [ + "ServerlessV1Build" + ], "parameters": [ { "name": "ServiceSid", @@ -1714,10 +2043,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBuild", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteBuild" } }, "/v1/Services/{ServiceSid}/Builds/{Sid}/Status": { @@ -1732,12 +2058,15 @@ "sid", "status" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Builds/{Sid}", - "mountName": "build_status" + "mountName": "build_status", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Build resource.", + "tags": [ + "ServerlessV1BuildStatus" + ], "parameters": [ { "name": "ServiceSid", @@ -1767,6 +2096,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.build.build_status" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZB00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "status": "completed", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status" + } + } } } }, @@ -1778,10 +2118,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBuildStatus", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBuildStatus" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments": { @@ -1797,11 +2134,14 @@ "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.", + "tags": [ + "ServerlessV1Deployment" + ], "parameters": [ { "name": "ServiceSid", @@ -1867,16 +2207,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1885,17 +2227,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "deployments": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments?PageSize=50&Page=0", + "key": "deployments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments?PageSize=50&Page=0" } } } @@ -1910,13 +2266,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployment", - "x-maturity": [ - "Beta" - ] + "operationId": "ListDeployment" }, "post": { "description": "Create a new Deployment.", + "tags": [ + "ServerlessV1Deployment" + ], "parameters": [ { "name": "ServiceSid", @@ -1946,6 +2302,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.deployment" + }, + "examples": { + "create": { + "value": { + "sid": "ZD00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "build_sid": "ZB00000000000000000000000000000000", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments/ZD00000000000000000000000000000000" + } + } } } }, @@ -1958,9 +2328,6 @@ } ], "operationId": "CreateDeployment", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1976,6 +2343,13 @@ "description": "The SID of the Build for the Deployment." } } + }, + "examples": { + "create": { + "value": { + "BuildSid": "ZB00000000000000000000000000000000" + } + } } } } @@ -1995,11 +2369,14 @@ "build_sid", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Environments/{Sid}" + "parent": "/Services/{ServiceSid}/Environments/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Deployment.", + "tags": [ + "ServerlessV1Deployment" + ], "parameters": [ { "name": "ServiceSid", @@ -2041,6 +2418,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.deployment" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZD00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "build_sid": "ZB00000000000000000000000000000000", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments/ZD00000000000000000000000000000000" + } + } } } }, @@ -2052,10 +2443,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployment", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDeployment" } }, "/v1/Services/{ServiceSid}/Environments": { @@ -2072,16 +2460,37 @@ "domain_name", "build_sid" ], - "pathType": "list", "dependentProperties": { - "variable": "{service_sid: service_sid, environment_sid: sid}", - "deployment": "{service_sid: service_sid, environment_sid: sid}", - "log": "{service_sid: service_sid, environment_sid: sid}" + "variables": { + "mapping": { + "service_sid": "service_sid", + "environment_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Variables" + }, + "deployments": { + "mapping": { + "service_sid": "service_sid", + "environment_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Deployments" + }, + "logs": { + "mapping": { + "service_sid": "service_sid", + "environment_sid": "sid" + }, + "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.", + "tags": [ + "ServerlessV1Environment" + ], "parameters": [ { "name": "ServiceSid", @@ -2135,16 +2544,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2153,17 +2564,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "environments": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments?PageSize=50&Page=0", + "key": "environments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments?PageSize=50&Page=0" } } } @@ -2178,13 +2603,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListEnvironment", - "x-maturity": [ - "Beta" - ] + "operationId": "ListEnvironment" }, "post": { "description": "Create a new environment.", + "tags": [ + "ServerlessV1Environment" + ], "parameters": [ { "name": "ServiceSid", @@ -2202,6 +2627,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment" + }, + "examples": { + "create": { + "value": { + "sid": "ZE00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "build_sid": null, + "unique_name": "staging", + "domain_suffix": "stage", + "domain_name": "foobar-1234-stage.twil.io", + "custom_domain_name": null, + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000", + "links": { + "variables": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables", + "deployments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments", + "logs": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs" + } + } + } } } }, @@ -2214,9 +2661,6 @@ } ], "operationId": "CreateEnvironment", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2236,6 +2680,14 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "staging", + "DomainSuffix": "stage" + } + } } } } @@ -2256,16 +2708,37 @@ "domain_name", "build_sid" ], - "pathType": "instance", "dependentProperties": { - "variable": "{service_sid: service_sid, environment_sid: sid}", - "deployment": "{service_sid: service_sid, environment_sid: sid}", - "log": "{service_sid: service_sid, environment_sid: sid}" + "variables": { + "mapping": { + "service_sid": "service_sid", + "environment_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Variables" + }, + "deployments": { + "mapping": { + "service_sid": "service_sid", + "environment_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Deployments" + }, + "logs": { + "mapping": { + "service_sid": "service_sid", + "environment_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Logs" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific environment.", + "tags": [ + "ServerlessV1Environment" + ], "parameters": [ { "name": "ServiceSid", @@ -2295,6 +2768,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZE00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "build_sid": "ZB00000000000000000000000000000000", + "unique_name": "testing-environment", + "domain_suffix": "testing", + "domain_name": "foobar-1234-testing.twil.io", + "custom_domain_name": null, + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000", + "links": { + "variables": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables", + "deployments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments", + "logs": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs" + } + } + } } } }, @@ -2306,13 +2801,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEnvironment", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchEnvironment" }, "delete": { "description": "Delete a specific environment.", + "tags": [ + "ServerlessV1Environment" + ], "parameters": [ { "name": "ServiceSid", @@ -2346,10 +2841,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEnvironment", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteEnvironment" } }, "/v1/Services/{ServiceSid}/Functions": { @@ -2365,14 +2857,23 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "function_version": "{service_sid: service_sid, function_sid: sid}" + "function_versions": { + "mapping": { + "service_sid": "service_sid", + "function_sid": "sid" + }, + "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.", + "tags": [ + "ServerlessV1Function" + ], "parameters": [ { "name": "ServiceSid", @@ -2426,16 +2927,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2444,17 +2947,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "functions": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0", + "key": "functions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0" } } } @@ -2469,13 +2986,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListFunction", - "x-maturity": [ - "Beta" - ] + "operationId": "ListFunction" }, "post": { "description": "Create a new Function resource.", + "tags": [ + "ServerlessV1Function" + ], "parameters": [ { "name": "ServiceSid", @@ -2493,6 +3010,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function" + }, + "examples": { + "create": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "function-friendly", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000", + "links": { + "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -2505,9 +3038,6 @@ } ], "operationId": "CreateFunction", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2523,6 +3053,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "function-friendly" + } + } } } } @@ -2542,14 +3079,23 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "function_version": "{service_sid: service_sid, function_sid: sid}" + "function_versions": { + "mapping": { + "service_sid": "service_sid", + "function_sid": "sid" + }, + "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.", + "tags": [ + "ServerlessV1Function" + ], "parameters": [ { "name": "ServiceSid", @@ -2579,6 +3125,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "test-function", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000", + "links": { + "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -2590,13 +3152,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFunction", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchFunction" }, "delete": { "description": "Delete a Function resource.", + "tags": [ + "ServerlessV1Function" + ], "parameters": [ { "name": "ServiceSid", @@ -2630,13 +3192,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFunction", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteFunction" }, "post": { "description": "Update a specific Function resource.", + "tags": [ + "ServerlessV1Function" + ], "parameters": [ { "name": "ServiceSid", @@ -2666,6 +3228,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function" + }, + "examples": { + "update": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "function-friendly-update", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000", + "links": { + "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -2678,9 +3256,6 @@ } ], "operationId": "UpdateFunction", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2696,6 +3271,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "function-friendly-update" + } + } } } } @@ -2716,15 +3298,25 @@ "visibility", "date_created" ], - "pathType": "list", "dependentProperties": { - "function_version_content": "{service_sid: service_sid, function_sid: function_sid, sid: sid}" + "function_version_content": { + "mapping": { + "service_sid": "service_sid", + "function_sid": "function_sid", + "sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Functions/{function_sid}/Versions/{sid}/Content" + } }, "parent": "/Services/{ServiceSid}/Functions/{Sid}", - "mountName": "function_versions" + "mountName": "function_versions", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Function Version resources.", + "tags": [ + "ServerlessV1FunctionVersion" + ], "parameters": [ { "name": "ServiceSid", @@ -2790,16 +3382,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2808,17 +3402,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "function_versions": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0", + "key": "function_versions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0" } } } @@ -2833,10 +3441,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFunctionVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "ListFunctionVersion" } }, "/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}": { @@ -2853,15 +3458,25 @@ "visibility", "date_created" ], - "pathType": "instance", "dependentProperties": { - "function_version_content": "{service_sid: service_sid, function_sid: function_sid, sid: sid}" + "function_version_content": { + "mapping": { + "service_sid": "service_sid", + "function_sid": "function_sid", + "sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Functions/{function_sid}/Versions/{sid}/Content" + } }, "parent": "/Services/{ServiceSid}/Functions/{Sid}", - "mountName": "function_versions" + "mountName": "function_versions", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Function Version resource.", + "tags": [ + "ServerlessV1FunctionVersion" + ], "parameters": [ { "name": "ServiceSid", @@ -2903,6 +3518,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function.function_version" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZN00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "function_sid": "ZH00000000000000000000000000000000", + "path": "/test-path", + "visibility": "public", + "date_created": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000", + "links": { + "function_version_content": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000/Content" + } + } + } } } }, @@ -2914,10 +3546,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFunctionVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchFunctionVersion" } }, "/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}/Content": { @@ -2932,12 +3561,15 @@ "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.", + "tags": [ + "ServerlessV1FunctionVersionContent" + ], "parameters": [ { "name": "ServiceSid", @@ -2979,6 +3611,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function.function_version.function_version_content" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZN00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "function_sid": "ZH00000000000000000000000000000000", + "content": "exports.handler = function (context, event, callback) {\n const request = require(\"request\");\n return request(\"http://www.google.com\", function (error, response, body) {\n callback(null, response.statusCode);\n });\n};", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000/Content" + } + } } } }, @@ -2990,10 +3634,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFunctionVersionContent", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchFunctionVersionContent" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs": { @@ -3005,11 +3646,14 @@ "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.", + "tags": [ + "ServerlessV1Log" + ], "parameters": [ { "name": "ServiceSid", @@ -3041,6 +3685,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "ZH00000000000000000000000000000000" + } } }, { @@ -3050,6 +3699,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2018-11-10T20:00:00Z" + } } }, { @@ -3059,6 +3713,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2018-12-10T20:00:00Z" + } } }, { @@ -3104,16 +3763,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3122,17 +3783,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "logs": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs?StartDate=2018-11-10T20%3A00%3A00Z&EndDate=2018-12-10T20%3A00%3A00Z&FunctionSid=ZH00000000000000000000000000000000&PageSize=50&Page=0", + "key": "logs", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs?StartDate=2018-11-10T20%3A00%3A00Z&EndDate=2018-12-10T20%3A00%3A00Z&FunctionSid=ZH00000000000000000000000000000000&PageSize=50&Page=0" } } } @@ -3147,10 +3822,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListLog", - "x-maturity": [ - "Beta" - ] + "operationId": "ListLog" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs/{Sid}": { @@ -3162,11 +3834,14 @@ "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.", + "tags": [ + "ServerlessV1Log" + ], "parameters": [ { "name": "ServiceSid", @@ -3208,6 +3883,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.log" + }, + "examples": { + "fetch": { + "value": { + "sid": "NO00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "build_sid": "ZB00000000000000000000000000000000", + "deployment_sid": "ZD00000000000000000000000000000000", + "function_sid": "ZH00000000000000000000000000000000", + "request_sid": "RQ00000000000000000000000000000000", + "level": "warn", + "message": "This is a warning", + "date_created": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs/NO00000000000000000000000000000000" + } + } } } }, @@ -3219,10 +3912,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchLog", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchLog" } }, "/v1/Services": { @@ -3238,16 +3928,39 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "environment": "{service_sid: sid}", - "function": "{service_sid: sid}", - "asset": "{service_sid: sid}", - "build": "{service_sid: sid}" - } + "environments": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Environments" + }, + "functions": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Functions" + }, + "assets": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Assets" + }, + "builds": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Builds" + } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Services.", + "tags": [ + "ServerlessV1Service" + ], "parameters": [ { "name": "PageSize", @@ -3292,16 +4005,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3310,17 +4025,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "services": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services?PageSize=50&Page=0" } } } @@ -3335,19 +4064,41 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" }, "post": { "description": "Create a new Service resource.", + "tags": [ + "ServerlessV1Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service" + }, + "examples": { + "create": { + "value": { + "sid": "ZS00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "service-friendly", + "unique_name": "service-unique", + "include_credentials": true, + "ui_editable": false, + "domain_base": "service-unique-1234", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000", + "links": { + "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments", + "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions", + "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets", + "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds" + } + } + } } } }, @@ -3360,9 +4111,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3391,6 +4139,14 @@ "UniqueName", "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "service-friendly", + "UniqueName": "service-unique" + } + } } } } @@ -3410,16 +4166,39 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "environment": "{service_sid: sid}", - "function": "{service_sid: sid}", - "asset": "{service_sid: sid}", - "build": "{service_sid: sid}" - } + "environments": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Environments" + }, + "functions": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Functions" + }, + "assets": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Assets" + }, + "builds": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Builds" + } + }, + "pathType": "instance" }, "get": { "description": "Retrieve a specific Service resource.", + "tags": [ + "ServerlessV1Service" + ], "parameters": [ { "name": "Sid", @@ -3437,6 +4216,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZS00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "test-service", + "unique_name": "test-service-1", + "include_credentials": true, + "ui_editable": false, + "domain_base": "test-service-1-1234", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000", + "links": { + "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments", + "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions", + "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets", + "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds" + } + } + } } } }, @@ -3448,13 +4249,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "delete": { "description": "Delete a Service resource.", + "tags": [ + "ServerlessV1Service" + ], "parameters": [ { "name": "Sid", @@ -3476,13 +4277,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "post": { "description": "Update a specific Service resource.", + "tags": [ + "ServerlessV1Service" + ], "parameters": [ { "name": "Sid", @@ -3500,6 +4301,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service" + }, + "examples": { + "update": { + "value": { + "sid": "ZS00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "service-friendly-update", + "unique_name": "service-unique-update", + "include_credentials": true, + "ui_editable": true, + "domain_base": "service-unique-update-1234", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000", + "links": { + "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments", + "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions", + "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets", + "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds" + } + } + } } } }, @@ -3512,9 +4335,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3535,6 +4355,15 @@ "description": "Whether the Service resource's properties and subresources can be edited via the UI. The default value is `false`." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "service-friendly-update", + "IncludeCredentials": true, + "UiEditable": true + } + } } } } @@ -3554,11 +4383,14 @@ "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.", + "tags": [ + "ServerlessV1Variable" + ], "parameters": [ { "name": "ServiceSid", @@ -3624,16 +4456,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3642,17 +4476,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "variables": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables?PageSize=50&Page=0", + "key": "variables", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables?PageSize=50&Page=0" } } } @@ -3667,13 +4515,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListVariable", - "x-maturity": [ - "Beta" - ] + "operationId": "ListVariable" }, "post": { "description": "Create a new Variable.", + "tags": [ + "ServerlessV1Variable" + ], "parameters": [ { "name": "ServiceSid", @@ -3703,6 +4551,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.variable" + }, + "examples": { + "create": { + "value": { + "sid": "ZV00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "key": "new-key", + "value": "new-value", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000" + } + } } } }, @@ -3715,9 +4578,6 @@ } ], "operationId": "CreateVariable", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3738,6 +4598,14 @@ "Key", "Value" ] + }, + "examples": { + "create": { + "value": { + "Key": "new-key", + "Value": "new-value" + } + } } } } @@ -3757,11 +4625,14 @@ "key", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Environments/{Sid}" + "parent": "/Services/{ServiceSid}/Environments/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Variable.", + "tags": [ + "ServerlessV1Variable" + ], "parameters": [ { "name": "ServiceSid", @@ -3803,6 +4674,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.variable" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZV00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "key": "test-key", + "value": "test-value", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000" + } + } } } }, @@ -3814,13 +4700,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVariable", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchVariable" }, "post": { "description": "Update a specific Variable.", + "tags": [ + "ServerlessV1Variable" + ], "parameters": [ { "name": "ServiceSid", @@ -3862,6 +4748,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.variable" + }, + "examples": { + "update": { + "value": { + "sid": "ZV00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "key": "update-key", + "value": "update-value", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-11T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000" + } + } } } }, @@ -3874,9 +4775,6 @@ } ], "operationId": "UpdateVariable", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3893,6 +4791,14 @@ "description": "A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size." } } + }, + "examples": { + "update": { + "value": { + "Key": "update-key", + "Value": "update-value" + } + } } } } @@ -3900,6 +4806,9 @@ }, "delete": { "description": "Delete a specific Variable.", + "tags": [ + "ServerlessV1Variable" + ], "parameters": [ { "name": "ServiceSid", @@ -3945,10 +4854,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteVariable", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteVariable" } } }, @@ -3957,10 +4863,47 @@ "url": "https://serverless.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "ServerlessV1Asset" + }, + { + "name": "ServerlessV1AssetVersion" + }, + { + "name": "ServerlessV1Build" + }, + { + "name": "ServerlessV1BuildStatus" + }, + { + "name": "ServerlessV1Deployment" + }, + { + "name": "ServerlessV1Environment" + }, + { + "name": "ServerlessV1Function" + }, + { + "name": "ServerlessV1FunctionVersion" + }, + { + "name": "ServerlessV1FunctionVersionContent" + }, + { + "name": "ServerlessV1Log" + }, + { + "name": "ServerlessV1Service" + }, + { + "name": "ServerlessV1Variable" + } + ], + "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/spec/json/twilio_studio_v1.json b/spec/json/twilio_studio_v1.json index 8b8d7336..6a001188 100644 --- a/spec/json/twilio_studio_v1.json +++ b/spec/json/twilio_studio_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "studio.v1.flow.engagement": { "type": "object", @@ -161,11 +167,23 @@ "contact_channel_address": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`." + "description": "The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status": { "type": "string", @@ -219,7 +237,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "flow_sid": { "type": "string", @@ -287,7 +311,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "transitioned_from": { "type": "string", @@ -338,7 +368,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "execution_sid": { "type": "string", @@ -482,7 +518,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "transitioned_from": { "type": "string", @@ -533,7 +575,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "engagement_sid": { "type": "string", @@ -567,12 +615,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -588,7 +630,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -606,15 +648,30 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { - "step": "{flow_sid: flow_sid, engagement_sid: sid}", - "engagement_context": "{flow_sid: flow_sid, engagement_sid: sid}" + "steps": { + "mapping": { + "flow_sid": "flow_sid", + "engagement_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps" + }, + "engagement_context": { + "mapping": { + "flow_sid": "flow_sid", + "engagement_sid": "sid" + }, + "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.", + "tags": [ + "StudioV1Engagement" + ], "parameters": [ { "name": "FlowSid", @@ -671,16 +728,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -689,18 +748,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements?PageSize=50&Page=0", + "page_size": 50, + "key": "engagements" + }, + "engagements": [] } } } @@ -714,13 +787,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListEngagement", - "x-maturity": [ - "GA" - ] + "operationId": "ListEngagement" }, "post": { "description": "Triggers a new Engagement for the Flow", + "tags": [ + "StudioV1Engagement" + ], "parameters": [ { "name": "FlowSid", @@ -741,6 +814,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.engagement" + }, + "examples": { + "create": { + "value": { + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": {}, + "contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+18001234567", + "status": "active", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "engagement_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -753,9 +846,6 @@ } ], "operationId": "CreateEngagement", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -781,6 +871,15 @@ "To", "From" ] + }, + "examples": { + "create": { + "value": { + "To": "+18001234567", + "From": "+18007654321", + "Parameters": "{\"first_name\":\"Foo\"}" + } + } } } } @@ -801,15 +900,30 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { - "step": "{flow_sid: flow_sid, engagement_sid: sid}", - "engagement_context": "{flow_sid: flow_sid, engagement_sid: sid}" + "steps": { + "mapping": { + "flow_sid": "flow_sid", + "engagement_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps" + }, + "engagement_context": { + "mapping": { + "flow_sid": "flow_sid", + "engagement_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Context" + } }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve an Engagement", + "tags": [ + "StudioV1Engagement" + ], "parameters": [ { "name": "FlowSid", @@ -842,6 +956,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.engagement" + }, + "examples": { + "fetch": { + "value": { + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+14155555555", + "status": "ended", + "context": {}, + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "engagement_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -853,13 +987,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEngagement", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEngagement" }, "delete": { "description": "Delete this Engagement and all Steps relating to it.", + "tags": [ + "StudioV1Engagement" + ], "parameters": [ { "name": "FlowSid", @@ -896,10 +1030,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEngagement", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteEngagement" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context": { @@ -913,12 +1044,15 @@ "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.", + "tags": [ + "StudioV1EngagementContext" + ], "parameters": [ { "name": "FlowSid", @@ -951,6 +1085,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.engagement.engagement_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "engagement_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -962,10 +1109,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEngagementContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEngagementContext" } }, "/v1/Flows/{FlowSid}/Executions": { @@ -982,15 +1126,30 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { - "execution_step": "{flow_sid: flow_sid, execution_sid: sid}", - "execution_context": "{flow_sid: flow_sid, execution_sid: sid}" + "steps": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps" + }, + "execution_context": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "sid" + }, + "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.", + "tags": [ + "StudioV1Execution" + ], "parameters": [ { "name": "FlowSid", @@ -1065,16 +1224,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1083,18 +1244,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0", + "page_size": 50, + "key": "executions" + }, + "executions": [] } } } @@ -1108,13 +1283,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecution", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecution" }, "post": { "description": "Triggers a new Execution for the Flow", + "tags": [ + "StudioV1Execution" + ], "parameters": [ { "name": "FlowSid", @@ -1135,6 +1310,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution" + }, + "examples": { + "create": { + "value": { + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": {}, + "contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+18001234567", + "status": "active", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -1147,9 +1342,6 @@ } ], "operationId": "CreateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1175,6 +1367,15 @@ "To", "From" ] + }, + "examples": { + "create": { + "value": { + "To": "+18001234567", + "From": "+18007654321", + "Parameters": "{\"first_name\":\"Foo\"}" + } + } } } } @@ -1195,15 +1396,30 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { - "execution_step": "{flow_sid: flow_sid, execution_sid: sid}", - "execution_context": "{flow_sid: flow_sid, execution_sid: sid}" + "steps": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps" + }, + "execution_context": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Executions/{execution_sid}/Context" + } }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve an Execution", + "tags": [ + "StudioV1Execution" + ], "parameters": [ { "name": "FlowSid", @@ -1236,6 +1452,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution" + }, + "examples": { + "fetch": { + "value": { + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+14155555555", + "status": "ended", + "context": {}, + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -1247,13 +1483,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecution", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecution" }, "delete": { "description": "Delete the Execution and all Steps relating to it.", + "tags": [ + "StudioV1Execution" + ], "parameters": [ { "name": "FlowSid", @@ -1290,13 +1526,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteExecution", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteExecution" }, "post": { "description": "Update the status of an Execution to `ended`.", + "tags": [ + "StudioV1Execution" + ], "parameters": [ { "name": "FlowSid", @@ -1329,6 +1565,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution" + }, + "examples": { + "update": { + "value": { + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": {}, + "contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+14155555555", + "status": "ended", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": "2017-11-06T12:00:00Z", + "links": { + "steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -1341,9 +1597,6 @@ } ], "operationId": "UpdateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1360,6 +1613,13 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "ended" + } + } } } } @@ -1377,12 +1637,15 @@ "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.", + "tags": [ + "StudioV1ExecutionContext" + ], "parameters": [ { "name": "FlowSid", @@ -1415,6 +1678,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution.execution_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -1426,10 +1702,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionContext" } }, "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps": { @@ -1445,15 +1718,25 @@ "name", "date_created" ], - "pathType": "list", "dependentProperties": { - "execution_step_context": "{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}" + "step_context": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "execution_sid", + "step_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context" + } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Steps for an Execution.", + "tags": [ + "StudioV1ExecutionStep" + ], "parameters": [ { "name": "FlowSid", @@ -1522,16 +1805,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1540,18 +1825,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page_size": 50, + "key": "steps" + }, + "steps": [] } } } @@ -1565,10 +1864,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecutionStep" } }, "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}": { @@ -1584,15 +1880,25 @@ "name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "execution_step_context": "{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}" + "step_context": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "execution_sid", + "step_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context" + } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "instance" }, "get": { "description": "Retrieve a Step.", + "tags": [ + "StudioV1ExecutionStep" + ], "parameters": [ { "name": "FlowSid", @@ -1637,6 +1943,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step" + }, + "examples": { + "fetch": { + "value": { + "sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "parent_step_sid": null, + "name": "incomingRequest", + "context": {}, + "transitioned_from": "Trigger", + "transitioned_to": "Ended", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "step_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -1648,10 +1975,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStep" } }, "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context": { @@ -1665,13 +1989,16 @@ "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.", + "tags": [ + "StudioV1ExecutionStepContext" + ], "parameters": [ { "name": "FlowSid", @@ -1716,6 +2043,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step.execution_step_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "step_sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -1727,10 +2068,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStepContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStepContext" } }, "/v1/Flows": { @@ -1747,14 +2085,27 @@ "status", "version" ], - "pathType": "list", "dependentProperties": { - "engagement": "{flow_sid: sid}", - "execution": "{flow_sid: sid}" - } + "engagements": { + "mapping": { + "flow_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Engagements" + }, + "executions": { + "mapping": { + "flow_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Executions" + } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Flows.", + "tags": [ + "StudioV1Flow" + ], "parameters": [ { "name": "PageSize", @@ -1799,16 +2150,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1817,18 +2170,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v1/Flows?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v1/Flows?PageSize=50&Page=0", + "page_size": 50, + "key": "flows" + }, + "flows": [] } } } @@ -1842,10 +2209,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlow", - "x-maturity": [ - "GA" - ] + "operationId": "ListFlow" } }, "/v1/Flows/{Sid}": { @@ -1862,14 +2226,27 @@ "status", "version" ], - "pathType": "instance", "dependentProperties": { - "engagement": "{flow_sid: sid}", - "execution": "{flow_sid: sid}" - } + "engagements": { + "mapping": { + "flow_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Engagements" + }, + "executions": { + "mapping": { + "flow_sid": "sid" + }, + "resource_url": "/v1/Flows/{flow_sid}/Executions" + } + }, + "pathType": "instance" }, "get": { "description": "Retrieve a specific Flow.", + "tags": [ + "StudioV1Flow" + ], "parameters": [ { "name": "Sid", @@ -1890,6 +2267,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow" + }, + "examples": { + "fetch": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test Flow", + "status": "published", + "version": 1, + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "engagements": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements", + "executions": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions" + } + } + } } } }, @@ -1901,13 +2296,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlow", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlow" }, "delete": { "description": "Delete a specific Flow.", + "tags": [ + "StudioV1Flow" + ], "parameters": [ { "name": "Sid", @@ -1932,10 +2327,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFlow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteFlow" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps": { @@ -1952,14 +2344,24 @@ "transitioned_from", "transitioned_to" ], - "pathType": "list", "dependentProperties": { - "step_context": "{flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: sid}" + "step_context": { + "mapping": { + "flow_sid": "flow_sid", + "engagement_sid": "engagement_sid", + "step_sid": "sid" + }, + "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.", + "tags": [ + "StudioV1Step" + ], "parameters": [ { "name": "FlowSid", @@ -2028,16 +2430,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2046,18 +2450,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page_size": 50, + "key": "steps" + }, + "steps": [] } } } @@ -2071,10 +2489,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListStep", - "x-maturity": [ - "GA" - ] + "operationId": "ListStep" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid}": { @@ -2091,14 +2506,24 @@ "transitioned_from", "transitioned_to" ], - "pathType": "instance", "dependentProperties": { - "step_context": "{flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: sid}" + "step_context": { + "mapping": { + "flow_sid": "flow_sid", + "engagement_sid": "engagement_sid", + "step_sid": "sid" + }, + "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.", + "tags": [ + "StudioV1Step" + ], "parameters": [ { "name": "FlowSid", @@ -2143,6 +2568,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.engagement.step" + }, + "examples": { + "fetch": { + "value": { + "sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "engagement_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "incomingRequest", + "context": {}, + "transitioned_from": "Trigger", + "transitioned_to": "Ended", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "step_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -2154,10 +2599,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchStep", - "x-maturity": [ - "GA" - ] + "operationId": "FetchStep" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{StepSid}/Context": { @@ -2171,12 +2613,15 @@ "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.", + "tags": [ + "StudioV1StepContext" + ], "parameters": [ { "name": "FlowSid", @@ -2221,6 +2666,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.engagement.step.step_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "engagement_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "step_sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -2232,10 +2691,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchStepContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchStepContext" } } }, @@ -2244,10 +2700,38 @@ "url": "https://studio.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "StudioV1Engagement" + }, + { + "name": "StudioV1EngagementContext" + }, + { + "name": "StudioV1Execution" + }, + { + "name": "StudioV1ExecutionContext" + }, + { + "name": "StudioV1ExecutionStep" + }, + { + "name": "StudioV1ExecutionStepContext" + }, + { + "name": "StudioV1Flow" + }, + { + "name": "StudioV1Step" + }, + { + "name": "StudioV1StepContext" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_studio_v2.json b/spec/json/twilio_studio_v2.json index b49f0d90..a0708c4c 100644 --- a/spec/json/twilio_studio_v2.json +++ b/spec/json/twilio_studio_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "studio.v2.flow.execution": { "type": "object", @@ -31,11 +37,23 @@ "contact_channel_address": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`." + "description": "The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status": { "type": "string", @@ -89,7 +107,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "flow_sid": { "type": "string", @@ -157,7 +181,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "transitioned_from": { "type": "string", @@ -208,7 +238,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "execution_sid": { "type": "string", @@ -467,12 +503,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -488,7 +518,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -505,15 +535,30 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { - "execution_step": "{flow_sid: flow_sid, execution_sid: sid}", - "execution_context": "{flow_sid: flow_sid, execution_sid: sid}" + "steps": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "sid" + }, + "resource_url": "/v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps" + }, + "execution_context": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "sid" + }, + "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.", + "tags": [ + "StudioV2Execution" + ], "parameters": [ { "name": "FlowSid", @@ -588,16 +633,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -606,18 +653,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0", + "page_size": 50, + "key": "executions" + }, + "executions": [] } } } @@ -631,13 +692,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecution", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecution" }, "post": { "description": "Triggers a new Execution for the Flow", + "tags": [ + "StudioV2Execution" + ], "parameters": [ { "name": "FlowSid", @@ -658,6 +719,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution" + }, + "examples": { + "create": { + "value": { + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": {}, + "contact_channel_address": "+18001234567", + "status": "active", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "steps": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -670,9 +750,6 @@ } ], "operationId": "CreateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -698,6 +775,15 @@ "To", "From" ] + }, + "examples": { + "create": { + "value": { + "To": "+18001234567", + "From": "+18007654321", + "Parameters": "{\"first_name\":\"Foo\"}" + } + } } } } @@ -717,15 +803,30 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { - "execution_step": "{flow_sid: flow_sid, execution_sid: sid}", - "execution_context": "{flow_sid: flow_sid, execution_sid: sid}" + "steps": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "sid" + }, + "resource_url": "/v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps" + }, + "execution_context": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "sid" + }, + "resource_url": "/v2/Flows/{flow_sid}/Executions/{execution_sid}/Context" + } }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve an Execution", + "tags": [ + "StudioV2Execution" + ], "parameters": [ { "name": "FlowSid", @@ -758,6 +859,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution" + }, + "examples": { + "fetch": { + "value": { + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+14155555555", + "status": "ended", + "context": {}, + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "steps": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -769,13 +889,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecution", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecution" }, "delete": { "description": "Delete the Execution and all Steps relating to it.", + "tags": [ + "StudioV2Execution" + ], "parameters": [ { "name": "FlowSid", @@ -812,13 +932,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteExecution", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteExecution" }, "post": { "description": "Update the status of an Execution to `ended`.", + "tags": [ + "StudioV2Execution" + ], "parameters": [ { "name": "FlowSid", @@ -851,6 +971,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution" + }, + "examples": { + "update": { + "value": { + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": {}, + "contact_channel_address": "+14155555555", + "status": "ended", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": "2017-11-06T12:00:00Z", + "links": { + "steps": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -863,9 +1002,6 @@ } ], "operationId": "UpdateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -882,6 +1018,13 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "ended" + } + } } } } @@ -899,12 +1042,15 @@ "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.", + "tags": [ + "StudioV2ExecutionContext" + ], "parameters": [ { "name": "FlowSid", @@ -937,6 +1083,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution.execution_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -948,10 +1107,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionContext" } }, "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps": { @@ -967,15 +1123,25 @@ "name", "date_created" ], - "pathType": "list", "dependentProperties": { - "execution_step_context": "{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}" + "step_context": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "execution_sid", + "step_sid": "sid" + }, + "resource_url": "/v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context" + } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Steps for an Execution.", + "tags": [ + "StudioV2ExecutionStep" + ], "parameters": [ { "name": "FlowSid", @@ -1044,16 +1210,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1062,18 +1230,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page_size": 50, + "key": "steps" + }, + "steps": [] } } } @@ -1087,10 +1269,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecutionStep" } }, "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}": { @@ -1106,15 +1285,25 @@ "name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "execution_step_context": "{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}" + "step_context": { + "mapping": { + "flow_sid": "flow_sid", + "execution_sid": "execution_sid", + "step_sid": "sid" + }, + "resource_url": "/v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context" + } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "instance" }, "get": { "description": "Retrieve a Step.", + "tags": [ + "StudioV2ExecutionStep" + ], "parameters": [ { "name": "FlowSid", @@ -1159,6 +1348,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step" + }, + "examples": { + "fetch": { + "value": { + "sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "parent_step_sid": null, + "name": "incomingRequest", + "context": {}, + "transitioned_from": "Trigger", + "transitioned_to": "Ended", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "step_context": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -1170,10 +1380,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStep" } }, "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context": { @@ -1187,13 +1394,16 @@ "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.", + "tags": [ + "StudioV2ExecutionStepContext" + ], "parameters": [ { "name": "FlowSid", @@ -1238,6 +1448,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step.execution_step_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "step_sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -1249,10 +1473,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStepContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStepContext" } }, "/v2/Flows": { @@ -1269,21 +1490,66 @@ "status", "revision" ], - "pathType": "list", "dependentProperties": { - "flow_revision": "{sid: sid}", - "flow_test_user": "{sid: sid}", - "execution": "{flow_sid: sid}" - } + "revisions": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v2/Flows/{sid}/Revisions" + }, + "test_users": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v2/Flows/{sid}/TestUsers" + }, + "executions": { + "mapping": { + "flow_sid": "sid" + }, + "resource_url": "/v2/Flows/{flow_sid}/Executions" + } + }, + "pathType": "list" }, "post": { "description": "Create a Flow.", + "tags": [ + "StudioV2Flow" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow" + }, + "examples": { + "create": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "definition": { + "initial_state": "Trigger" + }, + "friendly_name": "Test Flow", + "status": "published", + "revision": 1, + "commit_message": null, + "valid": true, + "errors": [], + "warnings": [], + "webhook_url": "http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "test_users": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers", + "revisions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions", + "executions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions" + } + } + } } } }, @@ -1296,9 +1562,6 @@ } ], "operationId": "CreateFlow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1328,6 +1591,15 @@ "Status", "Definition" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Test Flow", + "Status": "published", + "Definition": "{\"initial_state\": \"Trigger\"}" + } + } } } } @@ -1335,6 +1607,9 @@ }, "get": { "description": "Retrieve a list of all Flows.", + "tags": [ + "StudioV2Flow" + ], "parameters": [ { "name": "PageSize", @@ -1379,16 +1654,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1397,18 +1674,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v2/Flows?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v2/Flows?PageSize=50&Page=0", + "page_size": 50, + "key": "flows" + }, + "flows": [ + { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test Flow", + "status": "published", + "revision": 1, + "definition": null, + "commit_message": null, + "valid": null, + "errors": null, + "warnings": null, + "webhook_url": "http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": "2017-11-06T12:00:00Z", + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "test_users": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers", + "revisions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions", + "executions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions" + } + } + ] } } } @@ -1422,10 +1735,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlow", - "x-maturity": [ - "GA" - ] + "operationId": "ListFlow" } }, "/v2/Flows/{Sid}": { @@ -1442,15 +1752,33 @@ "status", "revision" ], - "pathType": "instance", "dependentProperties": { - "flow_revision": "{sid: sid}", - "flow_test_user": "{sid: sid}", - "execution": "{flow_sid: sid}" - } + "revisions": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v2/Flows/{sid}/Revisions" + }, + "test_users": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v2/Flows/{sid}/TestUsers" + }, + "executions": { + "mapping": { + "flow_sid": "sid" + }, + "resource_url": "/v2/Flows/{flow_sid}/Executions" + } + }, + "pathType": "instance" }, "post": { "description": "Update a Flow.", + "tags": [ + "StudioV2Flow" + ], "parameters": [ { "name": "Sid", @@ -1471,6 +1799,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow" + }, + "examples": { + "update": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "definition": { + "initial_state": "Trigger" + }, + "friendly_name": "Test Flow", + "status": "published", + "revision": 1, + "commit_message": null, + "valid": true, + "errors": [], + "warnings": [], + "webhook_url": "http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": "2017-11-06T12:00:00Z", + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "test_users": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers", + "revisions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions", + "executions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions" + } + } + } } } }, @@ -1483,9 +1838,6 @@ } ], "operationId": "UpdateFlow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1513,6 +1865,15 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test Flow", + "Status": "published", + "Definition": "{\"initial_state\": \"Trigger\"}" + } + } } } } @@ -1520,6 +1881,9 @@ }, "get": { "description": "Retrieve a specific Flow.", + "tags": [ + "StudioV2Flow" + ], "parameters": [ { "name": "Sid", @@ -1540,6 +1904,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow" + }, + "examples": { + "fetch": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test Flow", + "definition": { + "initial_state": "Trigger" + }, + "status": "published", + "revision": 1, + "commit_message": "commit", + "valid": true, + "errors": [], + "warnings": [], + "webhook_url": "http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "test_users": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers", + "revisions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions", + "executions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions" + } + } + } } } }, @@ -1551,13 +1942,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlow", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlow" }, "delete": { "description": "Delete a specific Flow.", + "tags": [ + "StudioV2Flow" + ], "parameters": [ { "name": "Sid", @@ -1582,10 +1973,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFlow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteFlow" } }, "/v2/Flows/{Sid}/Revisions": { @@ -1602,12 +1990,15 @@ "status", "revision" ], - "pathType": "list", "parent": "/Flows/{Sid}", - "className": "flow_revision" + "className": "flow_revision", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Flows revisions.", + "tags": [ + "StudioV2FlowRevision" + ], "parameters": [ { "name": "Sid", @@ -1664,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" @@ -1682,18 +2075,47 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions?PageSize=50&Page=0", + "page_size": 50, + "key": "revisions" + }, + "revisions": [ + { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test Flow", + "status": "published", + "revision": 1, + "definition": null, + "commit_message": null, + "valid": null, + "errors": null, + "date_created": "2017-11-06T12:00:00Z", + "date_updated": "2017-11-06T12:00:00Z", + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions/1" + } + ] } } } @@ -1707,10 +2129,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlowRevision", - "x-maturity": [ - "GA" - ] + "operationId": "ListFlowRevision" } }, "/v2/Flows/{Sid}/Revisions/{Revision}": { @@ -1727,12 +2146,15 @@ "status", "revision" ], - "pathType": "instance", "parent": "/Flows/{Sid}", - "className": "flow_revision" + "className": "flow_revision", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Flow revision.", + "tags": [ + "StudioV2FlowRevision" + ], "parameters": [ { "name": "Sid", @@ -1762,6 +2184,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.flow_revision" + }, + "examples": { + "fetch": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "definition": { + "initial_state": "Trigger" + }, + "friendly_name": "Test Flow", + "status": "published", + "revision": 1, + "commit_message": null, + "valid": true, + "errors": [], + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions/1" + } + } } } }, @@ -1773,10 +2215,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlowRevision", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlowRevision" } }, "/v2/Flows/Validate": { @@ -1790,17 +2229,27 @@ "defaultOutputProperties": [ "valid" ], - "pathType": "list", - "mountName": "flow_validate" + "mountName": "flow_validate", + "pathType": "list" }, "post": { "description": "Validate flow JSON definition", + "tags": [ + "StudioV2FlowValidate" + ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow_validate" + }, + "examples": { + "update": { + "value": { + "valid": true + } + } } } }, @@ -1813,9 +2262,6 @@ } ], "operationId": "UpdateFlowValidate", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1845,6 +2291,15 @@ "Status", "Definition" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test Flow", + "Status": "published", + "Definition": "{\"initial_state\": \"Trigger\"}" + } + } } } } @@ -1862,12 +2317,15 @@ "defaultOutputProperties": [ "test_users" ], - "pathType": "instance", "parent": "/Flows/{Sid}", - "className": "flow_test_user" + "className": "flow_test_user", + "pathType": "instance" }, "get": { "description": "Fetch flow test users", + "tags": [ + "StudioV2FlowTestUser" + ], "parameters": [ { "name": "Sid", @@ -1888,6 +2346,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.test_user" + }, + "examples": { + "fetch": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "test_users": [ + "user1", + "user2" + ], + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers" + } + } } } }, @@ -1899,13 +2369,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTestUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTestUser" }, "post": { "description": "Update flow test users", + "tags": [ + "StudioV2FlowTestUser" + ], "parameters": [ { "name": "Sid", @@ -1926,6 +2396,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.test_user" + }, + "examples": { + "update": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "test_users": [ + "user1", + "user2" + ], + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers" + } + } } } }, @@ -1938,9 +2420,6 @@ } ], "operationId": "UpdateTestUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1959,6 +2438,16 @@ "required": [ "TestUsers" ] + }, + "examples": { + "update": { + "value": { + "TestUsers": [ + "user1", + "user2" + ] + } + } } } } @@ -1971,10 +2460,35 @@ "url": "https://studio.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "StudioV2Execution" + }, + { + "name": "StudioV2ExecutionContext" + }, + { + "name": "StudioV2ExecutionStep" + }, + { + "name": "StudioV2ExecutionStepContext" + }, + { + "name": "StudioV2Flow" + }, + { + "name": "StudioV2FlowRevision" + }, + { + "name": "StudioV2FlowTestUser" + }, + { + "name": "StudioV2FlowValidate" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_supersim_v1.json b/spec/json/twilio_supersim_v1.json index 8e91dea5..ebdc9009 100644 --- a/spec/json/twilio_supersim_v1.json +++ b/spec/json/twilio_supersim_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "supersim.v1.sim.billing_period": { "type": "object", @@ -89,7 +95,13 @@ "iccid": { "type": "string", "nullable": true, - "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource." + "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "sim_sid": { "type": "string", @@ -97,13 +109,13 @@ "maxLength": 34, "pattern": "^HS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Sim](https://www.twilio.com/docs/wireless/api/sim-resource) resource that this eSIM Profile controls." + "description": "The SID of the [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource that this eSIM Profile controls." }, "status": { "type": "string", "$ref": "#/components/schemas/esim_profile_enum_status", "nullable": true, - "description": "The status of the eSIM Profile. Can be: `reserving`, `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) for a description of each." + "description": "The status of the eSIM Profile. Can be: `new`, `reserving`, `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) for a description of each." }, "eid": { "type": "string", @@ -349,7 +361,13 @@ "payload": { "type": "string", "nullable": true, - "description": "The payload that is carried in the IP/UDP message. The payload can be encoded in either text or binary format. For text payload, UTF-8 encoding must be used.\n\nFor an IP Command sent to a Super SIM, the payload is appended to the IP/UDP message \u201cas is\u201d. The payload should not exceed 1300 bytes.\n\nFor an IP Command sent from a Super SIM, the payload from the received IP/UDP message is extracted and sent in binary encoding. For an IP Command sent from a Super SIM, the payload should not exceed 1300 bytes. If it is larger than 1300 bytes, there might be fragmentation on the upstream and the message may appear truncated." + "description": "The payload that is carried in the IP/UDP message. The payload can be encoded in either text or binary format. For text payload, UTF-8 encoding must be used.\n\nFor an IP Command sent to a Super SIM, the payload is appended to the IP/UDP message \u201cas is\u201d. The payload should not exceed 1300 bytes.\n\nFor an IP Command sent from a Super SIM, the payload from the received IP/UDP message is extracted and sent in binary encoding. For an IP Command sent from a Super SIM, the payload should not exceed 1300 bytes. If it is larger than 1300 bytes, there might be fragmentation on the upstream and the message may appear truncated.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -613,7 +631,13 @@ "iccid": { "type": "string", "nullable": true, - "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM." + "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status": { "type": "string", @@ -725,7 +749,13 @@ "payload": { "type": "string", "nullable": true, - "description": "The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters." + "description": "The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status": { "type": "string", @@ -875,12 +905,6 @@ "time" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -896,7 +920,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -915,11 +939,14 @@ "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.", + "tags": [ + "SupersimV1BillingPeriod" + ], "parameters": [ { "name": "SimSid", @@ -973,16 +1000,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -991,17 +1020,81 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "billing_periods": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "next_page_url": null, + "key": "billing_periods" + } + } + }, + "readFullActivePeriod": { + "value": { + "billing_periods": [ + { + "sid": "HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "period_type": "active", + "start_time": "2021-06-09T13:18:15Z", + "end_time": "2021-07-09T13:18:15Z", + "date_created": "2021-06-09T13:18:16Z", + "date_updated": "2021-06-09T13:18:16Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "next_page_url": null, + "key": "billing_periods" + } + } + }, + "readFullReadyPeriod": { + "value": { + "billing_periods": [ + { + "sid": "HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "period_type": "ready", + "start_time": "2021-06-09T13:18:15Z", + "end_time": "2021-07-09T13:18:15Z", + "date_created": "2021-06-09T13:18:16Z", + "date_updated": "2021-06-09T13:18:16Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "next_page_url": null, + "key": "billing_periods" } } } @@ -1016,10 +1109,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBillingPeriod", - "x-maturity": [ - "GA" - ] + "operationId": "ListBillingPeriod" } }, "/v1/ESimProfiles": { @@ -1034,17 +1124,76 @@ "sid", "status" ], - "pathType": "list", - "mountName": "esim_profiles" + "mountName": "esim_profiles", + "pathType": "list" }, "post": { "description": "Order an eSIM Profile.", + "tags": [ + "SupersimV1EsimProfile" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.esim_profile" + }, + "examples": { + "createDefaultSmdp": { + "value": { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": null, + "sim_sid": null, + "status": "new", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": null, + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createActivationCode": { + "value": { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": null, + "sim_sid": null, + "status": "new", + "eid": null, + "smdp_plus_address": null, + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithCallback": { + "value": { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": null, + "sim_sid": null, + "status": "reserving", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": null, + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1057,9 +1206,6 @@ } ], "operationId": "CreateEsimProfile", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1093,6 +1239,25 @@ "description": "Identifier of the eUICC that will claim the eSIM Profile." } } + }, + "examples": { + "createDefaultSmdp": { + "value": { + "Eid": "89049032005008882600033489aaaaaa" + } + }, + "createActivationCode": { + "value": { + "GenerateMatchingId": true + } + }, + "createWithCallback": { + "value": { + "Eid": "89049032005008882600033489aaaaaa", + "CallbackUrl": "http://callback.twilio.com", + "CallbackMethod": "POST" + } + } } } } @@ -1100,6 +1265,9 @@ }, "get": { "description": "Retrieve a list of eSIM Profiles.", + "tags": [ + "SupersimV1EsimProfile" + ], "parameters": [ { "name": "Eid", @@ -1107,14 +1275,24 @@ "description": "List the eSIM Profiles that have been associated with an EId.", "schema": { "type": "string" + }, + "examples": { + "readByEid": { + "value": "89049032005008882600033489aaaaaa" + } } }, { "name": "SimSid", "in": "query", - "description": "Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.", + "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" + } } }, { @@ -1124,6 +1302,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/esim_profile_enum_status" + }, + "examples": { + "readByStatus": { + "value": "downloaded" + } } }, { @@ -1169,16 +1352,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1187,17 +1372,141 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readAll": { + "value": { + "esim_profiles": [ + { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "available", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/ESimProfiles?PageSize=50&Page=0", + "key": "esim_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/ESimProfiles?PageSize=50&Page=0" + } + } + }, + "readByEid": { + "value": { + "esim_profiles": [ + { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "available", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/ESimProfiles?Eid=89049032005008882600033489aaaaaa&PageSize=50&Page=0", + "key": "esim_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/ESimProfiles?Eid=89049032005008882600033489aaaaaa&PageSize=50&Page=0" + } + } + }, + "readBySimSid": { + "value": { + "esim_profiles": [ + { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "available", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/ESimProfiles?SimSid=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "esim_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/ESimProfiles?SimSid=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + } + } + }, + "readByStatus": { + "value": { + "esim_profiles": [ + { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "downloaded", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/ESimProfiles?Status=downloaded&PageSize=50&Page=0", + "key": "esim_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/ESimProfiles?Status=downloaded&PageSize=50&Page=0" } } } @@ -1212,10 +1521,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEsimProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "ListEsimProfile" } }, "/v1/ESimProfiles/{Sid}": { @@ -1230,11 +1536,14 @@ "sid", "status" ], - "pathType": "instance", - "mountName": "esim_profiles" + "mountName": "esim_profiles", + "pathType": "instance" }, "get": { "description": "Fetch an eSIM Profile.", + "tags": [ + "SupersimV1EsimProfile" + ], "parameters": [ { "name": "Sid", @@ -1252,6 +1561,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.esim_profile" + }, + "examples": { + "fetchDefaultSmdp": { + "value": { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "available", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchActivationCode": { + "value": { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "available", + "eid": null, + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": "AAAAA-BBBBB-CCCCC-DDDDD-EEEEE", + "activation_code": "1$SM-DP-PLUS.TWILIO.COM$AAAAA-BBBBB-CCCCC-DDDDD-EEEEE", + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1263,10 +1610,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEsimProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchEsimProfile" } }, "/v1/Fleets": { @@ -1286,12 +1630,36 @@ }, "post": { "description": "Create a Fleet", + "tags": [ + "SupersimV1Fleet" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.fleet" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 500, + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "sms_commands_enabled": true, + "sms_commands_method": "GET", + "sms_commands_url": "https://google.com", + "ip_commands_method": "GET", + "ip_commands_url": "https://google.com", + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1304,9 +1672,6 @@ } ], "operationId": "CreateFleet", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1374,6 +1739,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" + } + } } } } @@ -1381,6 +1761,9 @@ }, "get": { "description": "Retrieve a list of Fleets from your account.", + "tags": [ + "SupersimV1Fleet" + ], "parameters": [ { "name": "NetworkAccessProfile", @@ -1388,6 +1771,14 @@ "description": "The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFull": { + "value": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1433,16 +1824,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1451,19 +1844,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "fleets": [], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "fleets", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "fleets", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "fleets": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "Pilot Fleet", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "payg", + "date_created": "2019-10-15T20:00:00Z", + "date_updated": "2019-10-15T20:00:00Z", + "sms_commands_enabled": true, + "sms_commands_method": "POST", + "sms_commands_url": null, + "ip_commands_method": "POST", + "ip_commands_url": null, + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } } } } @@ -1476,10 +1915,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFleet", - "x-maturity": [ - "Beta" - ] + "operationId": "ListFleet" } }, "/v1/Fleets/{Sid}": { @@ -1499,6 +1935,9 @@ }, "get": { "description": "Fetch a Fleet instance from your account.", + "tags": [ + "SupersimV1Fleet" + ], "parameters": [ { "name": "Sid", @@ -1516,6 +1955,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.fleet" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "sms_commands_enabled": true, + "sms_commands_method": "POST", + "sms_commands_url": null, + "ip_commands_method": "POST", + "ip_commands_url": null, + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1527,13 +1987,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFleet", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchFleet" }, "post": { "description": "Updates the given properties of a Super SIM Fleet instance from your account.", + "tags": [ + "SupersimV1Fleet" + ], "parameters": [ { "name": "Sid", @@ -1551,6 +2011,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.fleet" + }, + "examples": { + "updateUniqueNameAndDataLimit": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "GPS Trackers Fleet 5GB", + "data_enabled": true, + "data_limit": 5000, + "data_metering": "payg", + "date_created": "2019-10-15T20:00:00Z", + "date_updated": "2019-10-15T20:00:00Z", + "sms_commands_enabled": true, + "sms_commands_method": "POST", + "sms_commands_url": null, + "ip_commands_method": "POST", + "ip_commands_url": null, + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1563,9 +2044,6 @@ } ], "operationId": "UpdateFleet", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1622,6 +2100,15 @@ "description": "The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000)." } } + }, + "examples": { + "updateUniqueNameAndDataLimit": { + "value": { + "UniqueName": "GPS Trackers Fleet 5GB", + "NetworkAccessProfile": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DataLimit": 5000 + } + } } } } @@ -1645,12 +2132,51 @@ }, "post": { "description": "Send an IP Command to a Super SIM.", + "tags": [ + "SupersimV1IpCommand" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.ip_command" + }, + "examples": { + "createFull": { + "value": { + "sid": "HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_iccid": "89883070000123456789", + "status": "queued", + "direction": "to_sim", + "device_ip": "100.64.0.123", + "device_port": 100, + "payload_type": "text", + "payload": "checkin: firmware update", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createMinimal": { + "value": { + "sid": "HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_iccid": "89883070000123456789", + "status": "queued", + "direction": "to_sim", + "device_ip": "100.64.0.123", + "device_port": 100, + "payload_type": "text", + "payload": "checkin: firmware update", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1663,9 +2189,6 @@ } ], "operationId": "CreateIpCommand", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1714,6 +2237,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 + } + } } } } @@ -1721,6 +2263,9 @@ }, "get": { "description": "Retrieve a list of IP Commands from your account.", + "tags": [ + "SupersimV1IpCommand" + ], "parameters": [ { "name": "Sim", @@ -1728,6 +2273,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" + } } }, { @@ -1741,10 +2294,18 @@ { "name": "Status", "in": "query", - "description": "The status of the IP Command. Can be: `queued`, `sent`, `received` or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/wireless/api/ipcommand-resource#status-values) for a description of each.", + "description": "The status of the IP Command. Can be: `queued`, `sent`, `received` or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/iot/supersim/api/ipcommand-resource#status-values) for a description of each.", "schema": { "type": "string", "$ref": "#/components/schemas/ip_command_enum_status" + }, + "examples": { + "readEmpty": { + "value": "received" + }, + "readFull": { + "value": "received" + } } }, { @@ -1799,16 +2360,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1817,19 +2380,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "ip_commands": [], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "ip_commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "ip_commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "ip_commands": [ + { + "sid": "HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_iccid": "89883070000123456789", + "status": "received", + "direction": "from_sim", + "device_ip": "100.64.0.123", + "device_port": 100, + "payload_type": "text", + "payload": "checkin: firmware update", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } } } } @@ -1842,10 +2449,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIpCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "ListIpCommand" } }, "/v1/IpCommands/{Sid}": { @@ -1865,6 +2469,9 @@ }, "get": { "description": "Fetch IP Command instance from your account.", + "tags": [ + "SupersimV1IpCommand" + ], "parameters": [ { "name": "Sid", @@ -1885,6 +2492,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.ip_command" + }, + "examples": { + "fetch": { + "value": { + "sid": "HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_iccid": "89883070000123456789", + "status": "queued", + "direction": "to_sim", + "device_ip": "100.64.0.123", + "device_port": 100, + "payload_type": "text", + "payload": "checkin: firmware update", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1896,10 +2522,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIpCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchIpCommand" } }, "/v1/Networks/{Sid}": { @@ -1917,6 +2540,9 @@ }, "get": { "description": "Fetch a Network resource.", + "tags": [ + "SupersimV1Network" + ], "parameters": [ { "name": "Sid", @@ -1937,6 +2563,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network" + }, + "examples": { + "fetch": { + "value": { + "friendly_name": "AT&T", + "iso_country": "US", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1948,10 +2590,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchNetwork" } }, "/v1/Networks": { @@ -1969,6 +2608,9 @@ }, "get": { "description": "Retrieve a list of Network resources.", + "tags": [ + "SupersimV1Network" + ], "parameters": [ { "name": "IsoCountry", @@ -1976,6 +2618,11 @@ "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resources to read.", "schema": { "type": "string" + }, + "examples": { + "readWithFilters": { + "value": "US" + } } }, { @@ -1984,6 +2631,11 @@ "description": "The 'mobile country code' of a country. Network resources with this `mcc` in their `identifiers` will be read.", "schema": { "type": "string" + }, + "examples": { + "readWithFilters": { + "value": "310" + } } }, { @@ -1992,6 +2644,11 @@ "description": "The 'mobile network code' of a mobile operator network. Network resources with this `mnc` in their `identifiers` will be read.", "schema": { "type": "string" + }, + "examples": { + "readWithFilters": { + "value": "410" + } } }, { @@ -2037,16 +2694,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2055,18 +2714,72 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Networks?PageSize=50&Page=0", + "key": "networks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Networks?PageSize=50&Page=0" + }, + "networks": [ + { + "friendly_name": "AT&T", + "iso_country": "US", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readWithFilters": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0", + "key": "networks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0" + }, + "networks": [ + { + "friendly_name": "AT&T", + "iso_country": "US", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -2080,10 +2793,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "ListNetwork" } }, "/v1/NetworkAccessProfiles": { @@ -2092,26 +2802,62 @@ "url": "https://supersim.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "fleets_count" ], - "pathType": "list", "dependentProperties": { - "network_access_profile_network": "{network_access_profile_sid: sid}" - } + "networks": { + "mapping": { + "network_access_profile_sid": "sid" + }, + "resource_url": "/v1/NetworkAccessProfiles/{network_access_profile_sid}/Networks" + } + }, + "pathType": "list" }, "post": { "description": "Create a new Network Access Profile", + "tags": [ + "SupersimV1NetworkAccessProfile" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network_access_profile" + }, + "examples": { + "createMinimal": { + "value": { + "unique_name": null, + "sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-05-01T20:00:00Z", + "date_updated": "2020-05-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks" + } + } + }, + "createWithNameAndNetworks": { + "value": { + "unique_name": "My Network Access Profile", + "sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-05-01T20:00:00Z", + "date_updated": "2020-05-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks" + } + } + } } } }, @@ -2124,9 +2870,6 @@ } ], "operationId": "CreateNetworkAccessProfile", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2146,6 +2889,20 @@ "description": "List of Network SIDs that this Network Access Profile will allow connections to." } } + }, + "examples": { + "createMinimal": { + "value": {} + }, + "createWithNameAndNetworks": { + "value": { + "UniqueName": "My Network Access Profile", + "Networks": [ + "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ] + } + } } } } @@ -2153,6 +2910,9 @@ }, "get": { "description": "Retrieve a list of Network Access Profiles from your account.", + "tags": [ + "SupersimV1NetworkAccessProfile" + ], "parameters": [ { "name": "PageSize", @@ -2197,16 +2957,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2215,19 +2977,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "network_access_profiles": [], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0", + "key": "network_access_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0" } } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0", + "key": "network_access_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0" + }, + "network_access_profiles": [ + { + "unique_name": "My Network Access Profile", + "sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-05-01T20:00:00Z", + "date_updated": "2020-05-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks" + } + } + ] + } } } } @@ -2240,10 +3042,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListNetworkAccessProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "ListNetworkAccessProfile" } }, "/v1/NetworkAccessProfiles/{Sid}": { @@ -2252,20 +3051,28 @@ "url": "https://supersim.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "fleets_count" ], - "pathType": "instance", "dependentProperties": { - "network_access_profile_network": "{network_access_profile_sid: sid}" - } + "networks": { + "mapping": { + "network_access_profile_sid": "sid" + }, + "resource_url": "/v1/NetworkAccessProfiles/{network_access_profile_sid}/Networks" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch a Network Access Profile instance from your account.", + "tags": [ + "SupersimV1NetworkAccessProfile" + ], "parameters": [ { "name": "Sid", @@ -2283,6 +3090,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network_access_profile" + }, + "examples": { + "fetch": { + "value": { + "unique_name": "My Network Access Profile", + "sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-05-01T20:00:00Z", + "date_updated": "2020-05-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks" + } + } + } } } }, @@ -2294,13 +3116,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNetworkAccessProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchNetworkAccessProfile" }, "post": { "description": "Updates the given properties of a Network Access Profile in your account.", + "tags": [ + "SupersimV1NetworkAccessProfile" + ], "parameters": [ { "name": "Sid", @@ -2318,7 +3140,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network_access_profile" - } + }, + "examples": { + "updateUniqueName": { + "value": { + "unique_name": "My Network Access Profile", + "sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-05-01T20:00:00Z", + "date_updated": "2020-05-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks" + } + } + } + } } }, "description": "OK" @@ -2330,9 +3167,6 @@ } ], "operationId": "UpdateNetworkAccessProfile", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2345,6 +3179,13 @@ "description": "The new unique name of the Network Access Profile." } } + }, + "examples": { + "updateUniqueName": { + "value": { + "UniqueName": "My Network Access Profile" + } + } } } } @@ -2362,12 +3203,15 @@ "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.", + "tags": [ + "SupersimV1NetworkAccessProfileNetwork" + ], "parameters": [ { "name": "NetworkAccessProfileSid", @@ -2421,16 +3265,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2439,18 +3285,46 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0", + "key": "networks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0" + }, + "networks": [ + { + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "AT&T", + "iso_country": "us", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -2464,13 +3338,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "ListNetworkAccessProfileNetwork" }, "post": { "description": "Add a Network resource to the Network Access Profile resource.", + "tags": [ + "SupersimV1NetworkAccessProfileNetwork" + ], "parameters": [ { "name": "NetworkAccessProfileSid", @@ -2488,6 +3362,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network" + }, + "examples": { + "create": { + "value": { + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "AT&T", + "iso_country": "us", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2500,9 +3391,6 @@ } ], "operationId": "CreateNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2521,6 +3409,13 @@ "required": [ "Network" ] + }, + "examples": { + "create": { + "value": { + "Network": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2538,12 +3433,15 @@ "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.", + "tags": [ + "SupersimV1NetworkAccessProfileNetwork" + ], "parameters": [ { "name": "NetworkAccessProfileSid", @@ -2580,13 +3478,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteNetworkAccessProfileNetwork" }, "get": { "description": "Fetch a Network Access Profile resource's Network resource.", + "tags": [ + "SupersimV1NetworkAccessProfileNetwork" + ], "parameters": [ { "name": "NetworkAccessProfileSid", @@ -2616,6 +3514,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network" + }, + "examples": { + "fetch": { + "value": { + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "AT&T", + "iso_country": "us", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2627,10 +3542,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchNetworkAccessProfileNetwork" } }, "/v1/SettingsUpdates": { @@ -2639,7 +3551,7 @@ "url": "https://supersim.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2651,6 +3563,9 @@ }, "get": { "description": "Retrieve a list of Settings Updates.", + "tags": [ + "SupersimV1SettingsUpdate" + ], "parameters": [ { "name": "Sim", @@ -2658,6 +3573,14 @@ "description": "Filter the Settings Updates by a Super SIM's SID or UniqueName.", "schema": { "type": "string" + }, + "examples": { + "readSimOnly": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFull": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2667,6 +3590,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/settings_update_enum_status" + }, + "examples": { + "readStatusOnly": { + "value": "scheduled" + }, + "readFull": { + "value": "scheduled" + } } }, { @@ -2712,16 +3643,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2730,17 +3663,124 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "settings_updates": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0", + "next_page_url": null, + "key": "settings_updates" + } + } + }, + "readSimOnly": { + "value": { + "settings_updates": [ + { + "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "successful", + "packages": [ + { + "name": "base-settings", + "version": "1.0.0", + "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings" + } + ], + "date_completed": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "settings_updates" + } + } + }, + "readStatusOnly": { + "value": { + "settings_updates": [ + { + "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "scheduled", + "packages": [ + { + "name": "base-settings", + "version": "1.0.0", + "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings" + } + ], + "date_completed": null, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0", + "next_page_url": null, + "key": "settings_updates" + } + } + }, + "readFull": { + "value": { + "settings_updates": [ + { + "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "scheduled", + "packages": [ + { + "name": "base-settings", + "version": "1.0.0", + "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings" + } + ], + "date_completed": null, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "settings_updates" } } } @@ -2755,10 +3795,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSettingsUpdate", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSettingsUpdate" } }, "/v1/Sims": { @@ -2774,20 +3811,52 @@ "unique_name", "status" ], - "pathType": "list", "dependentProperties": { - "billing_period": "{sim_sid: sid}", - "sim_ip_address": "{sim_sid: sid}" - } + "billing_periods": { + "mapping": { + "sim_sid": "sid" + }, + "resource_url": "/v1/Sims/{sim_sid}/BillingPeriods" + }, + "sim_ip_addresses": { + "mapping": { + "sim_sid": "sid" + }, + "resource_url": "/v1/Sims/{sim_sid}/IpAddresses" + } + }, + "pathType": "list" }, "post": { "description": "Register a Super SIM to your Account", + "tags": [ + "SupersimV1Sim" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sim" + }, + "examples": { + "create": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "", + "status": "new", + "fleet_sid": null, + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + } } } }, @@ -2800,9 +3869,6 @@ } ], "operationId": "CreateSim", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2823,6 +3889,14 @@ "Iccid", "RegistrationCode" ] + }, + "examples": { + "create": { + "value": { + "Iccid": "89883070000123456789", + "RegistrationCode": "H3LL0W0RLD" + } + } } } } @@ -2830,6 +3904,9 @@ }, "get": { "description": "Retrieve a list of Super SIMs from your account.", + "tags": [ + "SupersimV1Sim" + ], "parameters": [ { "name": "Status", @@ -2838,6 +3915,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sim_enum_status" + }, + "examples": { + "readEmpty": { + "value": "new" + }, + "readFullByFleetSid": { + "value": "new" + }, + "readFullByFleetName": { + "value": "new" + } } }, { @@ -2846,6 +3934,17 @@ "description": "The SID or unique name of the Fleet to which a list of Sims are assigned.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFullByFleetSid": { + "value": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFullByFleetName": { + "value": "MyFleet" + } } }, { @@ -2854,6 +3953,17 @@ "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readByIccid": { + "value": "89883070000123456789" + } } }, { @@ -2899,16 +4009,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2917,19 +4029,123 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sims": [], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } + }, + "readFullByFleetSid": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "sims": [ + { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My SIM", + "status": "new", + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + ] + } + }, + "readFullByFleetName": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=MyFleet&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=MyFleet&PageSize=50&Page=0" + }, + "sims": [ + { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My SIM", + "status": "new", + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + ] + } + }, + "readByIccid": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Sims?Iccid=89883070000123456789&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims?Iccid=89883070000123456789&PageSize=50&Page=0" + }, + "sims": [ + { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My SIM", + "status": "new", + "fleet_sid": null, + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + ] + } } } } @@ -2942,10 +4158,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSim", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSim" } }, "/v1/Sims/{Sid}": { @@ -2961,14 +4174,27 @@ "unique_name", "status" ], - "pathType": "instance", "dependentProperties": { - "billing_period": "{sim_sid: sid}", - "sim_ip_address": "{sim_sid: sid}" - } + "billing_periods": { + "mapping": { + "sim_sid": "sid" + }, + "resource_url": "/v1/Sims/{sim_sid}/BillingPeriods" + }, + "sim_ip_addresses": { + "mapping": { + "sim_sid": "sid" + }, + "resource_url": "/v1/Sims/{sim_sid}/IpAddresses" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch a Super SIM instance from your account.", + "tags": [ + "SupersimV1Sim" + ], "parameters": [ { "name": "Sid", @@ -2986,6 +4212,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sim" + }, + "examples": { + "fetch": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My SIM", + "status": "new", + "fleet_sid": null, + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + } } } }, @@ -2997,13 +4242,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSim", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSim" }, "post": { "description": "Updates the given properties of a Super SIM instance from your account.", + "tags": [ + "SupersimV1Sim" + ], "parameters": [ { "name": "Sid", @@ -3021,6 +4266,76 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sim" + }, + "examples": { + "updateUniqueName": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "MySIM", + "status": "new", + "fleet_sid": null, + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + }, + "updateFleetWithSid": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": null, + "status": "new", + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + }, + "updateFleetWithUniqueName": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": null, + "status": "new", + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + }, + "transferSimToAnotherAccount": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "unique_name": null, + "status": "new", + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + } } } }, @@ -3031,6 +4346,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sim" + }, + "examples": { + "updateStatus": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": null, + "status": "scheduled", + "fleet_sid": null, + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + } } } }, @@ -3043,9 +4377,6 @@ } ], "operationId": "UpdateSim", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3089,6 +4420,40 @@ "description": "The SID of the Account to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a Subaccount of the requesting Account. Only valid when the Sim resource's status is new." } } + }, + "examples": { + "updateUniqueName": { + "value": { + "UniqueName": "MySIM" + } + }, + "updateStatus": { + "value": { + "Status": "active", + "CallbackUrl": "http://127.0.0.1:9876/path", + "CallbackMethod": "POST" + } + }, + "updateFleetWithSid": { + "value": { + "Fleet": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CallbackUrl": "http://127.0.0.1:9876/path", + "CallbackMethod": "POST" + } + }, + "updateFleetWithUniqueName": { + "value": { + "Fleet": "My Fleet", + "CallbackUrl": "http://127.0.0.1:9876/path", + "CallbackMethod": "POST" + } + }, + "transferSimToAnotherAccount": { + "value": { + "AccountSid": "ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "Fleet": "My Fleet" + } + } } } } @@ -3107,12 +4472,15 @@ "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.", + "tags": [ + "SupersimV1SimIpAddress" + ], "parameters": [ { "name": "SimSid", @@ -3166,16 +4534,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3184,18 +4554,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "key": "ip_addresses", + "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0" + }, + "ip_addresses": [] + } + }, + "readNonEmpty": { + "value": { + "meta": { + "key": "ip_addresses", + "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0" + }, + "ip_addresses": [ + { + "ip_address": "8.8.8.8", + "ip_address_version": "IPv4" + } + ] } } } @@ -3209,10 +4612,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSimIpAddress", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSimIpAddress" } }, "/v1/SmsCommands": { @@ -3232,12 +4632,43 @@ }, "post": { "description": "Send SMS Command to a Sim.", + "tags": [ + "SupersimV1SmsCommand" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sms_command" + }, + "examples": { + "createCommandMinimal": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "payload": "checkin: firmware update", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "direction": "to_sim", + "url": "https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCommandFull": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "payload": "Report location: (52.520008, 13.404954)", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "direction": "to_sim", + "url": "https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3250,9 +4681,6 @@ } ], "operationId": "CreateSmsCommand", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3291,6 +4719,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" + } + } } } } @@ -3298,6 +4742,9 @@ }, "get": { "description": "Retrieve a list of SMS Commands from your account.", + "tags": [ + "SupersimV1SmsCommand" + ], "parameters": [ { "name": "Sim", @@ -3305,6 +4752,14 @@ "description": "The SID or unique name of the Sim resource that SMS Command was sent to or from.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFull": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3314,6 +4769,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sms_command_enum_status" + }, + "examples": { + "readEmpty": { + "value": "received" + }, + "readFull": { + "value": "received" + } } }, { @@ -3368,16 +4831,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3386,19 +4851,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sms_commands": [], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "sms_commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "sms_commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "sms_commands": [ + { + "sid": "HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "payload": "content of the command", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "received", + "direction": "from_sim", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } } } } @@ -3411,10 +4916,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSmsCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSmsCommand" } }, "/v1/SmsCommands/{Sid}": { @@ -3434,6 +4936,9 @@ }, "get": { "description": "Fetch SMS Command instance from your account.", + "tags": [ + "SupersimV1SmsCommand" + ], "parameters": [ { "name": "Sid", @@ -3454,6 +4959,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sms_command" + }, + "examples": { + "fetch": { + "value": { + "sid": "HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "payload": "content of the command", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "direction": "to_sim", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3465,10 +4985,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSmsCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSmsCommand" } }, "/v1/UsageRecords": { @@ -3487,6 +5004,9 @@ }, "get": { "description": "List UsageRecords", + "tags": [ + "SupersimV1UsageRecord" + ], "parameters": [ { "name": "Sim", @@ -3494,6 +5014,11 @@ "description": "SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.", "schema": { "type": "string" + }, + "examples": { + "readDaySimFilter": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3502,6 +5027,11 @@ "description": "SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.", "schema": { "type": "string" + }, + "examples": { + "readDayFleetFilter": { + "value": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3513,6 +5043,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^HW[0-9a-fA-F]{32}$" + }, + "examples": { + "readDayNetworkFilter": { + "value": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3522,6 +5057,14 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "readDayCountryFilter": { + "value": "FR" + }, + "readDayGroupBySimAndFilterByCountry": { + "value": "FR" + } } }, { @@ -3531,6 +5074,23 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_record_enum_group" + }, + "examples": { + "readDayGroupBySim": { + "value": "sim" + }, + "readDayGroupByFleet": { + "value": "fleet" + }, + "readDayGroupByNetwork": { + "value": "network" + }, + "readDayGroupByIsoCountry": { + "value": "isoCountry" + }, + "readDayGroupBySimAndFilterByCountry": { + "value": "sim" + } } }, { @@ -3540,6 +5100,26 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_record_enum_granularity" + }, + "examples": { + "readAllDay": { + "value": "day" + }, + "readAllHour": { + "value": "hour" + }, + "readDaySimFilter": { + "value": "day" + }, + "readDayNetworkFilter": { + "value": "day" + }, + "readDayCountryFilter": { + "value": "day" + }, + "readDayFleetFilter": { + "value": "day" + } } }, { @@ -3603,16 +5183,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3621,17 +5203,596 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readAll": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2015-05-01T20:00:00Z", + "end_time": "2015-06-01T20:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0" + } + } + }, + "readAllDay": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-02T00:00:00Z", + "end_time": "2019-05-03T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Granularity=day&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Granularity=day&PageSize=50&Page=0" + } + } + }, + "readAllHour": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-01T01:00:00Z", + "end_time": "2019-05-01T02:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-01T00:00:00Z", + "end_time": "2019-05-01T01:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Granularity=hour&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Granularity=hour&PageSize=50&Page=0" + } + } + }, + "readDaySimFilter": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "fleet_sid": null, + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-02T00:00:00Z", + "end_time": "2019-05-03T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0" + } + } + }, + "readDayNetworkFilter": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-02T00:00:00Z", + "end_time": "2019-05-03T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Network=HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Network=HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0" + } + } + }, + "readDayCountryFilter": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": "FR" + }, + { + "period": { + "start_time": "2019-05-02T00:00:00Z", + "end_time": "2019-05-03T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": "FR" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Granularity=day&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Granularity=day&PageSize=50&Page=0" + } + } + }, + "readDayFleetFilter": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-02T00:00:00Z", + "end_time": "2019-05-03T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0" + } + } + }, + "readDayGroupBySim": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": null, + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": "HSbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Group=sim&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Group=sim&PageSize=50&Page=0" + } + } + }, + "readDayGroupByFleet": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": "HFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Group=fleet&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Group=fleet&PageSize=50&Page=0" + } + } + }, + "readDayGroupByNetwork": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": "HWbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Group=network&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Group=network&PageSize=50&Page=0" + } + } + }, + "readDayGroupByIsoCountry": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": "FR" + }, + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": "US" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Group=isoCountry&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Group=isoCountry&PageSize=50&Page=0" + } + } + }, + "readDayGroupBySimAndFilterByCountry": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": null, + "network_sid": null, + "iso_country": "FR" + }, + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": "HSbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "fleet_sid": null, + "network_sid": null, + "iso_country": "FR" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Group=sim&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Group=sim&PageSize=50&Page=0" + } + } + }, + "readAllNoBilling": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2015-05-01T20:00:00Z", + "end_time": "2015-06-01T20:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 1000, + "data_download": 1000, + "data_total": 2000, + "data_total_billed": "0", + "billed_unit": null, + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0" } } } @@ -3646,10 +5807,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecord", - "x-maturity": [ - "Beta" - ] + "operationId": "ListUsageRecord" } } }, @@ -3658,14 +5816,50 @@ "url": "https://supersim.twilio.com" } ], - "x-maturity": [ + "tags": [ { - "name": "GA", - "description": "This product is Generally Available." + "name": "SupersimV1BillingPeriod" }, { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "name": "SupersimV1EsimProfile" + }, + { + "name": "SupersimV1Fleet" + }, + { + "name": "SupersimV1IpCommand" + }, + { + "name": "SupersimV1Network" + }, + { + "name": "SupersimV1NetworkAccessProfile" + }, + { + "name": "SupersimV1NetworkAccessProfileNetwork" + }, + { + "name": "SupersimV1Ota" + }, + { + "name": "SupersimV1SettingsUpdate" + }, + { + "name": "SupersimV1Sim" + }, + { + "name": "SupersimV1SimIpAddress" + }, + { + "name": "SupersimV1SmsCommand" + }, + { + "name": "SupersimV1UsageRecord" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_sync_v1.json b/spec/json/twilio_sync_v1.json index 3991c17a..4aa304b1 100644 --- a/spec/json/twilio_sync_v1.json +++ b/spec/json/twilio_sync_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "sync.v1.service.document": { "type": "object", @@ -15,7 +21,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long." + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -52,7 +64,13 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length." + "description": "An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 7 + } + } }, "date_expires": { "type": "string", @@ -75,7 +93,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync Document's creator. If the Sync Document is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`." + "description": "The identity of the Sync Document's creator. If the Sync Document is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } }, @@ -109,7 +133,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "read": { "type": "boolean", @@ -161,7 +191,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "date_created": { "type": "string", @@ -233,7 +269,13 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length." + "description": "An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 0 + } + } } } }, @@ -251,7 +293,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -307,7 +355,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync List was created from the REST API, the value is `system`." + "description": "The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync List was created from the REST API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } }, @@ -356,7 +410,13 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length." + "description": "An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 7 + } + } }, "date_expires": { "type": "string", @@ -379,7 +439,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the List Item's creator. If the item is created from the client SDK, the value matches the Access Token's `identity` field. If the item was created from the REST API, the value is `system`." + "description": "The identity of the List Item's creator. If the item is created from the client SDK, the value matches the Access Token's `identity` field. If the item was created from the REST API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } }, @@ -427,7 +493,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "read": { "type": "boolean", @@ -466,7 +538,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -522,7 +600,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Map was created from the REST API, the value is `system`." + "description": "The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Map was created from the REST API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } }, @@ -532,7 +616,13 @@ "key": { "type": "string", "nullable": true, - "description": "The unique, user-defined key for the Map Item." + "description": "The unique, user-defined key for the Map Item.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -571,7 +661,13 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length." + "description": "An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 7 + } + } }, "date_expires": { "type": "string", @@ -594,7 +690,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`." + "description": "The identity of the Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } }, @@ -642,7 +744,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "read": { "type": "boolean", @@ -681,7 +789,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -732,16 +846,16 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'." + "description": "The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -757,7 +871,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -774,14 +888,23 @@ "unique_name", "revision" ], - "pathType": "instance", "dependentProperties": { - "document_permission": "{service_sid: service_sid, document_sid: sid}" + "document_permissions": { + "mapping": { + "service_sid": "service_sid", + "document_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Documents/{document_sid}/Permissions" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "SyncV1Document" + ], "parameters": [ { "name": "ServiceSid", @@ -808,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" + } + } + } } } }, @@ -819,13 +962,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDocument", - "x-maturity": [ - "GA" - ] + "operationId": "FetchDocument" }, "delete": { "description": "", + "tags": [ + "SyncV1Document" + ], "parameters": [ { "name": "ServiceSid", @@ -856,13 +999,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDocument", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteDocument" }, "post": { "description": "", + "tags": [ + "SyncV1Document" + ], "parameters": [ { "name": "ServiceSid", @@ -897,6 +1040,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + } } } }, @@ -909,9 +1072,6 @@ } ], "operationId": "UpdateDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -927,6 +1087,15 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live)." } } + }, + "examples": { + "update": { + "value": { + "Data": "{}", + "UniqueName": "unique_name", + "Ttl": 3600 + } + } } } } @@ -946,14 +1115,23 @@ "unique_name", "revision" ], - "pathType": "list", "dependentProperties": { - "document_permission": "{service_sid: service_sid, document_sid: sid}" + "document_permissions": { + "mapping": { + "service_sid": "service_sid", + "document_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Documents/{document_sid}/Permissions" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "SyncV1Document" + ], "parameters": [ { "name": "ServiceSid", @@ -971,6 +1149,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + } } } }, @@ -983,9 +1181,6 @@ } ], "operationId": "CreateDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1005,6 +1200,15 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (the Sync Document's time-to-live)." } } + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "UniqueName": "unique_name", + "Ttl": 3600 + } + } } } } @@ -1012,6 +1216,9 @@ }, "get": { "description": "", + "tags": [ + "SyncV1Document" + ], "parameters": [ { "name": "ServiceSid", @@ -1065,16 +1272,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1083,17 +1292,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "documents": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "documents": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" } } } @@ -1108,10 +1362,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDocument", - "x-maturity": [ - "GA" - ] + "operationId": "ListDocument" } }, "/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { @@ -1128,12 +1379,15 @@ "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.", + "tags": [ + "SyncV1DocumentPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -1160,6 +1414,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -1169,6 +1429,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document.document_permission" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -1180,13 +1454,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDocumentPermission", - "x-maturity": [ - "GA" - ] + "operationId": "FetchDocumentPermission" }, "delete": { "description": "Delete a specific Sync Document Permission.", + "tags": [ + "SyncV1DocumentPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -1213,6 +1487,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -1226,13 +1506,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDocumentPermission", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteDocumentPermission" }, "post": { "description": "Update an identity's access to a specific Sync Document.", + "tags": [ + "SyncV1DocumentPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -1259,6 +1539,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -1268,6 +1554,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document.document_permission" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -1280,9 +1580,6 @@ } ], "operationId": "UpdateDocumentPermission", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1308,6 +1605,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -1328,12 +1634,15 @@ "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.", + "tags": [ + "SyncV1DocumentPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -1396,16 +1705,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1414,17 +1725,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -1439,10 +1789,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDocumentPermission", - "x-maturity": [ - "GA" - ] + "operationId": "ListDocumentPermission" } }, "/v1/Services/{Sid}": { @@ -1458,16 +1805,39 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "document": "{service_sid: sid}", - "sync_list": "{service_sid: sid}", - "sync_map": "{service_sid: sid}", - "sync_stream": "{service_sid: sid}" - } + "documents": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Documents" + }, + "sync_lists": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Lists" + }, + "sync_maps": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Maps" + }, + "sync_streams": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Streams" + } + }, + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "SyncV1Service" + ], "parameters": [ { "name": "Sid", @@ -1485,6 +1855,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", + "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "webhooks_from_rest_enabled": false, + "reachability_webhooks_enabled": false, + "acl_enabled": false, + "reachability_debouncing_enabled": false, + "reachability_debouncing_window": 5000 + } + } } } }, @@ -1496,13 +1891,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", + "tags": [ + "SyncV1Service" + ], "parameters": [ { "name": "Sid", @@ -1524,13 +1919,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", + "tags": [ + "SyncV1Service" + ], "parameters": [ { "name": "Sid", @@ -1548,6 +1943,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", + "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "webhooks_from_rest_enabled": false, + "reachability_webhooks_enabled": false, + "acl_enabled": true, + "reachability_debouncing_enabled": false, + "reachability_debouncing_window": 5000 + } + } } } }, @@ -1560,9 +1980,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1600,6 +2017,15 @@ "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true + } + } } } } @@ -1619,22 +2045,70 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "document": "{service_sid: sid}", - "sync_list": "{service_sid: sid}", - "sync_map": "{service_sid: sid}", - "sync_stream": "{service_sid: sid}" - } + "documents": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Documents" + }, + "sync_lists": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Lists" + }, + "sync_maps": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Maps" + }, + "sync_streams": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Streams" + } + }, + "pathType": "list" }, "post": { "description": "", + "tags": [ + "SyncV1Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", + "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "webhooks_from_rest_enabled": false, + "reachability_webhooks_enabled": false, + "acl_enabled": true, + "reachability_debouncing_enabled": false, + "reachability_debouncing_window": 5000 + } + } } } }, @@ -1647,9 +2121,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1687,6 +2158,16 @@ "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true, + "ReachabilityDebouncingWindow": 5000 + } + } } } } @@ -1694,6 +2175,9 @@ }, "get": { "description": "", + "tags": [ + "SyncV1Service" + ], "parameters": [ { "name": "PageSize", @@ -1738,16 +2222,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1756,18 +2242,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", + "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "webhooks_from_rest_enabled": false, + "reachability_webhooks_enabled": false, + "acl_enabled": false, + "reachability_debouncing_enabled": false, + "reachability_debouncing_window": 5000 + } + ] } } } @@ -1781,10 +2317,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages": { @@ -1793,17 +2326,20 @@ "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.", + "tags": [ + "SyncV1StreamMessage" + ], "parameters": [ { "name": "ServiceSid", @@ -1830,6 +2366,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream.stream_message" + }, + "examples": { + "create": { + "value": { + "sid": "TZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": {} + } + } } } }, @@ -1842,9 +2386,6 @@ } ], "operationId": "CreateStreamMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1859,6 +2400,13 @@ "required": [ "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}" + } + } } } } @@ -1878,16 +2426,31 @@ "unique_name", "revision" ], - "pathType": "instance", "dependentProperties": { - "sync_list_item": "{service_sid: service_sid, list_sid: sid}", - "sync_list_permission": "{service_sid: service_sid, list_sid: sid}" + "sync_list_items": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Lists/{list_sid}/Items" + }, + "sync_list_permissions": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Lists/{list_sid}/Permissions" + } }, "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "mountName": "sync_lists", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "SyncV1SyncList" + ], "parameters": [ { "name": "ServiceSid", @@ -1914,6 +2477,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1925,13 +2508,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncList" }, "delete": { "description": "", + "tags": [ + "SyncV1SyncList" + ], "parameters": [ { "name": "ServiceSid", @@ -1962,13 +2545,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncList" }, "post": { "description": "", + "tags": [ + "SyncV1SyncList" + ], "parameters": [ { "name": "ServiceSid", @@ -1995,6 +2578,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2007,9 +2610,6 @@ } ], "operationId": "UpdateSyncList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2026,6 +2626,13 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted." } } + }, + "examples": { + "update": { + "value": { + "Ttl": 3600 + } + } } } } @@ -2045,16 +2652,31 @@ "unique_name", "revision" ], - "pathType": "list", "dependentProperties": { - "sync_list_item": "{service_sid: service_sid, list_sid: sid}", - "sync_list_permission": "{service_sid: service_sid, list_sid: sid}" + "sync_list_items": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Lists/{list_sid}/Items" + }, + "sync_list_permissions": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Lists/{list_sid}/Permissions" + } }, "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "mountName": "sync_lists", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "SyncV1SyncList" + ], "parameters": [ { "name": "ServiceSid", @@ -2072,6 +2694,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2084,9 +2726,6 @@ } ], "operationId": "CreateSyncList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2107,6 +2746,14 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted." } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "Ttl": 3600 + } + } } } } @@ -2114,6 +2761,9 @@ }, "get": { "description": "", + "tags": [ + "SyncV1SyncList" + ], "parameters": [ { "name": "ServiceSid", @@ -2167,16 +2817,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2185,17 +2837,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "lists": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", + "key": "lists", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "lists": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", + "key": "lists", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" } } } @@ -2210,10 +2907,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncList", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncList" } }, "/v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { @@ -2229,12 +2923,15 @@ "revision", "created_by" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items" + "mountName": "sync_list_items", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "SyncV1SyncListItem" + ], "parameters": [ { "name": "ServiceSid", @@ -2270,6 +2967,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + } } } }, @@ -2281,13 +2995,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncListItem", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncListItem" }, "delete": { "description": "", + "tags": [ + "SyncV1SyncListItem" + ], "parameters": [ { "name": "ServiceSid", @@ -2335,13 +3049,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncListItem", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncListItem" }, "post": { "description": "", + "tags": [ + "SyncV1SyncListItem" + ], "parameters": [ { "name": "ServiceSid", @@ -2385,6 +3099,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + } } } }, @@ -2397,9 +3128,6 @@ } ], "operationId": "UpdateSyncListItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2423,6 +3151,14 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item's parent Sync List expires (time-to-live) and is deleted. This parameter can only be used when the List Item's `data` or `ttl` is updated in the same request." } } + }, + "examples": { + "update": { + "value": { + "Data": "{}", + "Ttl": 3600 + } + } } } } @@ -2442,12 +3178,15 @@ "revision", "created_by" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items" + "mountName": "sync_list_items", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "SyncV1SyncListItem" + ], "parameters": [ { "name": "ServiceSid", @@ -2474,6 +3213,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + } } } }, @@ -2486,9 +3242,6 @@ } ], "operationId": "CreateSyncListItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2515,6 +3268,14 @@ "required": [ "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "Ttl": 3600 + } + } } } } @@ -2522,6 +3283,9 @@ }, "get": { "description": "", + "tags": [ + "SyncV1SyncListItem" + ], "parameters": [ { "name": "ServiceSid", @@ -2548,6 +3312,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } } }, { @@ -2556,6 +3328,14 @@ "description": "The `index` of the first Sync List Item resource to read. See also `bounds`.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } } }, { @@ -2565,6 +3345,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } } }, { @@ -2610,16 +3398,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2628,17 +3418,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "items": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } } @@ -2653,10 +3485,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncListItem", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncListItem" } }, "/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { @@ -2673,12 +3502,15 @@ "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.", + "tags": [ + "SyncV1SyncListPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -2705,6 +3537,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -2714,6 +3552,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_permission" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -2725,13 +3577,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncListPermission", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncListPermission" }, "delete": { "description": "Delete a specific Sync List Permission.", + "tags": [ + "SyncV1SyncListPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -2758,6 +3610,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -2771,13 +3629,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncListPermission", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncListPermission" }, "post": { "description": "Update an identity's access to a specific Sync List.", + "tags": [ + "SyncV1SyncListPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -2804,6 +3662,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -2813,6 +3677,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_permission" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -2825,9 +3703,6 @@ } ], "operationId": "UpdateSyncListPermission", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2853,6 +3728,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -2873,12 +3757,15 @@ "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.", + "tags": [ + "SyncV1SyncListPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -2941,16 +3828,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2959,17 +3848,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -2984,10 +3912,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncListPermission", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncListPermission" } }, "/v1/Services/{ServiceSid}/Maps/{Sid}": { @@ -3003,16 +3928,31 @@ "unique_name", "revision" ], - "pathType": "instance", "dependentProperties": { - "sync_map_item": "{service_sid: service_sid, map_sid: sid}", - "sync_map_permission": "{service_sid: service_sid, map_sid: sid}" + "sync_map_items": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Maps/{map_sid}/Items" + }, + "sync_map_permissions": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Maps/{map_sid}/Permissions" + } }, "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "mountName": "sync_maps", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "SyncV1SyncMap" + ], "parameters": [ { "name": "ServiceSid", @@ -3039,6 +3979,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3050,13 +4010,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncMap", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncMap" }, "delete": { "description": "", + "tags": [ + "SyncV1SyncMap" + ], "parameters": [ { "name": "ServiceSid", @@ -3087,13 +4047,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncMap", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncMap" }, "post": { "description": "", + "tags": [ + "SyncV1SyncMap" + ], "parameters": [ { "name": "ServiceSid", @@ -3120,6 +4080,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3132,9 +4112,6 @@ } ], "operationId": "UpdateSyncMap", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3151,6 +4128,13 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted." } } + }, + "examples": { + "update": { + "value": { + "Ttl": 3600 + } + } } } } @@ -3170,16 +4154,31 @@ "unique_name", "revision" ], - "pathType": "list", "dependentProperties": { - "sync_map_item": "{service_sid: service_sid, map_sid: sid}", - "sync_map_permission": "{service_sid: service_sid, map_sid: sid}" + "sync_map_items": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Maps/{map_sid}/Items" + }, + "sync_map_permissions": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Maps/{map_sid}/Permissions" + } }, "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "mountName": "sync_maps", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "SyncV1SyncMap" + ], "parameters": [ { "name": "ServiceSid", @@ -3197,6 +4196,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3209,9 +4228,6 @@ } ], "operationId": "CreateSyncMap", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3232,6 +4248,14 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted." } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "Ttl": 3600 + } + } } } } @@ -3239,6 +4263,9 @@ }, "get": { "description": "", + "tags": [ + "SyncV1SyncMap" + ], "parameters": [ { "name": "ServiceSid", @@ -3292,16 +4319,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3310,17 +4339,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "maps": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "maps": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" } } } @@ -3335,10 +4409,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncMap", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncMap" } }, "/v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { @@ -3354,12 +4425,15 @@ "revision", "created_by" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items" + "mountName": "sync_map_items", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "SyncV1SyncMapItem" + ], "parameters": [ { "name": "ServiceSid", @@ -3386,6 +4460,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -3395,6 +4475,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + } } } }, @@ -3406,13 +4503,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncMapItem", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncMapItem" }, "delete": { "description": "", + "tags": [ + "SyncV1SyncMapItem" + ], "parameters": [ { "name": "ServiceSid", @@ -3439,6 +4536,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -3460,13 +4563,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncMapItem", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncMapItem" }, "post": { "description": "", + "tags": [ + "SyncV1SyncMapItem" + ], "parameters": [ { "name": "ServiceSid", @@ -3493,6 +4596,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -3510,6 +4619,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + } } } }, @@ -3522,9 +4648,6 @@ } ], "operationId": "UpdateSyncMapItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3548,6 +4671,14 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request." } } + }, + "examples": { + "update": { + "value": { + "Data": "{}", + "Ttl": 3600 + } + } } } } @@ -3567,12 +4698,15 @@ "revision", "created_by" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items" + "mountName": "sync_map_items", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "SyncV1SyncMapItem" + ], "parameters": [ { "name": "ServiceSid", @@ -3599,6 +4733,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + } } } }, @@ -3611,9 +4762,6 @@ } ], "operationId": "CreateSyncMapItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3645,6 +4793,15 @@ "Key", "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "Key": "key", + "Ttl": 3600 + } + } } } } @@ -3652,6 +4809,9 @@ }, "get": { "description": "", + "tags": [ + "SyncV1SyncMapItem" + ], "parameters": [ { "name": "ServiceSid", @@ -3678,6 +4838,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } } }, { @@ -3686,6 +4854,14 @@ "description": "The `key` of the first Sync Map Item resource to read. See also `bounds`.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } } }, { @@ -3695,6 +4871,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } } }, { @@ -3740,16 +4924,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3758,17 +4944,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "items": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } } @@ -3783,10 +5011,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncMapItem", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncMapItem" } }, "/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { @@ -3795,7 +5020,7 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "identity", @@ -3803,12 +5028,15 @@ "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.", + "tags": [ + "SyncV1SyncMapPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -3835,6 +5063,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -3844,6 +5078,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_permission" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -3855,13 +5103,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncMapPermission", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncMapPermission" }, "delete": { "description": "Delete a specific Sync Map Permission.", + "tags": [ + "SyncV1SyncMapPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -3888,6 +5136,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -3901,13 +5155,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncMapPermission", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncMapPermission" }, "post": { "description": "Update an identity's access to a specific Sync Map.", + "tags": [ + "SyncV1SyncMapPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -3934,6 +5188,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -3943,6 +5203,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_permission" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -3955,9 +5229,6 @@ } ], "operationId": "UpdateSyncMapPermission", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3983,6 +5254,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -3995,7 +5275,7 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "identity", @@ -4003,12 +5283,15 @@ "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.", + "tags": [ + "SyncV1SyncMapPermission" + ], "parameters": [ { "name": "ServiceSid", @@ -4071,16 +5354,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4089,17 +5374,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -4114,10 +5438,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncMapPermission", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncMapPermission" } }, "/v1/Services/{ServiceSid}/Streams/{Sid}": { @@ -4126,22 +5447,31 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "created_by" ], - "pathType": "instance", "dependentProperties": { - "stream_message": "{service_sid: service_sid, stream_sid: sid}" + "stream_messages": { + "mapping": { + "service_sid": "service_sid", + "stream_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Streams/{stream_sid}/Messages" + } }, "parent": "/Services/{Sid}", - "mountName": "sync_streams" + "mountName": "sync_streams", + "pathType": "instance" }, "get": { "description": "Fetch a specific Stream.", + "tags": [ + "SyncV1SyncStream" + ], "parameters": [ { "name": "ServiceSid", @@ -4168,6 +5498,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" + }, + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4179,13 +5527,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncStream", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncStream" }, "delete": { "description": "Delete a specific Stream.", + "tags": [ + "SyncV1SyncStream" + ], "parameters": [ { "name": "ServiceSid", @@ -4216,13 +5564,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncStream", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncStream" }, "post": { "description": "Update a specific Stream.", + "tags": [ + "SyncV1SyncStream" + ], "parameters": [ { "name": "ServiceSid", @@ -4249,6 +5597,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" + }, + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4261,9 +5627,6 @@ } ], "operationId": "UpdateSyncStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4276,6 +5639,13 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live)." } } + }, + "examples": { + "update": { + "value": { + "Ttl": 3600 + } + } } } } @@ -4288,22 +5658,31 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "created_by" ], - "pathType": "list", "dependentProperties": { - "stream_message": "{service_sid: service_sid, stream_sid: sid}" + "stream_messages": { + "mapping": { + "service_sid": "service_sid", + "stream_sid": "sid" + }, + "resource_url": "/v1/Services/{service_sid}/Streams/{stream_sid}/Messages" + } }, "parent": "/Services/{Sid}", - "mountName": "sync_streams" + "mountName": "sync_streams", + "pathType": "list" }, "post": { "description": "Create a new Stream.", + "tags": [ + "SyncV1SyncStream" + ], "parameters": [ { "name": "ServiceSid", @@ -4321,6 +5700,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" + }, + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4333,9 +5730,6 @@ } ], "operationId": "CreateSyncStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4352,6 +5746,14 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live)." } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "Ttl": 3600 + } + } } } } @@ -4359,6 +5761,9 @@ }, "get": { "description": "Retrieve a list of all Streams in a Service Instance.", + "tags": [ + "SyncV1SyncStream" + ], "parameters": [ { "name": "ServiceSid", @@ -4412,16 +5817,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4430,17 +5837,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "streams": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0", + "key": "streams", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "streams": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" + }, + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0", + "key": "streams", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0" } } } @@ -4455,10 +5905,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncStream", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncStream" } } }, @@ -4467,10 +5914,44 @@ "url": "https://sync.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "SyncV1Document" + }, + { + "name": "SyncV1DocumentPermission" + }, + { + "name": "SyncV1Service" + }, + { + "name": "SyncV1StreamMessage" + }, + { + "name": "SyncV1SyncList" + }, + { + "name": "SyncV1SyncListItem" + }, + { + "name": "SyncV1SyncListPermission" + }, + { + "name": "SyncV1SyncMap" + }, + { + "name": "SyncV1SyncMapItem" + }, + { + "name": "SyncV1SyncMapPermission" + }, + { + "name": "SyncV1SyncStream" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_taskrouter_v1.json b/spec/json/twilio_taskrouter_v1.json index fd4d74cc..8e64bbcb 100644 --- a/spec/json/twilio_taskrouter_v1.json +++ b/spec/json/twilio_taskrouter_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "taskrouter.v1.workspace.activity": { "type": "object", @@ -197,12 +203,18 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string with custom attributes of the work. **Note** If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null." + "description": "The JSON string with custom attributes of the work. **Note** If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "addons": { "type": "string", "nullable": true, - "description": "An object that contains the [addon](https://www.twilio.com/docs/taskrouter/marketplace) data for all installed addons." + "description": "An object that contains the [Add-on](https://www.twilio.com/docs/add-ons) data for all installed Add-ons." }, "date_created": { "type": "string", @@ -303,6 +315,12 @@ "format": "uri-map", "nullable": true, "description": "The URLs of related resources." + }, + "virtual_start_time": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT indicating the ordering for routing of the Task specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." } } }, @@ -424,7 +442,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "max_reserved_workers": { "type": "integer", @@ -492,6 +516,44 @@ "LIFO" ] }, + "taskrouter.v1.workspace.task_queue.task_queue_bulk_real_time_statistics": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource." + }, + "workspace_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Workspace that contains the TaskQueue." + }, + "task_queue_data": { + "type": "array", + "items": {}, + "nullable": true, + "description": "The real-time statistics for each requested TaskQueue SID. `task_queue_data` returns the following attributes:\n\n`task_queue_sid`: The SID of the TaskQueue from which these statistics were calculated.\n\n`total_available_workers`: The total number of Workers available for Tasks in the TaskQueue.\n\n`total_eligible_workers`: The total number of Workers eligible for Tasks in the TaskQueue, regardless of their Activity state.\n\n`total_tasks`: The total number of Tasks.\n\n`longest_task_waiting_age`: The age of the longest waiting Task.\n\n`longest_task_waiting_sid`: The SID of the longest waiting Task.\n\n`tasks_by_status`: The number of Tasks grouped by their current status.\n\n`tasks_by_priority`: The number of Tasks grouped by priority.\n\n`activity_statistics`: The number of current Workers grouped by Activity.\n" + }, + "task_queue_response_count": { + "type": "integer", + "nullable": true, + "description": "The number of TaskQueue statistics received in task_queue_data." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the TaskQueue statistics resource." + } + } + }, "taskrouter.v1.workspace.task_queue.task_queue_cumulative_statistics": { "type": "object", "properties": { @@ -934,7 +996,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that describes the Worker. For example: `{ \"email\": \"Bob@example.com\", \"phone\": \"+5095551234\" }`. **Note** If this property has been assigned a value, it will only be displayed in FETCH actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker." + "description": "The JSON string that describes the Worker. For example: `{ \"email\": \"Bob@example.com\", \"phone\": \"+5095551234\" }`. **Note** If this property has been assigned a value, it will only be displayed in FETCH actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "available": { "type": "boolean", @@ -962,7 +1030,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace." + "description": "The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "sid": { "type": "string", @@ -1431,7 +1505,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Workflow resource. For example, `Customer Support` or `2014 Election Campaign`." + "description": "The string that you assigned to describe the Workflow resource. For example, `Customer Support` or `2014 Election Campaign`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "sid": { "type": "string", @@ -1746,7 +1826,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Workspace resource. For example `Customer Support` or `2014 Election Campaign`." + "description": "The string that you assigned to describe the Workspace resource. For example `Customer Support` or `2014 Election Campaign`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "multi_task_enabled": { "type": "boolean", @@ -2016,12 +2102,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -2037,7 +2117,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -2047,18 +2127,21 @@ "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": "", + "tags": [ + "TaskrouterV1Activity" + ], "parameters": [ { "name": "WorkspaceSid", @@ -2091,6 +2174,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.activity" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available": true, + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "friendly_name": "New Activity", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -2102,13 +2202,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchActivity", - "x-maturity": [ - "GA" - ] + "operationId": "FetchActivity" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Activity" + ], "parameters": [ { "name": "WorkspaceSid", @@ -2141,6 +2241,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.activity" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available": true, + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "friendly_name": "New Activity", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -2153,9 +2270,6 @@ } ], "operationId": "UpdateActivity", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2168,6 +2282,13 @@ "description": "A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -2175,6 +2296,9 @@ }, "delete": { "description": "", + "tags": [ + "TaskrouterV1Activity" + ], "parameters": [ { "name": "WorkspaceSid", @@ -2211,10 +2335,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteActivity", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteActivity" } }, "/v1/Workspaces/{WorkspaceSid}/Activities": { @@ -2223,18 +2344,21 @@ "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": "", + "tags": [ + "TaskrouterV1Activity" + ], "parameters": [ { "name": "WorkspaceSid", @@ -2254,6 +2378,14 @@ "description": "The `friendly_name` of the Activity resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -2262,6 +2394,14 @@ "description": "Whether return only Activity resources that are available or unavailable. A value of `true` returns only available activities. Values of '1' or `yes` also indicate `true`. All other values represent `false` and return activities that are unavailable.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -2307,16 +2447,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2325,17 +2467,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "activities": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available": true, + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "friendly_name": "New Activity", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "activities", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "activities": [], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "activities", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0" } } } @@ -2350,13 +2534,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListActivity", - "x-maturity": [ - "GA" - ] + "operationId": "ListActivity" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Activity" + ], "parameters": [ { "name": "WorkspaceSid", @@ -2377,6 +2561,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.activity" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available": true, + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "friendly_name": "New Activity", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -2389,9 +2590,6 @@ } ], "operationId": "CreateActivity", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2411,6 +2609,14 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "Available": "true", + "FriendlyName": "friendly_name" + } + } } } } @@ -2423,18 +2629,21 @@ "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": "", + "tags": [ + "TaskrouterV1Event" + ], "parameters": [ { "name": "WorkspaceSid", @@ -2467,6 +2676,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.event" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_type": "workspace", + "actor_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Worker JustinWorker updated to Idle Activity", + "event_data": { + "worker_activity_name": "Offline", + "worker_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_attributes": "{}", + "worker_name": "JustinWorker", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_time_in_previous_activity": "26", + "worker_time_in_previous_activity_ms": "26123", + "workspace_name": "WorkspaceName", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "event_date": "2015-02-07T00:32:41Z", + "event_date_ms": 987654321111, + "event_type": "worker.activity", + "resource_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_type": "worker", + "resource_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "twilio", + "source_ip_address": "1.2.3.4", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2478,10 +2720,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEvent", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEvent" } }, "/v1/Workspaces/{WorkspaceSid}/Events": { @@ -2490,18 +2729,21 @@ "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": "", + "tags": [ + "TaskrouterV1Event" + ], "parameters": [ { "name": "WorkspaceSid", @@ -2522,6 +2764,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-03T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-03T00:00:00Z" + } } }, { @@ -2530,6 +2780,14 @@ "description": "The type of Events to read. Returns only Events of the type specified.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "reservation.created" + }, + "readEmpty": { + "value": "reservation.created" + } } }, { @@ -2549,6 +2807,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WR[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2558,6 +2824,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -2569,6 +2843,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2580,6 +2862,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WT[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2591,6 +2881,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WK[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2602,6 +2900,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2666,16 +2972,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2684,17 +2992,75 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "events": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_type": "workspace", + "actor_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Worker JustinWorker updated to Idle Activity", + "event_data": { + "worker_activity_name": "Offline", + "worker_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_attributes": "{}", + "worker_name": "JustinWorker", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_time_in_previous_activity": "26", + "worker_time_in_previous_activity_ms": "26123", + "workspace_name": "WorkspaceName", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "event_date": "2015-02-07T00:32:41Z", + "event_date_ms": 987654321111, + "event_type": "worker.activity", + "resource_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_type": "worker", + "resource_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "twilio", + "source_ip_address": "1.2.3.4", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "events", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "events": [], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "events", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } } @@ -2709,10 +3075,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEvent", - "x-maturity": [ - "GA" - ] + "operationId": "ListEvent" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}": { @@ -2721,7 +3084,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2730,14 +3093,23 @@ "priority", "reason" ], - "pathType": "instance", "dependentProperties": { - "reservation": "{workspace_sid: workspace_sid, task_sid: sid}" + "reservations": { + "mapping": { + "workspace_sid": "workspace_sid", + "task_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Tasks/{task_sid}/Reservations" + } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Task" + ], "parameters": [ { "name": "WorkspaceSid", @@ -2770,6 +3142,39 @@ "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", + "addons": "{}", + "links": { + "task_queue": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -2781,13 +3186,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTask", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTask" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Task" + ], "parameters": [ { "name": "WorkspaceSid", @@ -2828,6 +3233,39 @@ "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": "{}", + "links": { + "task_queue": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -2840,9 +3278,6 @@ } ], "operationId": "UpdateTask", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2870,6 +3305,22 @@ "TaskChannel": { "type": "string", "description": "When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`." + }, + "VirtualStartTime": { + "type": "string", + "format": "date-time", + "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" } } } @@ -2879,6 +3330,9 @@ }, "delete": { "description": "", + "tags": [ + "TaskrouterV1Task" + ], "parameters": [ { "name": "WorkspaceSid", @@ -2923,10 +3377,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTask", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTask" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks": { @@ -2935,7 +3386,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2944,14 +3395,23 @@ "priority", "reason" ], - "pathType": "list", "dependentProperties": { - "reservation": "{workspace_sid: workspace_sid, task_sid: sid}" + "reservations": { + "mapping": { + "workspace_sid": "workspace_sid", + "task_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Tasks/{task_sid}/Reservations" + } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Task" + ], "parameters": [ { "name": "WorkspaceSid", @@ -2971,6 +3431,17 @@ "description": "The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.", "schema": { "type": "integer" + }, + "examples": { + "readFull": { + "value": 1 + }, + "readEmpty": { + "value": 1 + }, + "readAssignmentStatusMultiple": { + "value": 1 + } } }, { @@ -2982,6 +3453,20 @@ "items": { "type": "string" } + }, + "examples": { + "readFull": { + "value": "pending,reserved" + }, + "readEmpty": { + "value": "pending" + }, + "readAssignmentStatusMultiple": { + "value": [ + "pending", + "reserved" + ] + } } }, { @@ -2993,6 +3478,17 @@ "minLength": 34, "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readAssignmentStatusMultiple": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3001,6 +3497,17 @@ "description": "The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "workflow_name" + }, + "readEmpty": { + "value": "workflow_name" + }, + "readAssignmentStatusMultiple": { + "value": "workflow_name" + } } }, { @@ -3012,6 +3519,17 @@ "minLength": 34, "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readAssignmentStatusMultiple": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3020,6 +3538,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" + } } }, { @@ -3033,7 +3562,7 @@ { "name": "Ordering", "in": "query", - "description": "How to order the returned Task resources. y default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `Priority` or `DateCreated` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Multiple sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order.", + "description": "How to order the returned Task resources. By default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Pairings of sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order. The only ordering pairing not allowed is DateCreated and VirtualStartTime.", "schema": { "type": "string" } @@ -3041,7 +3570,7 @@ { "name": "HasAddons", "in": "query", - "description": "Whether to read Tasks with addons. If `true`, returns only Tasks with addons. If `false`, returns only Tasks without addons.", + "description": "Whether to read Tasks with Add-ons. If `true`, returns only Tasks with Add-ons. If `false`, returns only Tasks without Add-ons.", "schema": { "type": "boolean" } @@ -3089,16 +3618,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3107,18 +3638,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" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending%2Creserved&PageSize=50&Page=0", + "key": "tasks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending%2Creserved&PageSize=50&Page=0" + }, + "tasks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "age": 25200, + "assignment_status": "pending", + "attributes": "{\"body\": \"hello\"}", + "date_created": "2014-05-14T14:26:54Z", + "date_updated": "2014-05-15T16:03:42Z", + "task_queue_entered_date": "2014-05-14T14:26:54Z", + "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", + "addons": "{}", + "links": { + "task_queue": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0", + "key": "tasks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0" + }, + "tasks": [] + } + }, + "readAssignmentStatusMultiple": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0", + "key": "tasks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0" + }, + "tasks": [] } } } @@ -3132,13 +3735,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListTask", - "x-maturity": [ - "GA" - ] + "operationId": "ListTask" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Task" + ], "parameters": [ { "name": "WorkspaceSid", @@ -3159,6 +3762,39 @@ "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", + "addons": "{}", + "links": { + "task_queue": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -3171,9 +3807,6 @@ } ], "operationId": "CreateTask", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3203,6 +3836,23 @@ "Attributes": { "type": "string", "description": "A URL-encoded JSON string with the attributes of the new task. This value is passed to the Workflow's `assignment_callback_url` when the Task is assigned to a Worker. For example: `{ \"task_type\": \"call\", \"twilio_call_sid\": \"CAxxx\", \"customer_ticket_number\": \"12345\" }`." + }, + "VirtualStartTime": { + "type": "string", + "format": "date-time", + "description": "The virtual start time to assign the new task and override the default. When supplied, the new task will have this virtual start time. When not supplied, the new task will have the virtual start time equal to `date_created`. Value can't be in the future." + } + } + }, + "examples": { + "create": { + "value": { + "Attributes": "{\"body\": \"attributes\"}", + "Priority": 1, + "Timeout": 1, + "WorkflowSid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TaskChannel": "channel", + "VirtualStartTime": "2014-05-14T18:50:02Z" } } } @@ -3224,11 +3874,14 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TaskrouterV1TaskChannel" + ], "parameters": [ { "name": "WorkspaceSid", @@ -3258,6 +3911,40 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_channel" + }, + "examples": { + "fetchSid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "friendly_name": "Default", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_optimized_routing": true, + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "fetchUniqueName": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "friendly_name": "Default", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_optimized_routing": false, + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -3269,13 +3956,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskChannel" }, "post": { "description": "", + "tags": [ + "TaskrouterV1TaskChannel" + ], "parameters": [ { "name": "WorkspaceSid", @@ -3305,6 +3992,40 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_channel" + }, + "examples": { + "updateSid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Default", + "unique_name": "default", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_optimized_routing": true, + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "updateUniqueName": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Default", + "unique_name": "default", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_optimized_routing": true, + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -3317,9 +4038,6 @@ } ], "operationId": "UpdateTaskChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3336,6 +4054,20 @@ "description": "Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized." } } + }, + "examples": { + "updateSid": { + "value": { + "FriendlyName": "Outbound Voice", + "ChannelOptimizedRouting": true + } + }, + "updateUniqueName": { + "value": { + "FriendlyName": "Outbound Voice", + "ChannelOptimizedRouting": true + } + } } } } @@ -3343,6 +4075,9 @@ }, "delete": { "description": "", + "tags": [ + "TaskrouterV1TaskChannel" + ], "parameters": [ { "name": "WorkspaceSid", @@ -3376,10 +4111,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTaskChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTaskChannel" } }, "/v1/Workspaces/{WorkspaceSid}/TaskChannels": { @@ -3395,11 +4127,14 @@ "friendly_name", "date_created" ], - "pathType": "list", - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "TaskrouterV1TaskChannel" + ], "parameters": [ { "name": "WorkspaceSid", @@ -3456,16 +4191,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3474,21 +4211,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } } - } + }, + "examples": { + "readFull": { + "value": { + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "friendly_name": "Default", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_optimized_routing": true, + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0", + "key": "channels", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "channels": [], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0", + "key": "channels", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0" + } + } + } + } } }, "description": "OK" @@ -3499,13 +4279,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskChannel" }, "post": { "description": "", + "tags": [ + "TaskrouterV1TaskChannel" + ], "parameters": [ { "name": "WorkspaceSid", @@ -3526,6 +4306,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_channel" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Outbound Voice", + "unique_name": "ovoice", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "channel_optimized_routing": true, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -3538,9 +4336,6 @@ } ], "operationId": "CreateTaskChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3565,6 +4360,14 @@ "FriendlyName", "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Outbound Voice", + "UniqueName": "ovoice" + } + } } } } @@ -3577,23 +4380,44 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "task_order" ], - "pathType": "instance", "dependentProperties": { - "task_queue_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}", - "task_queue_real_time_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}", - "task_queue_cumulative_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}" + "statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "task_queue_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/Statistics" + }, + "real_time_statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "task_queue_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/RealTimeStatistics" + }, + "cumulative_statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "task_queue_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/CumulativeStatistics" + } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TaskrouterV1TaskQueue" + ], "parameters": [ { "name": "WorkspaceSid", @@ -3626,6 +4450,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" + } + } } } }, @@ -3637,13 +4492,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueue", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueue" }, "post": { "description": "", + "tags": [ + "TaskrouterV1TaskQueue" + ], "parameters": [ { "name": "WorkspaceSid", @@ -3676,6 +4531,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" + } + } } } }, @@ -3688,9 +4574,6 @@ } ], "operationId": "UpdateTaskQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3730,6 +4613,18 @@ "description": "How Tasks will be assigned to Workers. Can be: `FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the oldest task first and `LIFO` to assign the most recent task first. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo)." } } + }, + "examples": { + "update": { + "value": { + "AssignmentActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "MaxReservedWorkers": 1, + "ReservationActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TargetWorkers": "target_workers", + "OperatingUnitSid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3737,6 +4632,9 @@ }, "delete": { "description": "", + "tags": [ + "TaskrouterV1TaskQueue" + ], "parameters": [ { "name": "WorkspaceSid", @@ -3773,10 +4671,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTaskQueue", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTaskQueue" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues": { @@ -3785,23 +4680,44 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "task_order" ], - "pathType": "list", "dependentProperties": { - "task_queue_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}", - "task_queue_real_time_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}", - "task_queue_cumulative_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}" + "statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "task_queue_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/Statistics" + }, + "real_time_statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "task_queue_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/RealTimeStatistics" + }, + "cumulative_statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "task_queue_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/CumulativeStatistics" + } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "TaskrouterV1TaskQueue" + ], "parameters": [ { "name": "WorkspaceSid", @@ -3821,6 +4737,20 @@ "description": "The `friendly_name` of the TaskQueue resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -3829,6 +4759,14 @@ "description": "The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "evaluate_worker_attributes" + }, + "readEmpty": { + "value": "evaluate_worker_attributes" + } } }, { @@ -3893,16 +4831,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3911,18 +4851,74 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://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": [] } } } @@ -3936,13 +4932,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskQueue", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskQueue" }, "post": { "description": "", + "tags": [ + "TaskrouterV1TaskQueue" + ], "parameters": [ { "name": "WorkspaceSid", @@ -3963,6 +4959,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" + } + } } } }, @@ -3975,9 +5002,6 @@ } ], "operationId": "CreateTaskQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4020,6 +5044,136 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "AssignmentActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "MaxReservedWorkers": 1, + "ReservationActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TargetWorkers": "target_workers", + "OperatingUnitSid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + } + } + }, + "/v1/Workspaces/{WorkspaceSid}/TaskQueues/RealTimeStatistics": { + "servers": [ + { + "url": "https://taskrouter.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "account_sid", + "workspace_sid", + "task_queue_data", + "task_queue_response_count" + ], + "parent": "/Workspaces/{WorkspaceSid}/TaskQueues", + "mountName": "bulk_real_time_statistics", + "className": "task_queue_bulk_real_time_statistics", + "pathType": "list" + }, + "post": { + "description": "Fetch a Task Queue Real Time Statistics in bulk for the array of TaskQueue SIDs, support upto 50 in a request.", + "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": { + "201": { + "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 + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateTaskQueueBulkRealTimeStatistics", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateTaskQueueBulkRealTimeStatisticsRequest", + "properties": {} } } } @@ -4032,7 +5186,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "start_time", @@ -4040,12 +5194,15 @@ "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": "", + "tags": [ + "TaskrouterV1TaskQueueCumulativeStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -4078,6 +5235,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -4095,6 +5257,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -4120,6 +5287,70 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_cumulative_statistics" + }, + "examples": { + "fetch": { + "value": { + "reservations_created": 100, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations_rejected": 100, + "tasks_completed": 100, + "end_time": "2015-07-30T20:00:00Z", + "tasks_entered": 100, + "tasks_canceled": 100, + "reservations_accepted": 100, + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations_timed_out": 100, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "wait_duration_until_canceled": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "wait_duration_until_accepted": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "wait_duration_in_queue_until_accepted": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "split_by_wait_time": { + "5": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + }, + "10": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + } + }, + "start_time": "2015-07-30T20:00:00Z", + "tasks_moved": 100, + "reservations_canceled": 100, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_deleted": 100, + "reservations_rescinded": 100, + "avg_task_acceptance_time": 100 + } + } } } }, @@ -4131,10 +5362,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueueCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueueCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/RealTimeStatistics": { @@ -4143,19 +5371,22 @@ "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": "", + "tags": [ + "TaskrouterV1TaskQueueRealTimeStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -4187,6 +5418,11 @@ "description": "The TaskChannel for which to fetch statistics. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "voice" + } } } ], @@ -4196,6 +5432,52 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_real_time_statistics" + }, + "examples": { + "fetch": { + "value": { + "longest_task_waiting_age": 100, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "longest_relative_task_age_in_queue": 100, + "longest_relative_task_sid_in_queue": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "reserved": 0, + "pending": 0, + "assigned": 0, + "wrapping": 0 + }, + "total_eligible_workers": 100, + "activity_statistics": [ + { + "friendly_name": "Idle", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Busy", + "workers": 9, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Offline", + "workers": 6, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Reserved", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "tasks_by_priority": {}, + "total_tasks": 100, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "total_available_workers": 100, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics" + } + } } } }, @@ -4207,10 +5489,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueueRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueueRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics": { @@ -4219,17 +5498,20 @@ "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": "", + "tags": [ + "TaskrouterV1TaskQueueStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -4262,6 +5544,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -4270,6 +5557,11 @@ "description": "Only calculate statistics since this many minutes in the past. The default is 15 minutes.", "schema": { "type": "integer" + }, + "examples": { + "fetch": { + "value": 1 + } } }, { @@ -4279,6 +5571,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -4304,6 +5601,76 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_statistics" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "cumulative": { + "avg_task_acceptance_time": 0.0, + "end_time": "2015-08-18T08:42:34Z", + "reservations_accepted": 0, + "reservations_canceled": 0, + "reservations_created": 0, + "reservations_rejected": 0, + "reservations_rescinded": 0, + "reservations_timed_out": 0, + "start_time": "2015-08-18T08:27:34Z", + "tasks_canceled": 0, + "tasks_deleted": 0, + "tasks_entered": 0, + "tasks_moved": 0 + }, + "realtime": { + "activity_statistics": [ + { + "friendly_name": "Offline", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Idle", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Reserved", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Busy", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "817ca1c5-3a05-11e5-9292-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + } + ], + "longest_task_waiting_age": 0, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "assigned": 0, + "pending": 0, + "reserved": 0, + "wrapping": 0 + }, + "total_available_workers": 0, + "total_eligible_workers": 0, + "total_tasks": 0 + }, + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4315,10 +5682,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueueStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueueStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics": { @@ -4327,17 +5691,20 @@ "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": "", + "tags": [ + "TaskrouterV1TaskQueuesStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -4358,6 +5725,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -4366,6 +5741,14 @@ "description": "The `friendly_name` of the TaskQueue statistics to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -4374,6 +5757,14 @@ "description": "Only calculate statistics since this many minutes in the past. The default is 15 minutes.", "schema": { "type": "integer" + }, + "examples": { + "readFull": { + "value": 1 + }, + "readEmpty": { + "value": 1 + } } }, { @@ -4383,6 +5774,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -4444,16 +5843,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4462,18 +5863,112 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0", + "key": "task_queues_statistics", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0" + }, + "task_queues_statistics": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cumulative": { + "avg_task_acceptance_time": 0.0, + "end_time": "2015-08-18T08:46:15Z", + "reservations_accepted": 0, + "reservations_canceled": 0, + "reservations_created": 0, + "reservations_rejected": 0, + "reservations_rescinded": 0, + "reservations_timed_out": 0, + "start_time": "2015-08-18T08:31:15Z", + "tasks_canceled": 0, + "tasks_deleted": 0, + "tasks_entered": 0, + "tasks_moved": 0 + }, + "realtime": { + "activity_statistics": [ + { + "friendly_name": "Offline", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Idle", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Reserved", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Busy", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "817ca1c5-3a05-11e5-9292-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + } + ], + "longest_task_waiting_age": 0, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "assigned": 0, + "pending": 0, + "reserved": 0, + "wrapping": 0 + }, + "total_available_workers": 0, + "total_eligible_workers": 0, + "total_tasks": 0 + }, + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0", + "key": "task_queues_statistics", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0" + }, + "task_queues_statistics": [] } } } @@ -4487,10 +5982,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskQueuesStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskQueuesStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations": { @@ -4507,11 +5999,14 @@ "worker_name", "worker_sid" ], - "pathType": "list", - "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Reservation" + ], "parameters": [ { "name": "WorkspaceSid", @@ -4600,16 +6095,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4618,18 +6115,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0", + "key": "reservations", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0" + }, + "reservations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0", + "key": "reservations", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0" + }, + "reservations": [] } } } @@ -4643,10 +6186,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskReservation", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskReservation" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}": { @@ -4663,11 +6203,14 @@ "worker_name", "worker_sid" ], - "pathType": "instance", - "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Reservation" + ], "parameters": [ { "name": "WorkspaceSid", @@ -4712,6 +6255,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task.task_reservation" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4723,13 +6287,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskReservation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskReservation" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Reservation" + ], "parameters": [ { "name": "WorkspaceSid", @@ -4782,6 +6346,46 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task.task_reservation" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateSuperviseInstruction": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4794,9 +6398,6 @@ } ], "operationId": "UpdateTaskReservation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5094,6 +6695,24 @@ "BeepOnCustomerEntrance": { "type": "boolean", "description": "Whether to play a notification beep when the customer joins." + }, + "JitterBufferSize": { + "type": "string", + "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" } } } @@ -5108,25 +6727,56 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "available" ], - "pathType": "list", "dependentProperties": { - "workers_real_time_statistics": "{workspace_sid: workspace_sid}", - "workers_cumulative_statistics": "{workspace_sid: workspace_sid}", - "worker_statistics": "{workspace_sid: workspace_sid, worker_sid: sid}", - "reservation": "{workspace_sid: workspace_sid, worker_sid: sid}", - "worker_channel": "{workspace_sid: workspace_sid, worker_sid: sid}" + "real_time_statistics": { + "mapping": { + "workspace_sid": "workspace_sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/RealTimeStatistics" + }, + "cumulative_statistics": { + "mapping": { + "workspace_sid": "workspace_sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/CumulativeStatistics" + }, + "statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "worker_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Statistics" + }, + "reservations": { + "mapping": { + "workspace_sid": "workspace_sid", + "worker_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Reservations" + }, + "worker_channels": { + "mapping": { + "workspace_sid": "workspace_sid", + "worker_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Channels" + } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Worker" + ], "parameters": [ { "name": "WorkspaceSid", @@ -5146,6 +6796,14 @@ "description": "The `activity_name` of the Worker resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "activity_name" + }, + "readEmpty": { + "value": "activity_name" + } } }, { @@ -5157,6 +6815,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WA[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -5165,6 +6831,14 @@ "description": "Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "available" + }, + "readEmpty": { + "value": "available" + } } }, { @@ -5173,14 +6847,36 @@ "description": "The `friendly_name` of the Worker resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { "name": "TargetWorkersExpression", "in": "query", - "description": "Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.", + "description": "Filter by Workers that would match an expression. In addition to fields in the workers' attributes, the expression can include the following worker fields: `sid`, `friendly_name`, `activity_sid`, or `activity_name`", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "target_workers_expression" + }, + "readEmpty": { + "value": "target_workers_expression" + } } }, { @@ -5189,7 +6885,15 @@ "description": "The `friendly_name` of the TaskQueue that the Workers to read are eligible for.", "schema": { "type": "string" - } + }, + "examples": { + "readFull": { + "value": "task_queue_name" + }, + "readEmpty": { + "value": "task_queue_name" + } + } }, { "name": "TaskQueueSid", @@ -5200,6 +6904,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -5253,16 +6965,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5271,18 +6985,73 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0", + "next_page_url": null, + "key": "workers" + }, + "workers": [ + { + "sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "testWorker", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_name": "Offline", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "available": false, + "date_created": "2017-05-30T23:05:29Z", + "date_updated": "2017-05-30T23:05:29Z", + "date_status_changed": "2017-05-30T23:05:29Z", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics", + "worker_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "worker_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "workers", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "workers": [] } } } @@ -5296,13 +7065,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorker", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorker" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Worker" + ], "parameters": [ { "name": "WorkspaceSid", @@ -5323,6 +7092,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" + }, + "examples": { + "create": { + "value": { + "sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "NewWorker", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_name": "Offline", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "available": false, + "date_created": "2017-05-30T23:19:38Z", + "date_updated": "2017-05-30T23:19:38Z", + "date_status_changed": "2017-05-30T23:19:38Z", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics", + "worker_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "worker_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -5335,9 +7134,6 @@ } ], "operationId": "CreateWorker", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5364,6 +7160,16 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "ActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "attributes", + "FriendlyName": "friendly_name", + "OperatingUnitSid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -5376,25 +7182,56 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "available" ], - "pathType": "instance", "dependentProperties": { - "workers_real_time_statistics": "{workspace_sid: workspace_sid}", - "workers_cumulative_statistics": "{workspace_sid: workspace_sid}", - "worker_statistics": "{workspace_sid: workspace_sid, worker_sid: sid}", - "reservation": "{workspace_sid: workspace_sid, worker_sid: sid}", - "worker_channel": "{workspace_sid: workspace_sid, worker_sid: sid}" + "real_time_statistics": { + "mapping": { + "workspace_sid": "workspace_sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/RealTimeStatistics" + }, + "cumulative_statistics": { + "mapping": { + "workspace_sid": "workspace_sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/CumulativeStatistics" + }, + "statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "worker_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Statistics" + }, + "reservations": { + "mapping": { + "workspace_sid": "workspace_sid", + "worker_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Reservations" + }, + "worker_channels": { + "mapping": { + "workspace_sid": "workspace_sid", + "worker_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Channels" + } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Worker" + ], "parameters": [ { "name": "WorkspaceSid", @@ -5427,6 +7264,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_name": "available", + "activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "available": false, + "date_created": "2017-05-30T23:32:39Z", + "date_status_changed": "2017-05-30T23:32:39Z", + "date_updated": "2017-05-30T23:32:39Z", + "friendly_name": "NewWorker3", + "sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics", + "worker_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "worker_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -5438,13 +7305,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorker", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorker" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Worker" + ], "parameters": [ { "name": "WorkspaceSid", @@ -5485,6 +7352,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" + }, + "examples": { + "update": { + "value": { + "sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "blah", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_name": "Offline", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "available": false, + "date_created": "2017-05-30T23:32:22Z", + "date_updated": "2017-05-31T00:05:57Z", + "date_status_changed": "2017-05-30T23:32:22Z", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics", + "worker_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "worker_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -5497,9 +7394,6 @@ } ], "operationId": "UpdateWorker", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5527,6 +7421,16 @@ "description": "Whether to reject the Worker's pending reservations. This option is only valid if the Worker's new [Activity](https://www.twilio.com/docs/taskrouter/api/activity) resource has its `availability` property set to `False`." } } + }, + "examples": { + "update": { + "value": { + "ActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "attributes", + "FriendlyName": "friendly_name", + "OperatingUnitSid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -5534,6 +7438,9 @@ }, "delete": { "description": "", + "tags": [ + "TaskrouterV1Worker" + ], "parameters": [ { "name": "WorkspaceSid", @@ -5578,10 +7485,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWorker", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWorker" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels": { @@ -5590,19 +7494,22 @@ "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": "", + "tags": [ + "TaskrouterV1WorkerChannel" + ], "parameters": [ { "name": "WorkspaceSid", @@ -5671,16 +7578,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5689,18 +7598,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "key": "channels", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0" + }, + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assigned_tasks": 0, + "available": true, + "available_capacity_percentage": 100, + "configured_capacity": 1, + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "sid": "WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "key": "channels", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0" + }, + "channels": [] } } } @@ -5714,10 +7667,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkerChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkerChannel" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}": { @@ -5726,19 +7676,22 @@ "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": "", + "tags": [ + "TaskrouterV1WorkerChannel" + ], "parameters": [ { "name": "WorkspaceSid", @@ -5780,6 +7733,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_channel" + }, + "examples": { + "fetchSid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assigned_tasks": 0, + "available": true, + "available_capacity_percentage": 100, + "configured_capacity": 1, + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "sid": "WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5791,13 +7763,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerChannel" }, "post": { "description": "", + "tags": [ + "TaskrouterV1WorkerChannel" + ], "parameters": [ { "name": "WorkspaceSid", @@ -5839,6 +7811,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_channel" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assigned_tasks": 0, + "available": true, + "available_capacity_percentage": 100, + "configured_capacity": 3, + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "sid": "WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5851,9 +7842,6 @@ } ], "operationId": "UpdateWorkerChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5870,6 +7858,13 @@ "description": "Whether the WorkerChannel is available. Set to `false` to prevent the Worker from receiving any new Tasks of this TaskChannel type." } } + }, + "examples": { + "update": { + "value": { + "Capacity": 3 + } + } } } } @@ -5882,17 +7877,20 @@ "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": "", + "tags": [ + "TaskrouterV1WorkerStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -5924,6 +7922,11 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "schema": { "type": "integer" + }, + "examples": { + "fetch": { + "value": 1 + } } }, { @@ -5933,6 +7936,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -5942,6 +7950,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -5959,6 +7972,60 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_instance_statistics" + }, + "examples": { + "fetch": { + "value": { + "cumulative": { + "reservations_created": 100, + "reservations_accepted": 100, + "reservations_rejected": 100, + "reservations_timed_out": 100, + "reservations_canceled": 100, + "reservations_rescinded": 100, + "activity_durations": [ + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Offline", + "avg": 1080, + "total": 5400 + }, + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Busy", + "avg": 1012, + "total": 8100 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Idle", + "avg": 0, + "total": 0 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Reserved", + "avg": 0, + "total": 0 + } + ], + "start_time": "2008-01-02T00:00:00Z", + "end_time": "2008-01-02T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" + } + } } } }, @@ -5970,10 +8037,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerInstanceStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerInstanceStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations": { @@ -5989,11 +8053,14 @@ "reservation_status", "date_created" ], - "pathType": "list", - "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Reservation" + ], "parameters": [ { "name": "WorkspaceSid", @@ -6071,16 +8138,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6089,18 +8158,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0", + "key": "reservations", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0" + }, + "reservations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0", + "key": "reservations", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0" + }, + "reservations": [] } } } @@ -6114,10 +8229,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkerReservation", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkerReservation" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}": { @@ -6133,11 +8245,14 @@ "reservation_status", "date_created" ], - "pathType": "instance", - "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Reservation" + ], "parameters": [ { "name": "WorkspaceSid", @@ -6182,6 +8297,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -6193,13 +8329,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerReservation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerReservation" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Reservation" + ], "parameters": [ { "name": "WorkspaceSid", @@ -6252,6 +8388,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -6264,9 +8421,6 @@ } ], "operationId": "UpdateWorkerReservation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6555,6 +8709,17 @@ "BeepOnCustomerEntrance": { "type": "boolean", "description": "Whether to play a notification beep when the customer joins." + }, + "JitterBufferSize": { + "type": "string", + "description": "The jitter buffer size for conference. Can be: `small`, `medium`, `large`, `off`." + } + } + }, + "examples": { + "update": { + "value": { + "ReservationStatus": "accepted" } } } @@ -6569,17 +8734,20 @@ "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": "", + "tags": [ + "TaskrouterV1WorkersStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -6599,6 +8767,11 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "schema": { "type": "integer" + }, + "examples": { + "fetch": { + "value": 1 + } } }, { @@ -6608,6 +8781,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -6617,6 +8795,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -6661,6 +8844,84 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_statistics" + }, + "examples": { + "fetch": { + "value": { + "cumulative": { + "reservations_created": 0, + "reservations_accepted": 0, + "reservations_rejected": 0, + "reservations_timed_out": 0, + "reservations_canceled": 0, + "reservations_rescinded": 0, + "activity_durations": [ + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Offline", + "avg": 1080, + "total": 5400 + }, + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Busy", + "avg": 1012, + "total": 8100 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Idle", + "avg": 0, + "total": 0 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Reserved", + "avg": 0, + "total": 0 + } + ], + "start_time": "2008-01-02T00:00:00Z", + "end_time": "2008-01-02T00:00:00Z" + }, + "realtime": { + "total_workers": 15, + "activity_statistics": [ + { + "friendly_name": "Idle", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Busy", + "workers": 9, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Offline", + "workers": 6, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Reserved", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + }, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics" + } + } } } }, @@ -6672,10 +8933,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics": { @@ -6684,7 +8942,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "reservations_created", @@ -6694,12 +8952,15 @@ "reservations_canceled", "reservations_rescinded" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", - "className": "workers_cumulative_statistics" + "className": "workers_cumulative_statistics", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TaskrouterV1WorkersCumulativeStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -6720,6 +8981,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -6737,6 +9003,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -6754,6 +9025,57 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.workers_cumulative_statistics" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics", + "reservations_created": 100, + "reservations_accepted": 100, + "reservations_rejected": 100, + "reservations_timed_out": 100, + "reservations_canceled": 100, + "reservations_rescinded": 100, + "activity_durations": [ + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Offline", + "avg": 1080, + "total": 5400 + }, + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Busy", + "avg": 1012, + "total": 8100 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Idle", + "avg": 0, + "total": 0 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Reserved", + "avg": 0, + "total": 0 + } + ], + "start_time": "2015-07-30T20:00:00Z", + "end_time": "2015-07-30T20:00:00Z" + } + } } } }, @@ -6765,10 +9087,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkersCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkersCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics": { @@ -6777,17 +9096,20 @@ "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": "", + "tags": [ + "TaskrouterV1WorkersRealTimeStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -6807,6 +9129,11 @@ "description": "Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "voice" + } } } ], @@ -6816,6 +9143,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.workers_real_time_statistics" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics", + "total_workers": 15, + "activity_statistics": [ + { + "friendly_name": "Idle", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Busy", + "workers": 9, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Offline", + "workers": 6, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Reserved", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } } } }, @@ -6827,10 +9186,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkersRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkersRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}": { @@ -6839,23 +9195,44 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "document_content_type" ], - "pathType": "instance", "dependentProperties": { - "workflow_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}", - "workflow_real_time_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}", - "workflow_cumulative_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}" + "statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "workflow_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/Statistics" + }, + "real_time_statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "workflow_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/RealTimeStatistics" + }, + "cumulative_statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "workflow_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/CumulativeStatistics" + } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Workflow" + ], "parameters": [ { "name": "WorkspaceSid", @@ -6888,6 +9265,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_callback_url": "http://example.com", + "configuration": "task-routing:\\n - filter: \\n - 1 == 1\\n target:\\n - queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\n set-priority: 0\\n", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "document_content_type": "application/json", + "fallback_assignment_callback_url": null, + "friendly_name": "Default Fifo Workflow", + "sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_reservation_timeout": 120, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics" + } + } + } } } }, @@ -6899,13 +9299,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflow", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflow" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Workflow" + ], "parameters": [ { "name": "WorkspaceSid", @@ -6938,6 +9338,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_callback_url": "http://example.com", + "configuration": "task-routing:\\n - filter: \\n - 1 == 1\\n target:\\n - queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\n set-priority: 0\\n", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "document_content_type": "application/json", + "fallback_assignment_callback_url": null, + "friendly_name": "Default Fifo Workflow", + "sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_reservation_timeout": 120, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics" + }, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -6950,9 +9373,6 @@ } ], "operationId": "UpdateWorkflow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6987,6 +9407,18 @@ "description": "Whether or not to re-evaluate Tasks. The default is `false`, which means Tasks in the Workflow will not be processed through the assignment loop again." } } + }, + "examples": { + "update": { + "value": { + "AssignmentCallbackUrl": "http://example.com", + "Configuration": "configuration", + "FallbackAssignmentCallbackUrl": "http://example.com", + "FriendlyName": "friendly_name", + "TaskReservationTimeout": 1, + "ReEvaluateTasks": "false" + } + } } } } @@ -6994,6 +9426,9 @@ }, "delete": { "description": "", + "tags": [ + "TaskrouterV1Workflow" + ], "parameters": [ { "name": "WorkspaceSid", @@ -7030,10 +9465,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWorkflow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWorkflow" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows": { @@ -7042,23 +9474,44 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "document_content_type" ], - "pathType": "list", "dependentProperties": { - "workflow_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}", - "workflow_real_time_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}", - "workflow_cumulative_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}" + "statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "workflow_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/Statistics" + }, + "real_time_statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "workflow_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/RealTimeStatistics" + }, + "cumulative_statistics": { + "mapping": { + "workspace_sid": "workspace_sid", + "workflow_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/CumulativeStatistics" + } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Workflow" + ], "parameters": [ { "name": "WorkspaceSid", @@ -7078,6 +9531,20 @@ "description": "The `friendly_name` of the Workflow resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -7123,16 +9590,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7141,18 +9610,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "workflows", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "workflows": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_callback_url": "http://example.com", + "configuration": "task-routing:\\n - filter: \\n - 1 == 1\\n target:\\n - queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\n set-priority: 0\\n", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:47:51Z", + "document_content_type": "application/json", + "fallback_assignment_callback_url": null, + "friendly_name": "Default Fifo Workflow", + "sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_reservation_timeout": 120, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics" + }, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "workflows", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "workflows": [] } } } @@ -7166,13 +9683,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkflow", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkflow" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Workflow" + ], "parameters": [ { "name": "WorkspaceSid", @@ -7193,6 +9710,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_callback_url": "http://example.com", + "configuration": "task-routing:\\n - filter: \\n - 1 == 1\\n target:\\n - queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\n set-priority: 0\\n", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "document_content_type": "application/json", + "fallback_assignment_callback_url": null, + "friendly_name": "Default Fifo Workflow", + "sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_reservation_timeout": 120, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics" + } + } + } } } }, @@ -7205,9 +9745,6 @@ } ], "operationId": "CreateWorkflow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7242,6 +9779,17 @@ "FriendlyName", "Configuration" ] + }, + "examples": { + "create": { + "value": { + "AssignmentCallbackUrl": "http://example.com", + "Configuration": "configuration", + "FallbackAssignmentCallbackUrl": "http://example.com", + "FriendlyName": "friendly_name", + "TaskReservationTimeout": 1 + } + } } } } @@ -7254,7 +9802,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "start_time", @@ -7262,12 +9810,15 @@ "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": "", + "tags": [ + "TaskrouterV1WorkflowCumulativeStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -7300,6 +9851,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -7317,6 +9873,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -7342,6 +9903,65 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow.workflow_cumulative_statistics" + }, + "examples": { + "fetch": { + "value": { + "avg_task_acceptance_time": 100, + "tasks_canceled": 100, + "start_time": "2015-07-30T20:00:00Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_moved": 100, + "tasks_entered": 100, + "wait_duration_until_canceled": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "wait_duration_until_accepted": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "split_by_wait_time": { + "5": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + }, + "10": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + } + }, + "reservations_canceled": 100, + "end_time": "2015-07-30T20:00:00Z", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations_created": 100, + "reservations_accepted": 100, + "reservations_rescinded": 100, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations_rejected": 100, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "tasks_deleted": 100, + "tasks_timed_out_in_workflow": 100, + "tasks_completed": 100, + "reservations_timed_out": 100 + } + } } } }, @@ -7353,10 +9973,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflowCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflowCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics": { @@ -7365,19 +9982,22 @@ "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": "", + "tags": [ + "TaskrouterV1WorkflowRealTimeStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -7409,6 +10029,11 @@ "description": "Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "voice" + } } } ], @@ -7418,6 +10043,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow.workflow_real_time_statistics" + }, + "examples": { + "fetch": { + "value": { + "longest_task_waiting_age": 100, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "tasks_by_priority": {}, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "reserved": 0, + "pending": 0, + "assigned": 0, + "wrapping": 0 + }, + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "total_tasks": 100, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7429,10 +10074,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflowRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflowRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/Statistics": { @@ -7441,17 +10083,20 @@ "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": "", + "tags": [ + "TaskrouterV1WorkflowStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -7483,6 +10128,11 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "schema": { "type": "integer" + }, + "examples": { + "fetch": { + "value": 1 + } } }, { @@ -7492,6 +10142,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -7501,6 +10156,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -7526,6 +10186,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow.workflow_statistics" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "cumulative": { + "avg_task_acceptance_time": 0.0, + "end_time": "2008-01-02T00:00:00Z", + "reservations_accepted": 0, + "reservations_rejected": 0, + "reservations_timed_out": 0, + "start_time": "2008-01-02T00:00:00Z", + "tasks_canceled": 0, + "tasks_entered": 0, + "tasks_moved": 0, + "tasks_timed_out_in_workflow": 0 + }, + "realtime": { + "longest_task_waiting_age": 0, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "assigned": 1, + "pending": 0, + "reserved": 0, + "wrapping": 0 + }, + "total_tasks": 1 + }, + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7537,10 +10230,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflowStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflowStatistics" } }, "/v1/Workspaces/{Sid}": { @@ -7549,29 +10239,82 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "prioritize_queue_order" ], - "pathType": "instance", "dependentProperties": { - "activity": "{workspace_sid: sid}", - "event": "{workspace_sid: sid}", - "task": "{workspace_sid: sid}", - "task_queue": "{workspace_sid: sid}", - "worker": "{workspace_sid: sid}", - "workflow": "{workspace_sid: sid}", - "workspace_statistics": "{workspace_sid: sid}", - "workspace_real_time_statistics": "{workspace_sid: sid}", - "workspace_cumulative_statistics": "{workspace_sid: sid}", - "task_channel": "{workspace_sid: sid}" - } + "activities": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Activities" + }, + "events": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Events" + }, + "tasks": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Tasks" + }, + "task_queues": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues" + }, + "workers": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers" + }, + "workflows": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows" + }, + "statistics": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Statistics" + }, + "real_time_statistics": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/RealTimeStatistics" + }, + "cumulative_statistics": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/CumulativeStatistics" + }, + "task_channels": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskChannels" + } + }, + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Workspace" + ], "parameters": [ { "name": "Sid", @@ -7592,6 +10335,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "default_activity_name": "Offline", + "default_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "event_callback_url": "", + "events_filter": null, + "friendly_name": "new", + "links": { + "activities": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "task_queues": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues", + "tasks": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "workers": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers", + "workflows": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows", + "task_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels", + "events": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events" + }, + "multi_task_enabled": false, + "prioritize_queue_order": "FIFO", + "sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "timeout_activity_name": "Offline", + "timeout_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7603,13 +10379,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspace", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspace" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Workspace" + ], "parameters": [ { "name": "Sid", @@ -7630,6 +10406,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "default_activity_name": "Offline", + "default_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "event_callback_url": "", + "events_filter": null, + "friendly_name": "new", + "links": { + "activities": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "task_queues": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues", + "tasks": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "workers": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers", + "workflows": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows", + "task_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels", + "events": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events" + }, + "multi_task_enabled": false, + "prioritize_queue_order": "FIFO", + "sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "timeout_activity_name": "Offline", + "timeout_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7642,9 +10451,6 @@ } ], "operationId": "UpdateWorkspace", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7689,6 +10495,16 @@ "description": "The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO`. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo)." } } + }, + "examples": { + "update": { + "value": { + "DefaultActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "EventCallbackUrl": "/example", + "FriendlyName": "friendly_name", + "TimeoutActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -7696,6 +10512,9 @@ }, "delete": { "description": "", + "tags": [ + "TaskrouterV1Workspace" + ], "parameters": [ { "name": "Sid", @@ -7720,10 +10539,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWorkspace", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWorkspace" } }, "/v1/Workspaces": { @@ -7732,29 +10548,82 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "prioritize_queue_order" ], - "pathType": "list", "dependentProperties": { - "activity": "{workspace_sid: sid}", - "event": "{workspace_sid: sid}", - "task": "{workspace_sid: sid}", - "task_queue": "{workspace_sid: sid}", - "worker": "{workspace_sid: sid}", - "workflow": "{workspace_sid: sid}", - "workspace_statistics": "{workspace_sid: sid}", - "workspace_real_time_statistics": "{workspace_sid: sid}", - "workspace_cumulative_statistics": "{workspace_sid: sid}", - "task_channel": "{workspace_sid: sid}" - } + "activities": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Activities" + }, + "events": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Events" + }, + "tasks": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Tasks" + }, + "task_queues": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues" + }, + "workers": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers" + }, + "workflows": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows" + }, + "statistics": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/Statistics" + }, + "real_time_statistics": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/RealTimeStatistics" + }, + "cumulative_statistics": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/CumulativeStatistics" + }, + "task_channels": { + "mapping": { + "workspace_sid": "sid" + }, + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskChannels" + } + }, + "pathType": "list" }, "get": { "description": "", + "tags": [ + "TaskrouterV1Workspace" + ], "parameters": [ { "name": "FriendlyName", @@ -7762,6 +10631,20 @@ "description": "The `friendly_name` of the Workspace resources to read. For example `Customer Support` or `2014 Election Campaign`.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -7807,16 +10690,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7825,18 +10710,76 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "workspaces", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "workspaces": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "default_activity_name": "Offline", + "default_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "event_callback_url": "", + "events_filter": null, + "friendly_name": "new", + "links": { + "activities": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "task_queues": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues", + "tasks": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "workers": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers", + "workflows": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows", + "task_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels", + "events": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events" + }, + "multi_task_enabled": false, + "prioritize_queue_order": "FIFO", + "sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "timeout_activity_name": "Offline", + "timeout_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "workspaces", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "workspaces": [] } } } @@ -7850,19 +10793,52 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkspace", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkspace" }, "post": { "description": "", + "tags": [ + "TaskrouterV1Workspace" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "default_activity_name": "Offline", + "default_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "event_callback_url": "", + "events_filter": null, + "friendly_name": "new", + "links": { + "activities": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "task_queues": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues", + "tasks": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "workers": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers", + "workflows": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows", + "task_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels", + "events": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events" + }, + "multi_task_enabled": false, + "prioritize_queue_order": "FIFO", + "sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "timeout_activity_name": "Offline", + "timeout_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7875,9 +10851,6 @@ } ], "operationId": "CreateWorkspace", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7915,6 +10888,15 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "EventCallbackUrl": "/example", + "FriendlyName": "friendly_name", + "Template": "template" + } + } } } } @@ -7927,7 +10909,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "start_time", @@ -7935,12 +10917,15 @@ "avg_task_acceptance_time", "tasks_completed" ], - "pathType": "instance", "parent": "/Workspaces/{Sid}", - "className": "workspace_cumulative_statistics" + "className": "workspace_cumulative_statistics", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TaskrouterV1WorkspaceCumulativeStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -7961,6 +10946,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -7978,6 +10968,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -8003,6 +10998,64 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workspace_cumulative_statistics" + }, + "examples": { + "fetch": { + "value": { + "reservations_accepted": 100, + "tasks_completed": 100, + "start_time": "2015-07-30T20:00:00Z", + "reservations_rescinded": 100, + "tasks_timed_out_in_workflow": 100, + "end_time": "2015-07-30T20:00:00Z", + "avg_task_acceptance_time": 100, + "tasks_canceled": 100, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "tasks_moved": 100, + "tasks_deleted": 100, + "tasks_created": 100, + "reservations_canceled": 100, + "reservations_timed_out": 100, + "wait_duration_until_canceled": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "wait_duration_until_accepted": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "split_by_wait_time": { + "5": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + }, + "10": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + } + }, + "reservations_created": 100, + "reservations_rejected": 100, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8014,10 +11067,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspaceCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspaceCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/RealTimeStatistics": { @@ -8026,19 +11076,22 @@ "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": "", + "tags": [ + "TaskrouterV1WorkspaceRealTimeStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -8058,6 +11111,11 @@ "description": "Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "voice" + } } } ], @@ -8067,6 +11125,43 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workspace_real_time_statistics" + }, + "examples": { + "fetch": { + "value": { + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "tasks_by_priority": {}, + "activity_statistics": [ + { + "friendly_name": "Idle", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Busy", + "workers": 9, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Offline", + "workers": 6, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Reserved", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "longest_task_waiting_age": 100, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "total_workers": 100, + "total_tasks": 100, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": {} + } + } } } }, @@ -8078,10 +11173,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspaceRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspaceRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Statistics": { @@ -8090,17 +11182,20 @@ "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": "", + "tags": [ + "TaskrouterV1WorkspaceStatistics" + ], "parameters": [ { "name": "WorkspaceSid", @@ -8120,6 +11215,11 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "schema": { "type": "integer" + }, + "examples": { + "fetch": { + "value": 1 + } } }, { @@ -8129,6 +11229,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -8138,6 +11243,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -8163,6 +11273,75 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workspace_statistics" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "cumulative": { + "avg_task_acceptance_time": 0.0, + "start_time": "2008-01-02T00:00:00Z", + "reservations_accepted": 0, + "reservations_canceled": 0, + "reservations_created": 0, + "reservations_rejected": 0, + "reservations_rescinded": 0, + "reservations_timed_out": 0, + "end_time": "2008-01-02T00:00:00Z", + "tasks_canceled": 0, + "tasks_created": 0, + "tasks_deleted": 0, + "tasks_moved": 0, + "tasks_timed_out_in_workflow": 0 + }, + "realtime": { + "activity_statistics": [ + { + "friendly_name": "Offline", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 1 + }, + { + "friendly_name": "Idle", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Reserved", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Busy", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "817ca1c5-3a05-11e5-9292-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + } + ], + "longest_task_waiting_age": 0, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "assigned": 0, + "pending": 0, + "reserved": 0, + "wrapping": 0 + }, + "total_tasks": 0, + "total_workers": 1 + }, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8174,10 +11353,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspaceStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspaceStatistics" } } }, @@ -8186,10 +11362,89 @@ "url": "https://taskrouter.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "TaskrouterV1Activity" + }, + { + "name": "TaskrouterV1Event" + }, + { + "name": "TaskrouterV1OperatingUnit" + }, + { + "name": "TaskrouterV1Reservation" + }, + { + "name": "TaskrouterV1Task" + }, + { + "name": "TaskrouterV1TaskChannel" + }, + { + "name": "TaskrouterV1TaskQueue" + }, + { + "name": "TaskrouterV1TaskQueueBulkRealTimeStatistics" + }, + { + "name": "TaskrouterV1TaskQueueCumulativeStatistics" + }, + { + "name": "TaskrouterV1TaskQueueRealTimeStatistics" + }, + { + "name": "TaskrouterV1TaskQueueStatistics" + }, + { + "name": "TaskrouterV1TaskQueuesStatistics" + }, + { + "name": "TaskrouterV1Worker" + }, + { + "name": "TaskrouterV1WorkerChannel" + }, + { + "name": "TaskrouterV1WorkerStatistics" + }, + { + "name": "TaskrouterV1WorkersCumulativeStatistics" + }, + { + "name": "TaskrouterV1WorkersRealTimeStatistics" + }, + { + "name": "TaskrouterV1WorkersStatistics" + }, + { + "name": "TaskrouterV1Workflow" + }, + { + "name": "TaskrouterV1WorkflowCumulativeStatistics" + }, + { + "name": "TaskrouterV1WorkflowRealTimeStatistics" + }, + { + "name": "TaskrouterV1WorkflowStatistics" + }, + { + "name": "TaskrouterV1Workspace" + }, + { + "name": "TaskrouterV1WorkspaceCumulativeStatistics" + }, + { + "name": "TaskrouterV1WorkspaceRealTimeStatistics" + }, + { + "name": "TaskrouterV1WorkspaceStatistics" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_trunking_v1.json b/spec/json/twilio_trunking_v1.json index ac13508f..0d601e43 100644 --- a/spec/json/twilio_trunking_v1.json +++ b/spec/json/twilio_trunking_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "trunking.v1.trunk.credential_list": { "type": "object", @@ -146,7 +152,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema." + "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", @@ -226,7 +238,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "links": { "type": "object", @@ -462,7 +480,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from this URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information." + "description": "The URL we call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from this URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", @@ -557,12 +581,6 @@ "from-transferor" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -578,7 +596,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -595,13 +613,16 @@ "friendly_name", "date_created" ], - "pathType": "instance", "parent": "/Trunks/{Sid}", "mountName": "credentials_lists", - "className": "credential_list" + "className": "credential_list", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TrunkingV1CredentialList" + ], "parameters": [ { "name": "TrunkSid", @@ -634,6 +655,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.credential_list" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-04-28T00:10:23Z", + "date_updated": "2018-04-28T00:10:23Z", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -645,13 +679,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredentialList" }, "delete": { "description": "", + "tags": [ + "TrunkingV1CredentialList" + ], "parameters": [ { "name": "TrunkSid", @@ -688,10 +722,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredentialList" } }, "/v1/Trunks/{TrunkSid}/CredentialLists": { @@ -707,13 +738,16 @@ "friendly_name", "date_created" ], - "pathType": "list", "parent": "/Trunks/{Sid}", "mountName": "credentials_lists", - "className": "credential_list" + "className": "credential_list", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "TrunkingV1CredentialList" + ], "parameters": [ { "name": "TrunkSid", @@ -734,6 +768,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.credential_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-02T17:29:30Z", + "date_updated": "2018-05-02T17:29:30Z", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -746,9 +793,6 @@ } ], "operationId": "CreateCredentialList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -767,6 +811,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -774,6 +825,9 @@ }, "get": { "description": "", + "tags": [ + "TrunkingV1CredentialList" + ], "parameters": [ { "name": "TrunkSid", @@ -830,16 +884,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -848,17 +904,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credential_lists": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-04-27T22:02:11Z", + "date_updated": "2018-04-27T22:02:11Z", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0", + "next_page_url": null, + "key": "credential_lists" + } + } + }, + "readEmpty": { + "value": { + "credential_lists": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0", + "next_page_url": null, + "key": "credential_lists" } } } @@ -873,10 +967,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredentialList" } }, "/v1/Trunks/{TrunkSid}/IpAccessControlLists/{Sid}": { @@ -892,11 +983,14 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TrunkingV1IpAccessControlList" + ], "parameters": [ { "name": "TrunkSid", @@ -929,6 +1023,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.ip_access_control_list" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-02T17:29:34Z", + "date_updated": "2018-05-02T17:29:34Z", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -940,13 +1047,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchIpAccessControlList" }, "delete": { "description": "Remove an associated IP Access Control List from a Trunk", + "tags": [ + "TrunkingV1IpAccessControlList" + ], "parameters": [ { "name": "TrunkSid", @@ -983,10 +1090,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteIpAccessControlList" } }, "/v1/Trunks/{TrunkSid}/IpAccessControlLists": { @@ -1002,11 +1106,14 @@ "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", + "tags": [ + "TrunkingV1IpAccessControlList" + ], "parameters": [ { "name": "TrunkSid", @@ -1027,6 +1134,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.ip_access_control_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-04-30T20:59:06Z", + "date_updated": "2018-04-30T20:59:06Z", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1039,9 +1159,6 @@ } ], "operationId": "CreateIpAccessControlList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1060,6 +1177,13 @@ "required": [ "IpAccessControlListSid" ] + }, + "examples": { + "create": { + "value": { + "IpAccessControlListSid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1067,6 +1191,9 @@ }, "get": { "description": "List all IP Access Control Lists for a Trunk", + "tags": [ + "TrunkingV1IpAccessControlList" + ], "parameters": [ { "name": "TrunkSid", @@ -1123,16 +1250,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1141,17 +1270,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "ip_access_control_lists": [], + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0", + "key": "ip_access_control_lists", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "ip_access_control_lists": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-02T17:29:34Z", + "date_updated": "2018-05-02T17:29:34Z", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0", + "key": "ip_access_control_lists", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0" } } } @@ -1166,10 +1333,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "ListIpAccessControlList" } }, "/v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}": { @@ -1187,11 +1351,14 @@ "priority", "weight" ], - "pathType": "instance", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TrunkingV1OriginationUrl" + ], "parameters": [ { "name": "TrunkSid", @@ -1224,6 +1391,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.origination_url" + }, + "examples": { + "fetch": { + "value": { + "weight": 1, + "date_updated": "2018-05-07T20:20:46Z", + "enabled": false, + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "priority": 1, + "sip_url": "sip://sip-box.com:1234", + "sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-07T20:20:46Z", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1235,13 +1419,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOriginationUrl", - "x-maturity": [ - "GA" - ] + "operationId": "FetchOriginationUrl" }, "delete": { "description": "", + "tags": [ + "TrunkingV1OriginationUrl" + ], "parameters": [ { "name": "TrunkSid", @@ -1278,13 +1462,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteOriginationUrl", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteOriginationUrl" }, "post": { "description": "", + "tags": [ + "TrunkingV1OriginationUrl" + ], "parameters": [ { "name": "TrunkSid", @@ -1317,6 +1501,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.origination_url" + }, + "examples": { + "update": { + "value": { + "weight": 2, + "date_updated": "2018-05-07T20:50:58Z", + "enabled": false, + "friendly_name": "updated_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "priority": 2, + "sip_url": "sip://sip-updated.com:4321", + "sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-07T20:50:58Z", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1329,9 +1530,6 @@ } ], "operationId": "UpdateOriginationUrl", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1361,6 +1559,17 @@ "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. `sips` is NOT supported." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "updated_name", + "Weight": 2, + "Priority": 2, + "SipUrl": "sip://sip-updated.com:4321", + "Enabled": false + } + } } } } @@ -1382,11 +1591,14 @@ "priority", "weight" ], - "pathType": "list", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "TrunkingV1OriginationUrl" + ], "parameters": [ { "name": "TrunkSid", @@ -1407,6 +1619,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.origination_url" + }, + "examples": { + "create": { + "value": { + "weight": 1, + "date_updated": "2018-05-07T20:50:58Z", + "enabled": true, + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "priority": 1, + "sip_url": "sip://sip-box.com:1234", + "sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-07T20:50:58Z", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1419,9 +1648,6 @@ } ], "operationId": "CreateOriginationUrl", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1458,6 +1684,17 @@ "FriendlyName", "SipUrl" ] + }, + "examples": { + "create": { + "value": { + "Enabled": true, + "FriendlyName": "friendly_name", + "Priority": 1, + "Weight": 1, + "SipUrl": "sip://sip-box.com:1234" + } + } } } } @@ -1465,6 +1702,9 @@ }, "get": { "description": "", + "tags": [ + "TrunkingV1OriginationUrl" + ], "parameters": [ { "name": "TrunkSid", @@ -1521,16 +1761,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1539,18 +1781,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0", + "key": "origination_urls", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0" + }, + "origination_urls": [ + { + "weight": 1, + "date_updated": "2018-05-09T20:47:35Z", + "enabled": true, + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "priority": 1, + "sip_url": "sip://sip-box.com:1234", + "sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-09T20:47:35Z", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0", + "key": "origination_urls", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0" + }, + "origination_urls": [] } } } @@ -1564,10 +1848,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListOriginationUrl", - "x-maturity": [ - "GA" - ] + "operationId": "ListOriginationUrl" } }, "/v1/Trunks/{TrunkSid}/PhoneNumbers/{Sid}": { @@ -1583,11 +1864,14 @@ "friendly_name", "phone_number" ], - "pathType": "instance", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TrunkingV1PhoneNumber" + ], "parameters": [ { "name": "TrunkSid", @@ -1620,6 +1904,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.phone_number" + }, + "examples": { + "fetch": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-12-10T17:27:34Z", + "date_updated": "2015-10-09T11:36:32Z", + "friendly_name": "(415) 867-5309", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+14158675309", + "api_version": "2010-04-01", + "voice_caller_id_lookup": null, + "voice_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call", + "voice_method": "POST", + "voice_fallback_url": null, + "voice_fallback_method": null, + "status_callback": "", + "status_callback_method": "POST", + "voice_application_sid": "", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message", + "sms_method": "POST", + "sms_fallback_url": "", + "sms_fallback_method": "POST", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "beta": false, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "capabilities": { + "voice": true, + "sms": true, + "mms": true + }, + "links": { + "phone_number": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + } } } }, @@ -1631,13 +1953,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumber" }, "delete": { "description": "", + "tags": [ + "TrunkingV1PhoneNumber" + ], "parameters": [ { "name": "TrunkSid", @@ -1674,10 +1996,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "DeletePhoneNumber" } }, "/v1/Trunks/{TrunkSid}/PhoneNumbers": { @@ -1693,11 +2012,14 @@ "friendly_name", "phone_number" ], - "pathType": "list", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "TrunkingV1PhoneNumber" + ], "parameters": [ { "name": "TrunkSid", @@ -1718,6 +2040,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.phone_number" + }, + "examples": { + "create": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-12-10T17:27:34Z", + "date_updated": "2015-10-09T11:36:32Z", + "friendly_name": "(415) 867-5309", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+14158675309", + "api_version": "2010-04-01", + "voice_caller_id_lookup": null, + "voice_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call", + "voice_method": "POST", + "voice_fallback_url": null, + "voice_fallback_method": null, + "status_callback": "", + "status_callback_method": "POST", + "voice_application_sid": "", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message", + "sms_method": "POST", + "sms_fallback_url": "", + "sms_fallback_method": "POST", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "beta": false, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "capabilities": { + "voice": true, + "sms": true, + "mms": true + }, + "links": { + "phone_number": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + } } } }, @@ -1730,9 +2090,6 @@ } ], "operationId": "CreatePhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1751,6 +2108,13 @@ "required": [ "PhoneNumberSid" ] + }, + "examples": { + "create": { + "value": { + "PhoneNumberSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1758,6 +2122,9 @@ }, "get": { "description": "", + "tags": [ + "TrunkingV1PhoneNumber" + ], "parameters": [ { "name": "TrunkSid", @@ -1814,16 +2181,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1832,18 +2201,81 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0", + "key": "phone_numbers", + "next_page_url": null, + "page": 0, + "page_size": 1, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0" + }, + "phone_numbers": [ + { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-12-10T17:27:34Z", + "date_updated": "2015-10-09T11:36:32Z", + "friendly_name": "(415) 867-5309", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+14158675309", + "api_version": "2010-04-01", + "voice_caller_id_lookup": null, + "voice_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call", + "voice_method": "POST", + "voice_fallback_url": null, + "voice_fallback_method": null, + "status_callback": "", + "status_callback_method": "POST", + "voice_application_sid": "", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message", + "sms_method": "POST", + "sms_fallback_url": "", + "sms_fallback_method": "POST", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "beta": false, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "capabilities": { + "voice": true, + "sms": true, + "mms": true + }, + "links": { + "phone_number": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0", + "key": "phone_numbers", + "next_page_url": null, + "page": 0, + "page_size": 1, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0" + }, + "phone_numbers": [] } } } @@ -1857,10 +2289,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "ListPhoneNumber" } }, "/v1/Trunks/{TrunkSid}/Recording": { @@ -1875,12 +2304,15 @@ "mode", "trim" ], - "pathType": "instance", "parent": "/Trunks/{Sid}", - "mountName": "recordings" + "mountName": "recordings", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TrunkingV1Recording" + ], "parameters": [ { "name": "TrunkSid", @@ -1901,6 +2333,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.recording" + }, + "examples": { + "fetch": { + "value": { + "mode": "do-not-record", + "trim": "do-not-trim" + } + } } } }, @@ -1912,13 +2352,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecording" }, "post": { "description": "", + "tags": [ + "TrunkingV1Recording" + ], "parameters": [ { "name": "TrunkSid", @@ -1939,6 +2379,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.recording" + }, + "examples": { + "update": { + "value": { + "mode": "do-not-record", + "trim": "do-not-trim" + } + } } } }, @@ -1951,9 +2399,6 @@ } ], "operationId": "UpdateRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1972,6 +2417,14 @@ "description": "The recording trim setting for the trunk. Can be do-not-trim (default) or trim-silence." } } + }, + "examples": { + "update": { + "value": { + "Mode": "do-not-record", + "Trim": "do-not-trim" + } + } } } } @@ -1991,17 +2444,45 @@ "friendly_name", "domain_name" ], - "pathType": "instance", "dependentProperties": { - "origination_url": "{trunk_sid: sid}", - "credential_list": "{trunk_sid: sid}", - "ip_access_control_list": "{trunk_sid: sid}", - "phone_number": "{trunk_sid: sid}", - "recording": "{trunk_sid: sid}" - } + "origination_urls": { + "mapping": { + "trunk_sid": "sid" + }, + "resource_url": "/v1/Trunks/{trunk_sid}/OriginationUrls" + }, + "credentials_lists": { + "mapping": { + "trunk_sid": "sid" + }, + "resource_url": "/v1/Trunks/{trunk_sid}/CredentialLists" + }, + "ip_access_control_lists": { + "mapping": { + "trunk_sid": "sid" + }, + "resource_url": "/v1/Trunks/{trunk_sid}/IpAccessControlLists" + }, + "phone_numbers": { + "mapping": { + "trunk_sid": "sid" + }, + "resource_url": "/v1/Trunks/{trunk_sid}/PhoneNumbers" + }, + "recordings": { + "mapping": { + "trunk_sid": "sid" + }, + "resource_url": "/v1/Trunks/{trunk_sid}/Recording" + } + }, + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "TrunkingV1Trunk" + ], "parameters": [ { "name": "Sid", @@ -2022,6 +2503,37 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk" + }, + "examples": { + "fetch": { + "value": { + "sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "test.pstn.twilio.com", + "disaster_recovery_method": "POST", + "disaster_recovery_url": "http://disaster-recovery.com", + "friendly_name": "friendly_name", + "secure": false, + "cnam_lookup_enabled": false, + "recording": { + "mode": "do-not-record", + "trim": "do-not-trim" + }, + "transfer_mode": "disable-all", + "transfer_caller_id": "from-transferor", + "auth_type": "", + "auth_type_set": [], + "date_created": "2015-01-02T11:23:45Z", + "date_updated": "2015-01-02T11:23:45Z", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "origination_urls": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls", + "credential_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists", + "ip_access_control_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists", + "phone_numbers": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers" + } + } + } } } }, @@ -2033,13 +2545,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunk" }, "delete": { "description": "", + "tags": [ + "TrunkingV1Trunk" + ], "parameters": [ { "name": "Sid", @@ -2064,13 +2576,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrunk" }, "post": { "description": "", + "tags": [ + "TrunkingV1Trunk" + ], "parameters": [ { "name": "Sid", @@ -2091,6 +2603,37 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk" + }, + "examples": { + "update": { + "value": { + "sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "test.pstn.twilio.com", + "disaster_recovery_method": "GET", + "disaster_recovery_url": "http://updated-recovery.com", + "friendly_name": "updated_name", + "secure": true, + "cnam_lookup_enabled": true, + "recording": { + "mode": "do-not-record", + "trim": "do-not-trim" + }, + "transfer_mode": "disable-all", + "transfer_caller_id": "from-transferor", + "auth_type": "", + "auth_type_set": [], + "date_created": "2015-01-02T11:23:45Z", + "date_updated": "2015-01-02T11:23:45Z", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "origination_urls": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls", + "credential_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists", + "ip_access_control_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists", + "phone_numbers": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers" + } + } + } } } }, @@ -2103,9 +2646,6 @@ } ], "operationId": "UpdateTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2158,6 +2698,19 @@ "description": "Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "updated_name", + "DisasterRecoveryMethod": "GET", + "DisasterRecoveryUrl": "http://updated-recovery.com", + "Secure": true, + "TransferMode": "disable-all", + "TransferCallerId": "from-transferor", + "CnamLookupEnabled": true + } + } } } } @@ -2177,23 +2730,82 @@ "friendly_name", "domain_name" ], - "pathType": "list", "dependentProperties": { - "origination_url": "{trunk_sid: sid}", - "credential_list": "{trunk_sid: sid}", - "ip_access_control_list": "{trunk_sid: sid}", - "phone_number": "{trunk_sid: sid}", - "recording": "{trunk_sid: sid}" - } + "origination_urls": { + "mapping": { + "trunk_sid": "sid" + }, + "resource_url": "/v1/Trunks/{trunk_sid}/OriginationUrls" + }, + "credentials_lists": { + "mapping": { + "trunk_sid": "sid" + }, + "resource_url": "/v1/Trunks/{trunk_sid}/CredentialLists" + }, + "ip_access_control_lists": { + "mapping": { + "trunk_sid": "sid" + }, + "resource_url": "/v1/Trunks/{trunk_sid}/IpAccessControlLists" + }, + "phone_numbers": { + "mapping": { + "trunk_sid": "sid" + }, + "resource_url": "/v1/Trunks/{trunk_sid}/PhoneNumbers" + }, + "recordings": { + "mapping": { + "trunk_sid": "sid" + }, + "resource_url": "/v1/Trunks/{trunk_sid}/Recording" + } + }, + "pathType": "list" }, "post": { "description": "", + "tags": [ + "TrunkingV1Trunk" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk" + }, + "examples": { + "create": { + "value": { + "sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "test.pstn.twilio.com", + "disaster_recovery_method": "POST", + "disaster_recovery_url": "http://disaster-recovery.com", + "friendly_name": "friendly_name", + "secure": false, + "cnam_lookup_enabled": false, + "recording": { + "mode": "do-not-record", + "trim": "do-not-trim" + }, + "transfer_mode": "disable-all", + "transfer_caller_id": "from-transferee", + "auth_type": "", + "auth_type_set": [], + "date_created": "2015-01-02T11:23:45Z", + "date_updated": "2015-01-02T11:23:45Z", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "origination_urls": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls", + "credential_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists", + "ip_access_control_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists", + "phone_numbers": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers" + } + } + } } } }, @@ -2206,9 +2818,6 @@ } ], "operationId": "CreateTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2261,6 +2870,20 @@ "description": "Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`." } } + }, + "examples": { + "create": { + "value": { + "DomainName": "test.pstn.twilio.com", + "FriendlyName": "friendly_name", + "DisasterRecoveryMethod": "GET", + "DisasterRecoveryUrl": "http://disaster-recovery.com", + "TransferMode": "disable-all", + "TransferCallerId": "from-transferee", + "Secure": false, + "CnamLookupEnabled": false + } + } } } } @@ -2268,6 +2891,9 @@ }, "get": { "description": "", + "tags": [ + "TrunkingV1Trunk" + ], "parameters": [ { "name": "PageSize", @@ -2312,16 +2938,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2330,18 +2958,74 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0", + "url": "https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0", + "page_size": 50, + "key": "trunks", + "next_page_url": null, + "page": 0, + "previous_page_url": null + }, + "trunks": [ + { + "sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "test.pstn.twilio.com", + "disaster_recovery_method": "POST", + "disaster_recovery_url": "http://disaster-recovery.com", + "friendly_name": "friendly_name", + "secure": false, + "cnam_lookup_enabled": false, + "recording": { + "mode": "do-not-record", + "trim": "do-not-trim" + }, + "transfer_mode": "disable-all", + "transfer_caller_id": "from-transferee", + "auth_type": "", + "auth_type_set": [], + "date_created": "2015-01-02T11:23:45Z", + "date_updated": "2015-01-02T11:23:45Z", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "origination_urls": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls", + "credential_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists", + "ip_access_control_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists", + "phone_numbers": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0", + "url": "https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0", + "page_size": 50, + "key": "trunks", + "next_page_url": null, + "page": 0, + "previous_page_url": null + }, + "trunks": [] } } } @@ -2355,10 +3039,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrunk" } } }, @@ -2367,10 +3048,29 @@ "url": "https://trunking.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "TrunkingV1CredentialList" + }, + { + "name": "TrunkingV1IpAccessControlList" + }, + { + "name": "TrunkingV1OriginationUrl" + }, + { + "name": "TrunkingV1PhoneNumber" + }, + { + "name": "TrunkingV1Recording" + }, + { + "name": "TrunkingV1Trunk" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_trusthub_v1.json b/spec/json/twilio_trusthub_v1.json index 1499a819..2a26493d 100644 --- a/spec/json/twilio_trusthub_v1.json +++ b/spec/json/twilio_trusthub_v1.json @@ -1,6 +1,143 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { + "trusthub.v1.compliance_inquiry": { + "type": "object", + "properties": { + "inquiry_id": { + "type": "string", + "nullable": true, + "description": "The unique ID used to start an embedded compliance registration session." + }, + "inquiry_session_token": { + "type": "string", + "nullable": true, + "description": "The session token used to start an embedded compliance registration session." + }, + "customer_id": { + "type": "string", + "nullable": true, + "description": "The CustomerID matching the Customer Profile that should be resumed or resubmitted for editing." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this resource." + } + } + }, + "trusthub.v1.compliance_registration": { + "type": "object", + "properties": { + "inquiry_id": { + "type": "string", + "nullable": true, + "description": "The unique ID used to start an embedded compliance registration session." + }, + "inquiry_session_token": { + "type": "string", + "nullable": true, + "description": "The session token used to start an embedded compliance registration session." + }, + "registration_id": { + "type": "string", + "nullable": true, + "description": "The RegistrationId matching the Registration Profile that should be resumed or resubmitted for editing." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this resource." + } + } + }, + "compliance_registration_enum_end_user_type": { + "type": "string", + "enum": [ + "Individual", + "Business" + ] + }, + "compliance_registration_enum_phone_number_type": { + "type": "string", + "enum": [ + "local", + "national", + "mobile", + "toll-free" + ] + }, + "compliance_registration_enum_business_identity_type": { + "type": "string", + "enum": [ + "direct_customer", + "isv_reseller_or_partner", + "unknown" + ] + }, + "compliance_registration_enum_business_registration_authority": { + "type": "string", + "enum": [ + "UK:CRN", + "US:EIN", + "CA:CBN", + "AU:ACN", + "Other" + ] + }, + "trusthub.v1.compliance_tollfree_inquiry": { + "type": "object", + "properties": { + "inquiry_id": { + "type": "string", + "nullable": true, + "description": "The unique ID used to start an embedded compliance registration session." + }, + "inquiry_session_token": { + "type": "string", + "nullable": true, + "description": "The session token used to start an embedded compliance registration session." + }, + "registration_id": { + "type": "string", + "nullable": true, + "description": "The TolfreeId matching the Tollfree Profile that should be resumed or resubmitted for editing." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this resource." + } + } + }, + "compliance_tollfree_inquiry_enum_status": { + "type": "string", + "enum": [ + "PENDING_REVIEW", + "IN_REVIEW", + "TWILIO_APPROVED", + "TWILIO_REJECTED" + ] + }, + "compliance_tollfree_inquiry_enum_opt_in_type": { + "type": "string", + "enum": [ + "VERBAL", + "WEB_FORM", + "PAPER_FORM", + "VIA_TEXT", + "MOBILE_QR_CODE" + ] + }, "trusthub.v1.customer_profile": { "type": "object", "properties": { @@ -299,7 +436,13 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types." + "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -433,7 +576,13 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types." + "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -768,12 +917,6 @@ "noncompliant" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -789,39 +932,56 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { - "/v1/CustomerProfiles": { + "/v1/ComplianceInquiries/Customers/Initialize": { "servers": [ { "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid", - "policy_sid", - "friendly_name" + "inquiry_id", + "session_token", + "customer_id" ], - "pathType": "list", - "dependentProperties": { - "customer_profiles_entity_assignments": "{customer_profile_sid: sid}", - "customer_profiles_evaluations": "{customer_profile_sid: sid}", - "customer_profiles_channel_endpoint_assignment": "{customer_profile_sid: sid}" - }, - "className": "customer_profiles" + "mountName": "compliance_inquiries", + "className": "compliance_inquiries", + "pathType": "list" }, "post": { - "description": "Create a new Customer-Profile.", + "description": "Create a new Compliance Inquiry for the authenticated account. This is necessary to start a new embedded session.", + "tags": [ + "TrusthubV1ComplianceInquiries" + ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/trusthub.v1.customer_profile" + "$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" + } + } } } }, @@ -833,105 +993,79 @@ "accountSid_authToken": [] } ], - "operationId": "CreateCustomerProfile", - "x-maturity": [ - "GA" - ], + "operationId": "CreateComplianceInquiry", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateCustomerProfileRequest", + "title": "CreateComplianceInquiryRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "The string that you assigned to describe the resource." - }, - "Email": { - "type": "string", - "description": "The email address that will receive updates when the Customer-Profile resource changes status." - }, - "PolicySid": { + "PrimaryProfileSid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^RN[0-9a-fA-F]{32}$", - "description": "The unique string of a policy that is associated to the Customer-Profile resource." + "pattern": "^BU[0-9a-fA-F]{32}$", + "description": "The unique SID identifier of the Primary Customer Profile that should be used as a parent. Only necessary when creating a secondary Customer Profile." }, - "StatusCallback": { + "NotificationEmail": { "type": "string", - "format": "uri", - "description": "The URL we call to inform your application of status changes." + "description": "The email address that approval status updates will be sent to. If not specified, the email address associated with your primary customer profile will be used." } }, "required": [ - "FriendlyName", - "Email", - "PolicySid" + "PrimaryProfileSid" ] + }, + "examples": { + "create": { + "value": { + "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithNotificationEmail": { + "value": { + "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "NotificationEmail": "pfarnsworth@twilio.com" + } + } } } } } + } + }, + "/v1/ComplianceInquiries/Customers/{CustomerId}/Initialize": { + "servers": [ + { + "url": "https://trusthub.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "inquiry_id", + "session_token", + "customer_id" + ], + "mountName": "compliance_inquiries", + "className": "compliance_inquiries", + "pathType": "instance" }, - "get": { - "description": "Retrieve a list of all Customer-Profiles for an account.", + "post": { + "description": "Resume a specific Compliance Inquiry that has expired, or re-open a rejected Compliance Inquiry for editing.", + "tags": [ + "TrusthubV1ComplianceInquiries" + ], "parameters": [ { - "name": "Status", - "in": "query", - "description": "The verification status of the Customer-Profile resource.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/customer_profile_enum_status" - } - }, - { - "name": "FriendlyName", - "in": "query", - "description": "The string that you assigned to describe the resource.", - "schema": { - "type": "string" - } - }, - { - "name": "PolicySid", - "in": "query", - "description": "The unique string of a policy that is associated to the Customer-Profile resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RN[0-9a-fA-F]{32}$" - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", + "name": "CustomerId", + "in": "path", + "description": "The unique CustomerId matching the Customer Profile/Compliance Inquiry that should be resumed or resubmitted. This value will have been returned by the initial Compliance Inquiry creation call.", "schema": { "type": "string" - } + }, + "required": true } ], "responses": { @@ -939,46 +1073,15 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListCustomerProfileResponse", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/trusthub.v1.customer_profile" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } + "$ref": "#/components/schemas/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" } } } @@ -992,35 +1095,871 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfile", - "x-maturity": [ - "GA" - ] + "operationId": "UpdateComplianceInquiry", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateComplianceInquiryRequest", + "properties": { + "PrimaryProfileSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$", + "description": "The unique SID identifier of the Primary Customer Profile that should be used as a parent. Only necessary when creating a secondary Customer Profile." + } + }, + "required": [ + "PrimaryProfileSid" + ] + }, + "examples": { + "update": { + "value": { + "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + } } }, - "/v1/CustomerProfiles/{Sid}": { + "/v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize": { "servers": [ { "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid", - "policy_sid", - "friendly_name" + "inquiry_id", + "session_token", + "registration_id" ], - "pathType": "instance", - "dependentProperties": { - "customer_profiles_entity_assignments": "{customer_profile_sid: sid}", - "customer_profiles_evaluations": "{customer_profile_sid: sid}", - "customer_profiles_channel_endpoint_assignment": "{customer_profile_sid: sid}" - }, - "className": "customer_profiles" + "mountName": "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.", + "tags": [ + "TrusthubV1ComplianceRegistrationInquiries" + ], + "responses": { + "201": { + "content": { + "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.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registartion.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateComplianceRegistration", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateComplianceRegistrationRequest", + "properties": { + "EndUserType": { + "type": "string", + "$ref": "#/components/schemas/compliance_registration_enum_end_user_type", + "description": "The type of End User the regulation requires - can be `Individual` or `Business`." + }, + "PhoneNumberType": { + "type": "string", + "$ref": "#/components/schemas/compliance_registration_enum_phone_number_type", + "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`." + }, + "BusinessIdentityType": { + "type": "string", + "$ref": "#/components/schemas/compliance_registration_enum_business_identity_type", + "description": "The type of business identity. Can be `direct customer` or `ISV`." + }, + "BusinessRegistrationAuthority": { + "type": "string", + "$ref": "#/components/schemas/compliance_registration_enum_business_registration_authority", + "description": "The authority that registered the business" + }, + "BusinessLegalName": { + "type": "string", + "description": "he name of the business or organization using the Tollfree number." + }, + "NotificationEmail": { + "type": "string", + "description": "he email address to receive the notification about the verification result." + }, + "AcceptedNotificationReceipt": { + "type": "boolean", + "description": "The email address to receive the notification about the verification result." + }, + "BusinessRegistrationNumber": { + "type": "string", + "description": "Business registration number of the business" + }, + "BusinessWebsiteUrl": { + "type": "string", + "description": "The URL of the business website" + }, + "FriendlyName": { + "type": "string", + "description": "Friendly name for your business information" + }, + "AuthorizedRepresentative1FirstName": { + "type": "string", + "description": "First name of the authorized representative" + }, + "AuthorizedRepresentative1LastName": { + "type": "string", + "description": "Last name of the authorized representative" + }, + "AuthorizedRepresentative1Phone": { + "type": "string", + "description": "Phone number of the authorized representative" + }, + "AuthorizedRepresentative1Email": { + "type": "string", + "description": "Email address of the authorized representative" + }, + "AuthorizedRepresentative1DateOfBirth": { + "type": "string", + "description": "Birthdate of the authorized representative" + }, + "AddressStreet": { + "type": "string", + "description": "Street address of the business" + }, + "AddressStreetSecondary": { + "type": "string", + "description": "Street address of the business" + }, + "AddressCity": { + "type": "string", + "description": "City of the business" + }, + "AddressSubdivision": { + "type": "string", + "description": "State or province of the business" + }, + "AddressPostalCode": { + "type": "string", + "description": "Postal code of the business" + }, + "AddressCountryCode": { + "type": "string", + "description": "Country code of the business" + }, + "EmergencyAddressStreet": { + "type": "string", + "description": "Street address of the business" + }, + "EmergencyAddressStreetSecondary": { + "type": "string", + "description": "Street address of the business" + }, + "EmergencyAddressCity": { + "type": "string", + "description": "City of the business" + }, + "EmergencyAddressSubdivision": { + "type": "string", + "description": "State or province of the business" + }, + "EmergencyAddressPostalCode": { + "type": "string", + "description": "Postal code of the business" + }, + "EmergencyAddressCountryCode": { + "type": "string", + "description": "Country code of the business" + }, + "UseAddressAsEmergencyAddress": { + "type": "boolean", + "description": "Use the business address as the emergency address" + }, + "FileName": { + "type": "string", + "description": "The name of the verification document to upload" + }, + "File": { + "type": "string", + "description": "The verification document to upload" + }, + "FirstName": { + "type": "string", + "description": "The first name of the Individual User." + }, + "LastName": { + "type": "string", + "description": "The last name of the Individual User." + }, + "DateOfBirth": { + "type": "string", + "description": "The date of birth of the Individual User." + }, + "IndividualEmail": { + "type": "string", + "description": "The email address of the Individual User." + }, + "IndividualPhone": { + "type": "string", + "description": "The phone number of the Individual User." + }, + "IsIsvEmbed": { + "type": "boolean", + "description": "Indicates if the inquiry is being started from an ISV embedded component." + }, + "IsvRegisteringForSelfOrTenant": { + "type": "string", + "description": "Indicates if the isv registering for self or tenant." + }, + "StatusCallbackUrl": { + "type": "string", + "description": "The url we call to inform you of bundle changes." + } + }, + "required": [ + "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" + } + } + } + } + } + } + } + }, + "/v1/ComplianceInquiries/Tollfree/Initialize": { + "servers": [ + { + "url": "https://trusthub.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "inquiry_id", + "session_token", + "registration_id" + ], + "mountName": "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.", + "tags": [ + "TrusthubV1ComplianceTollfreeInquiries" + ], + "responses": { + "201": { + "content": { + "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" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateComplianceTollfreeInquiry", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateComplianceTollfreeInquiryRequest", + "properties": { + "TollfreePhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The Tollfree phone number to be verified" + }, + "NotificationEmail": { + "type": "string", + "description": "The email address to receive the notification about the verification result." + }, + "BusinessName": { + "type": "string", + "description": "The name of the business or organization using the Tollfree number." + }, + "BusinessWebsite": { + "type": "string", + "description": "The website of the business or organization using the Tollfree number." + }, + "UseCaseCategories": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The category of the use case for the Tollfree Number. List as many are applicable.." + }, + "UseCaseSummary": { + "type": "string", + "description": "Use this to further explain how messaging is used by the business or organization." + }, + "ProductionMessageSample": { + "type": "string", + "description": "An example of message content, i.e. a sample message." + }, + "OptInImageUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL." + }, + "OptInType": { + "type": "string", + "$ref": "#/components/schemas/compliance_tollfree_inquiry_enum_opt_in_type", + "description": "Describe how a user opts-in to text messages." + }, + "MessageVolume": { + "type": "string", + "description": "Estimate monthly volume of messages from the Tollfree Number." + }, + "BusinessStreetAddress": { + "type": "string", + "description": "The address of the business or organization using the Tollfree number." + }, + "BusinessStreetAddress2": { + "type": "string", + "description": "The address of the business or organization using the Tollfree number." + }, + "BusinessCity": { + "type": "string", + "description": "The city of the business or organization using the Tollfree number." + }, + "BusinessStateProvinceRegion": { + "type": "string", + "description": "The state/province/region of the business or organization using the Tollfree number." + }, + "BusinessPostalCode": { + "type": "string", + "description": "The postal code of the business or organization using the Tollfree number." + }, + "BusinessCountry": { + "type": "string", + "description": "The country of the business or organization using the Tollfree number." + }, + "AdditionalInformation": { + "type": "string", + "description": "Additional information to be provided for verification." + }, + "BusinessContactFirstName": { + "type": "string", + "description": "The first name of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactLastName": { + "type": "string", + "description": "The last name of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactEmail": { + "type": "string", + "description": "The email address of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactPhone": { + "type": "string", + "format": "phone-number", + "description": "The phone number of the contact for the business or organization using the Tollfree number." + } + }, + "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" + } + } + } + } + } + } + } + }, + "/v1/CustomerProfiles": { + "servers": [ + { + "url": "https://trusthub.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "policy_sid", + "friendly_name" + ], + "dependentProperties": { + "customer_profiles_entity_assignments": { + "mapping": { + "customer_profile_sid": "sid" + }, + "resource_url": "/v1/CustomerProfiles/{customer_profile_sid}/EntityAssignments" + }, + "customer_profiles_evaluations": { + "mapping": { + "customer_profile_sid": "sid" + }, + "resource_url": "/v1/CustomerProfiles/{customer_profile_sid}/Evaluations" + }, + "customer_profiles_channel_endpoint_assignment": { + "mapping": { + "customer_profile_sid": "sid" + }, + "resource_url": "/v1/CustomerProfiles/{customer_profile_sid}/ChannelEndpointAssignments" + } + }, + "className": "customer_profiles", + "pathType": "list" + }, + "post": { + "description": "Create a new Customer-Profile.", + "tags": [ + "TrusthubV1CustomerProfiles" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/trusthub.v1.customer_profile" + }, + "examples": { + "create": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateCustomerProfile", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateCustomerProfileRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "The string that you assigned to describe the resource." + }, + "Email": { + "type": "string", + "description": "The email address that will receive updates when the Customer-Profile resource changes status." + }, + "PolicySid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RN[0-9a-fA-F]{32}$", + "description": "The unique string of a policy that is associated to the Customer-Profile resource." + }, + "StatusCallback": { + "type": "string", + "format": "uri", + "description": "The URL we call to inform your application of status changes." + } + }, + "required": [ + "FriendlyName", + "Email", + "PolicySid" + ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Email": "email", + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "StatusCallback": "http://www.example.com" + } + } + } + } + } + } + }, + "get": { + "description": "Retrieve a list of all Customer-Profiles for an account.", + "tags": [ + "TrusthubV1CustomerProfiles" + ], + "parameters": [ + { + "name": "Status", + "in": "query", + "description": "The verification status of the Customer-Profile resource.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/customer_profile_enum_status" + }, + "examples": { + "readFull": { + "value": "draft" + } + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "The string that you assigned to describe the resource.", + "schema": { + "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + } + } + }, + { + "name": "PolicySid", + "in": "query", + "description": "The unique string of a policy that is associated to the Customer-Profile resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RN[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 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": "ListCustomerProfileResponse", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/trusthub.v1.customer_profile" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://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" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListCustomerProfile" + } + }, + "/v1/CustomerProfiles/{Sid}": { + "servers": [ + { + "url": "https://trusthub.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "policy_sid", + "friendly_name" + ], + "dependentProperties": { + "customer_profiles_entity_assignments": { + "mapping": { + "customer_profile_sid": "sid" + }, + "resource_url": "/v1/CustomerProfiles/{customer_profile_sid}/EntityAssignments" + }, + "customer_profiles_evaluations": { + "mapping": { + "customer_profile_sid": "sid" + }, + "resource_url": "/v1/CustomerProfiles/{customer_profile_sid}/Evaluations" + }, + "customer_profiles_channel_endpoint_assignment": { + "mapping": { + "customer_profile_sid": "sid" + }, + "resource_url": "/v1/CustomerProfiles/{customer_profile_sid}/ChannelEndpointAssignments" + } + }, + "className": "customer_profiles", + "pathType": "instance" }, "get": { "description": "Fetch a specific Customer-Profile instance.", + "tags": [ + "TrusthubV1CustomerProfiles" + ], "parameters": [ { "name": "Sid", @@ -1041,6 +1980,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile" + }, + "examples": { + "fetch": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "valid_until": null, + "email": "email", + "status_callback": "http://www.example.com", + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } } } }, @@ -1052,13 +2013,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfile", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfile" }, "post": { "description": "Updates a Customer-Profile in an account.", + "tags": [ + "TrusthubV1CustomerProfiles" + ], "parameters": [ { "name": "Sid", @@ -1079,6 +2040,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile" + }, + "examples": { + "update": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + }, + "updateToInReview": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "in-review", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } } } }, @@ -1091,9 +2094,6 @@ } ], "operationId": "UpdateCustomerProfile", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1120,6 +2120,21 @@ "description": "The email address that will receive updates when the Customer-Profile resource changes status." } } + }, + "examples": { + "update": { + "value": { + "Status": "draft", + "StatusCallback": "http://www.example.com", + "FriendlyName": "friendly_name", + "Email": "email" + } + }, + "updateToInReview": { + "value": { + "Status": "pending-review" + } + } } } } @@ -1127,6 +2142,9 @@ }, "delete": { "description": "Delete a specific Customer-Profile.", + "tags": [ + "TrusthubV1CustomerProfiles" + ], "parameters": [ { "name": "Sid", @@ -1151,10 +2169,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCustomerProfile", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCustomerProfile" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments": { @@ -1163,17 +2178,20 @@ "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.", + "tags": [ + "TrusthubV1CustomerProfilesChannelEndpointAssignment" + ], "parameters": [ { "name": "CustomerProfileSid", @@ -1194,6 +2212,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment" + }, + "examples": { + "create": { + "value": { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1206,9 +2237,6 @@ } ], "operationId": "CreateCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1232,6 +2260,14 @@ "ChannelEndpointType", "ChannelEndpointSid" ] + }, + "examples": { + "create": { + "value": { + "ChannelEndpointSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChannelEndpointType": "phone-number" + } + } } } } @@ -1239,6 +2275,9 @@ }, "get": { "description": "Retrieve a list of all Assigned Items for an account.", + "tags": [ + "TrusthubV1CustomerProfilesChannelEndpointAssignment" + ], "parameters": [ { "name": "CustomerProfileSid", @@ -1261,6 +2300,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1314,16 +2358,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1332,17 +2378,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -1357,10 +2441,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListCustomerProfileChannelEndpointAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid}": { @@ -1369,17 +2450,20 @@ "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.", + "tags": [ + "TrusthubV1CustomerProfilesChannelEndpointAssignment" + ], "parameters": [ { "name": "CustomerProfileSid", @@ -1412,6 +2496,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment" + }, + "examples": { + "fetch": { + "value": { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1423,13 +2520,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfileChannelEndpointAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", + "tags": [ + "TrusthubV1CustomerProfilesChannelEndpointAssignment" + ], "parameters": [ { "name": "CustomerProfileSid", @@ -1466,10 +2563,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCustomerProfileChannelEndpointAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments": { @@ -1478,18 +2572,21 @@ "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.", + "tags": [ + "TrusthubV1CustomerProfilesEntityAssignments" + ], "parameters": [ { "name": "CustomerProfileSid", @@ -1510,6 +2607,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment" + }, + "examples": { + "create": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1522,9 +2631,6 @@ } ], "operationId": "CreateCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1543,6 +2649,13 @@ "required": [ "ObjectSid" ] + }, + "examples": { + "create": { + "value": { + "ObjectSid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1550,6 +2663,9 @@ }, "get": { "description": "Retrieve a list of all Assigned Items for an account.", + "tags": [ + "TrusthubV1CustomerProfilesEntityAssignments" + ], "parameters": [ { "name": "CustomerProfileSid", @@ -1563,6 +2679,14 @@ }, "required": true }, + { + "name": "ObjectType", + "in": "query", + "description": "A string to filter the results by (EndUserType or SupportingDocumentType) machine-name. This is useful when you want to retrieve the entity-assignment of a specific end-user or supporting document.", + "schema": { + "type": "string" + } + }, { "name": "PageSize", "in": "query", @@ -1606,16 +2730,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1624,17 +2750,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -1649,10 +2812,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListCustomerProfileEntityAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid}": { @@ -1661,18 +2821,21 @@ "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.", + "tags": [ + "TrusthubV1CustomerProfilesEntityAssignments" + ], "parameters": [ { "name": "CustomerProfileSid", @@ -1705,6 +2868,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment" + }, + "examples": { + "fetch": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1716,13 +2891,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfileEntityAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", + "tags": [ + "TrusthubV1CustomerProfilesEntityAssignments" + ], "parameters": [ { "name": "CustomerProfileSid", @@ -1759,10 +2934,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCustomerProfileEntityAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations": { @@ -1771,18 +2943,21 @@ "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", + "tags": [ + "TrusthubV1CustomerProfilesEvaluations" + ], "parameters": [ { "name": "CustomerProfileSid", @@ -1803,6 +2978,326 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation" + }, + "examples": { + "create": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + }, + "createCompliantStarterCustomerProfile": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "compliant", + "date_created": "2023-03-15T13:51:57Z", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "valid": [ + { + "object_field": "first_name", + "error_code": null, + "friendly_name": "First Name", + "passed": true, + "failure_reason": null + }, + { + "object_field": "last_name", + "error_code": null, + "friendly_name": "Last Name", + "passed": true, + "failure_reason": null + }, + { + "object_field": "email", + "error_code": null, + "friendly_name": "Email Address", + "passed": true, + "failure_reason": null + }, + { + "object_field": "phone_number", + "error_code": null, + "friendly_name": "Phone Number", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "starter_customer_profile_information", + "friendly_name": "Information", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Starter Customer Profile Information", + "error_code": null, + "requirement_name": "starter_customer_profile_information" + }, + { + "valid": [ + { + "object_field": "address_sids", + "error_code": null, + "friendly_name": "address sids", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "customer_profile_address", + "friendly_name": "Legal Company Address", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Customer Profile Address", + "error_code": null, + "requirement_name": "customer_profile_address" + }, + { + "valid": [ + { + "object_field": "bundle_sid", + "error_code": null, + "friendly_name": "Supporting Bundle Status", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "primary_customer_profile_type_business", + "friendly_name": "Primary Customer Profile Bundle", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Primary Customer Profile", + "error_code": null, + "requirement_name": "primary_customer_profile" + } + ] + } + }, + "createCompliantSoleProprietorA2PProfile": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "compliant", + "date_created": "2023-03-15T13:51:57Z", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "valid": [ + { + "object_field": "brand_name", + "error_code": null, + "friendly_name": "Brand Name", + "passed": true, + "failure_reason": null + }, + { + "object_field": "mobile_phone_number", + "error_code": null, + "friendly_name": "Mobile Phone Number", + "passed": true, + "failure_reason": null + }, + { + "object_field": "vertical", + "error_code": null, + "friendly_name": "Vertical", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "sole_proprietor_information", + "friendly_name": "Sole Proprietor Information", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Sole Proprietor Information", + "error_code": null, + "requirement_name": "sole_proprietor_information" + }, + { + "valid": [ + { + "object_field": "bundle_status", + "error_code": null, + "friendly_name": "Supporting Bundle Status", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "starter_customer_profile_type_business", + "friendly_name": "Starter Customer Profile(isv customers) Proof", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Customer Profile", + "error_code": null, + "requirement_name": "customer_profile" + } + ] + } + } } } }, @@ -1815,9 +3310,6 @@ } ], "operationId": "CreateCustomerProfileEvaluation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1836,6 +3328,23 @@ "required": [ "PolicySid" ] + }, + "examples": { + "create": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCompliantStarterCustomerProfile": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCompliantSoleProprietorA2PProfile": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1843,6 +3352,9 @@ }, "get": { "description": "Retrieve a list of Evaluations associated to the customer_profile resource.", + "tags": [ + "TrusthubV1CustomerProfilesEvaluations" + ], "parameters": [ { "name": "CustomerProfileSid", @@ -1899,16 +3411,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1917,17 +3431,206 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -1942,10 +3645,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfileEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "ListCustomerProfileEvaluation" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}": { @@ -1954,18 +3654,21 @@ "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.", + "tags": [ + "TrusthubV1CustomerProfilesEvaluations" + ], "parameters": [ { "name": "CustomerProfileSid", @@ -1998,6 +3701,170 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation" + }, + "examples": { + "fetch": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + } } } }, @@ -2009,10 +3876,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfileEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfileEvaluation" } }, "/v1/EndUsers": { @@ -2021,7 +3885,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2031,12 +3895,36 @@ }, "post": { "description": "Create a new End User.", + "tags": [ + "TrusthubV1EndUser" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.end_user" + }, + "examples": { + "create": { + "value": { + "date_updated": "2021-02-16T20:40:57Z", + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "auth_rep_1", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-16T20:40:57Z", + "attributes": { + "phone_number": "+11234567890", + "job_position": "CEO", + "first_name": "rep1", + "last_name": "test", + "business_title": "ceo", + "email": "foobar@test.com" + }, + "type": "authorized_representative_1" + } + } } } }, @@ -2049,9 +3937,6 @@ } ], "operationId": "CreateEndUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2075,6 +3960,15 @@ "FriendlyName", "Type" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "auth_rep_1", + "Type": "authorized_representative_1", + "Attributes": "{}" + } + } } } } @@ -2082,6 +3976,9 @@ }, "get": { "description": "Retrieve a list of all End User for an account.", + "tags": [ + "TrusthubV1EndUser" + ], "parameters": [ { "name": "PageSize", @@ -2126,16 +4023,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2144,17 +4043,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "date_updated": "2021-02-16T20:40:57Z", + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "auth_rep_1", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-16T20:40:57Z", + "attributes": { + "phone_number": "+11234567890", + "job_position": "CEO", + "first_name": "rep1", + "last_name": "test", + "business_title": "ceo", + "email": "foobar@test.com" + }, + "type": "authorized_representative_1" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -2169,10 +4114,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListEndUser" } }, "/v1/EndUsers/{Sid}": { @@ -2181,7 +4123,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2191,6 +4133,9 @@ }, "get": { "description": "Fetch specific End User Instance.", + "tags": [ + "TrusthubV1EndUser" + ], "parameters": [ { "name": "Sid", @@ -2211,6 +4156,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.end_user" + }, + "examples": { + "fetch": { + "value": { + "date_updated": "2021-02-16T20:40:57Z", + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "auth_rep_1", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-16T20:40:57Z", + "attributes": { + "phone_number": "+11234567890", + "job_position": "CEO", + "first_name": "rep1", + "last_name": "test", + "business_title": "ceo", + "email": "foobar@test.com" + }, + "type": "authorized_representative_1" + } + } } } }, @@ -2222,13 +4188,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEndUser" }, "post": { "description": "Update an existing End User.", + "tags": [ + "TrusthubV1EndUser" + ], "parameters": [ { "name": "Sid", @@ -2249,6 +4215,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.end_user" + }, + "examples": { + "update": { + "value": { + "date_updated": "2021-02-16T20:40:57Z", + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-16T20:40:57Z", + "attributes": { + "phone_number": "+11234567890", + "job_position": "CEO", + "first_name": "rep1", + "last_name": "test", + "business_title": "ceo", + "email": "foobar@test.com" + }, + "type": "authorized_representative_1" + } + } } } }, @@ -2261,9 +4248,6 @@ } ], "operationId": "UpdateEndUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2279,6 +4263,14 @@ "description": "The set of parameters that are the attributes of the End User resource which are derived End User Types." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Attributes": "{}" + } + } } } } @@ -2286,6 +4278,9 @@ }, "delete": { "description": "Delete a specific End User.", + "tags": [ + "TrusthubV1EndUser" + ], "parameters": [ { "name": "Sid", @@ -2310,10 +4305,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteEndUser" } }, "/v1/EndUserTypes": { @@ -2322,7 +4314,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2332,6 +4324,9 @@ }, "get": { "description": "Retrieve a list of all End-User Types.", + "tags": [ + "TrusthubV1EndUserType" + ], "parameters": [ { "name": "PageSize", @@ -2376,16 +4371,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2394,19 +4391,86 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "end_user_types": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "end_user_types" } } + }, + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "end_user_types" + }, + "end_user_types": [ + { + "url": "https://trusthub.twilio.com/v1/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fields": [ + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "constraint": "String" + }, + { + "machine_name": "email", + "friendly_name": "Email", + "constraint": "String" + }, + { + "machine_name": "first_name", + "friendly_name": "First Name", + "constraint": "String" + }, + { + "machine_name": "business_title", + "friendly_name": "Business Title", + "constraint": "String" + }, + { + "machine_name": "phone_number", + "friendly_name": "Phone Number", + "constraint": "String" + }, + { + "machine_name": "job_position", + "friendly_name": "Job Position", + "constraint": "String" + } + ], + "machine_name": "authorized_representative_1", + "friendly_name": "Authorized Representative one", + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } } } } @@ -2419,10 +4483,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "ListEndUserType" } }, "/v1/EndUserTypes/{Sid}": { @@ -2431,7 +4492,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2441,6 +4502,9 @@ }, "get": { "description": "Fetch a specific End-User Type Instance.", + "tags": [ + "TrusthubV1EndUserType" + ], "parameters": [ { "name": "Sid", @@ -2458,6 +4522,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.end_user_type" + }, + "examples": { + "fetch": { + "value": { + "url": "https://trusthub.twilio.com/v1/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fields": [ + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "constraint": "String" + }, + { + "machine_name": "email", + "friendly_name": "Email", + "constraint": "String" + }, + { + "machine_name": "first_name", + "friendly_name": "First Name", + "constraint": "String" + }, + { + "machine_name": "business_title", + "friendly_name": "Business Title", + "constraint": "String" + }, + { + "machine_name": "phone_number", + "friendly_name": "Phone Number", + "constraint": "String" + }, + { + "machine_name": "job_position", + "friendly_name": "Job Position", + "constraint": "String" + } + ], + "machine_name": "authorized_representative_1", + "friendly_name": "Authorized Representative one", + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2469,10 +4575,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEndUserType" } }, "/v1/Policies": { @@ -2481,17 +4584,20 @@ "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.", + "tags": [ + "TrusthubV1Policies" + ], "parameters": [ { "name": "PageSize", @@ -2536,16 +4642,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2554,19 +4662,124 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } + }, + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + }, + "results": [ + { + "url": "https://trusthub.twilio.com/v1/Policies/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "requirements": { + "end_user": [ + { + "url": "/EndUserTypes/customer_profile_business_information", + "fields": [ + "business_type", + "business_registration_number", + "business_name", + "business_registration_identifier", + "business_identity", + "business_industry", + "website_url", + "business_regions_of_operation", + "social_media_profile_urls" + ], + "type": "customer_profile_business_information", + "name": "Business Information", + "requirement_name": "customer_profile_business_information" + }, + { + "url": "/EndUserTypes/authorized_representative_1", + "fields": [ + "first_name", + "last_name", + "email", + "phone_number", + "business_title", + "job_position" + ], + "type": "authorized_representative_1", + "name": "Authorized Representative 1", + "requirement_name": "authorized_representative_1" + }, + { + "url": "/EndUserTypes/authorized_representative_2", + "fields": [ + "first_name", + "last_name", + "email", + "phone_number", + "business_title", + "job_position" + ], + "type": "authorized_representative_2", + "name": "Authorized Representative 2", + "requirement_name": "authorized_representative_2" + } + ], + "supporting_trust_products": [], + "supporting_document": [ + [ + { + "description": "Customer Profile HQ Physical Address", + "type": "document", + "name": "Physical Business Address", + "accepted_documents": [ + { + "url": "/SupportingDocumentTypes/customer_profile_address", + "fields": [ + "address_sids" + ], + "type": "customer_profile_address", + "name": "Physical Business Address" + } + ], + "requirement_name": "customer_profile_address" + } + ] + ], + "supporting_customer_profiles": [] + }, + "friendly_name": "Primary Customer Profile of type Business", + "sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } } } } @@ -2579,10 +4792,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPolicies", - "x-maturity": [ - "GA" - ] + "operationId": "ListPolicies" } }, "/v1/Policies/{Sid}": { @@ -2591,17 +4801,20 @@ "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.", + "tags": [ + "TrusthubV1Policies" + ], "parameters": [ { "name": "Sid", @@ -2622,6 +4835,183 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.policies" + }, + "examples": { + "fetch": { + "value": { + "url": "https://trusthub.twilio.com/v1/Policies/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "requirements": { + "end_user": [ + { + "url": "/EndUserTypes/customer_profile_business_information", + "fields": [ + "business_type", + "business_registration_number", + "business_name", + "business_registration_identifier", + "business_identity", + "business_industry", + "website_url", + "business_regions_of_operation", + "social_media_profile_urls" + ], + "type": "customer_profile_business_information", + "name": "Business Information", + "requirement_name": "customer_profile_business_information" + }, + { + "url": "/EndUserTypes/authorized_representative_1", + "fields": [ + "first_name", + "last_name", + "email", + "phone_number", + "business_title", + "job_position" + ], + "type": "authorized_representative_1", + "name": "Authorized Representative 1", + "requirement_name": "authorized_representative_1" + }, + { + "url": "/EndUserTypes/authorized_representative_2", + "fields": [ + "first_name", + "last_name", + "email", + "phone_number", + "business_title", + "job_position" + ], + "type": "authorized_representative_2", + "name": "Authorized Representative 2", + "requirement_name": "authorized_representative_2" + } + ], + "supporting_trust_products": [], + "supporting_document": [ + [ + { + "description": "Customer Profile HQ Physical Address", + "type": "document", + "name": "Physical Business Address", + "accepted_documents": [ + { + "url": "/SupportingDocumentTypes/customer_profile_address", + "fields": [ + "address_sids" + ], + "type": "customer_profile_address", + "name": "Physical Business Address" + } + ], + "requirement_name": "customer_profile_address" + } + ] + ], + "supporting_customer_profiles": [] + }, + "friendly_name": "Primary Customer Profile of type Business", + "sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchStarterCustomerProfilePolicy": { + "value": { + "url": "https://trusthub.twilio.com/v1/Policies/RN806dd6cd175f314e1f96a9727ee271f4", + "requirements": { + "end_user": [ + { + "url": "/EndUserTypes/starter_customer_profile_information", + "fields": [ + "first_name", + "last_name", + "email", + "phone_number" + ], + "type": "starter_customer_profile_information", + "name": "Information", + "requirement_name": "starter_customer_profile_information" + } + ], + "supporting_trust_products": [], + "supporting_document": [ + [ + { + "description": "Customer Profile Address", + "type": "document", + "name": "Customer Profile Address", + "accepted_documents": [ + { + "url": "/SupportingDocumentTypes/customer_profile_address", + "fields": [ + "address_sids" + ], + "type": "customer_profile_address", + "name": "Legal Company Address" + }, + { + "url": "/SupportingDocumentTypes/starter_customer_profile_address", + "fields": [ + "address_sids" + ], + "type": "starter_customer_profile_address", + "name": "Legal Company Address" + } + ], + "requirement_name": "customer_profile_address" + } + ] + ], + "supporting_customer_profiles": [ + { + "type": "primary_customer_profile_type_business", + "name": "Primary Customer Profile Bundle", + "requirement_name": "primary_customer_profile" + } + ] + }, + "friendly_name": "Starter Customer Profile of type Business", + "sid": "RN806dd6cd175f314e1f96a9727ee271f4" + } + }, + "fetchSoleProprietorTrustBundlePolicy": { + "value": { + "url": "https://trusthub.twilio.com/v1/Policies/RN670d5d2e282a6130ae063b234b6019c8", + "requirements": { + "end_user": [ + { + "url": "/EndUserTypes/sole_proprietor_information", + "fields": [ + "brand_name", + "mobile_phone_number", + "vertical" + ], + "type": "sole_proprietor_information", + "name": "Sole Proprietor Information", + "requirement_name": "sole_proprietor_information" + } + ], + "supporting_trust_products": [], + "supporting_document": [ + [] + ], + "supporting_customer_profiles": [ + { + "type": "starter_customer_profile_type_business", + "name": "Starter Customer Profile(isv customers) Proof", + "requirement_name": "customer_profile" + }, + { + "type": "starter_customer_profile_type_direct_long_tail", + "name": "Starter Customer Profile(direct customers) Proof", + "requirement_name": "customer_profile" + } + ] + }, + "friendly_name": "Sole Proprietor TrustProduct", + "sid": "RN670d5d2e282a6130ae063b234b6019c8" + } + } } } }, @@ -2633,10 +5023,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPolicies", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPolicies" } }, "/v1/SupportingDocuments": { @@ -2645,7 +5032,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2655,12 +5042,33 @@ }, "post": { "description": "Create a new Supporting Document.", + "tags": [ + "TrusthubV1SupportingDocument" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.supporting_document" + }, + "examples": { + "create": { + "value": { + "status": "draft", + "date_updated": "2021-02-11T17:23:00Z", + "friendly_name": "Business-profile-physical-address", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-11T17:23:00Z", + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": { + "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "type": "customer_profile_address", + "mime_type": null + } + } } } }, @@ -2673,9 +5081,6 @@ } ], "operationId": "CreateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2699,6 +5104,15 @@ "FriendlyName", "Type" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Business-profile-physical-address", + "Type": "customer_profile_address", + "Attributes": "{}" + } + } } } } @@ -2706,6 +5120,9 @@ }, "get": { "description": "Retrieve a list of all Supporting Document for an account.", + "tags": [ + "TrusthubV1SupportingDocument" + ], "parameters": [ { "name": "PageSize", @@ -2750,16 +5167,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2768,17 +5187,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "status": "draft", + "date_updated": "2021-02-11T17:23:00Z", + "friendly_name": "Business-profile-physical-address", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-11T17:23:00Z", + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": { + "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "type": "customer_profile_address", + "mime_type": null + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -2793,10 +5255,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocument" } }, "/v1/SupportingDocuments/{Sid}": { @@ -2805,7 +5264,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2815,6 +5274,9 @@ }, "get": { "description": "Fetch specific Supporting Document Instance.", + "tags": [ + "TrusthubV1SupportingDocument" + ], "parameters": [ { "name": "Sid", @@ -2835,6 +5297,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.supporting_document" + }, + "examples": { + "fetch": { + "value": { + "status": "draft", + "date_updated": "2021-02-11T17:23:00Z", + "friendly_name": "Business-profile-physical-address", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-11T17:23:00Z", + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": { + "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "type": "customer_profile_address", + "mime_type": null + } + } } } }, @@ -2846,13 +5326,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocument" }, "post": { "description": "Update an existing Supporting Document.", + "tags": [ + "TrusthubV1SupportingDocument" + ], "parameters": [ { "name": "Sid", @@ -2873,6 +5353,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.supporting_document" + }, + "examples": { + "update": { + "value": { + "status": "draft", + "date_updated": "2021-02-11T17:23:00Z", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-11T17:23:00Z", + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": { + "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "type": "customer_profile_address", + "mime_type": null + } + } } } }, @@ -2885,9 +5383,6 @@ } ], "operationId": "UpdateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2903,6 +5398,14 @@ "description": "The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Attributes": "{}" + } + } } } } @@ -2910,6 +5413,9 @@ }, "delete": { "description": "Delete a specific Supporting Document.", + "tags": [ + "TrusthubV1SupportingDocument" + ], "parameters": [ { "name": "Sid", @@ -2934,10 +5440,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSupportingDocument" } }, "/v1/SupportingDocumentTypes": { @@ -2946,7 +5449,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2956,6 +5459,9 @@ }, "get": { "description": "Retrieve a list of all Supporting Document Types.", + "tags": [ + "TrusthubV1SupportingDocumentType" + ], "parameters": [ { "name": "PageSize", @@ -3000,16 +5506,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3018,17 +5526,82 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "supporting_document_types": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "supporting_document_types" + } + } + }, + "readFull": { + "value": { + "supporting_document_types": [ + { + "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fields": [ + { + "machine_name": "address_sids", + "friendly_name": "Address Sids", + "constraint": "List" + } + ], + "machine_name": "customer_profile_address", + "friendly_name": "Customer profile address", + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fields": [ + { + "machine_name": "first_name", + "friendly_name": "First Name", + "constraint": "String" + }, + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "constraint": "String" + }, + { + "machine_name": "business_name", + "friendly_name": "Business Name", + "constraint": "String" + } + ], + "machine_name": "government_issued_proof_of_authorized_representative", + "friendly_name": "Government Issued Identity certifying proof of being an authorized representative of a company", + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "supporting_document_types" } } } @@ -3043,10 +5616,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocumentType" } }, "/v1/SupportingDocumentTypes/{Sid}": { @@ -3055,7 +5625,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3065,6 +5635,9 @@ }, "get": { "description": "Fetch a specific Supporting Document Type Instance.", + "tags": [ + "TrusthubV1SupportingDocumentType" + ], "parameters": [ { "name": "Sid", @@ -3082,6 +5655,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.supporting_document_type" + }, + "examples": { + "fetch": { + "value": { + "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fields": [ + { + "machine_name": "first_name", + "friendly_name": "First Name", + "constraint": "String" + }, + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "constraint": "String" + }, + { + "machine_name": "business_name", + "friendly_name": "Business Name", + "constraint": "String" + } + ], + "machine_name": "government_issued_proof_of_authorized_representative", + "friendly_name": "Government Issued Identity certifying proof of being an authorized representative of a company", + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3093,10 +5693,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocumentType" } }, "/v1/TrustProducts": { @@ -3105,29 +5702,69 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "policy_sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "trust_products_entity_assignments": "{trust_product_sid: sid}", - "trust_products_evaluations": "{trust_product_sid: sid}", - "trust_products_channel_endpoint_assignment": "{trust_product_sid: sid}" + "trust_products_entity_assignments": { + "mapping": { + "trust_product_sid": "sid" + }, + "resource_url": "/v1/TrustProducts/{trust_product_sid}/EntityAssignments" + }, + "trust_products_evaluations": { + "mapping": { + "trust_product_sid": "sid" + }, + "resource_url": "/v1/TrustProducts/{trust_product_sid}/Evaluations" + }, + "trust_products_channel_endpoint_assignment": { + "mapping": { + "trust_product_sid": "sid" + }, + "resource_url": "/v1/TrustProducts/{trust_product_sid}/ChannelEndpointAssignments" + } }, - "className": "trust_products" + "className": "trust_products", + "pathType": "list" }, "post": { "description": "Create a new Customer-Profile.", + "tags": [ + "TrusthubV1TrustProducts" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product" + }, + "examples": { + "create": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } } } }, @@ -3140,9 +5777,6 @@ } ], "operationId": "CreateTrustProduct", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3176,6 +5810,16 @@ "Email", "PolicySid" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Email": "email", + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "StatusCallback": "http://www.example.com" + } + } } } } @@ -3183,6 +5827,9 @@ }, "get": { "description": "Retrieve a list of all Customer-Profiles for an account.", + "tags": [ + "TrusthubV1TrustProducts" + ], "parameters": [ { "name": "Status", @@ -3191,6 +5838,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/trust_product_enum_status" + }, + "examples": { + "readFull": { + "value": "draft" + } } }, { @@ -3199,6 +5851,11 @@ "description": "The string that you assigned to describe the resource.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + } } }, { @@ -3210,6 +5867,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3255,16 +5917,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3273,17 +5937,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "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" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -3298,10 +6009,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProduct", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProduct" } }, "/v1/TrustProducts/{Sid}": { @@ -3310,23 +6018,41 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "policy_sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "trust_products_entity_assignments": "{trust_product_sid: sid}", - "trust_products_evaluations": "{trust_product_sid: sid}", - "trust_products_channel_endpoint_assignment": "{trust_product_sid: sid}" + "trust_products_entity_assignments": { + "mapping": { + "trust_product_sid": "sid" + }, + "resource_url": "/v1/TrustProducts/{trust_product_sid}/EntityAssignments" + }, + "trust_products_evaluations": { + "mapping": { + "trust_product_sid": "sid" + }, + "resource_url": "/v1/TrustProducts/{trust_product_sid}/Evaluations" + }, + "trust_products_channel_endpoint_assignment": { + "mapping": { + "trust_product_sid": "sid" + }, + "resource_url": "/v1/TrustProducts/{trust_product_sid}/ChannelEndpointAssignments" + } }, - "className": "trust_products" + "className": "trust_products", + "pathType": "instance" }, "get": { "description": "Fetch a specific Customer-Profile instance.", + "tags": [ + "TrusthubV1TrustProducts" + ], "parameters": [ { "name": "Sid", @@ -3347,6 +6073,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product" + }, + "examples": { + "fetch": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "valid_until": null, + "email": "email", + "status_callback": "http://www.example.com", + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } } } }, @@ -3358,13 +6106,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProduct", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProduct" }, "post": { "description": "Updates a Customer-Profile in an account.", + "tags": [ + "TrusthubV1TrustProducts" + ], "parameters": [ { "name": "Sid", @@ -3385,6 +6133,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product" + }, + "examples": { + "update": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + }, + "updateToInReview": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "in-review", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } } } }, @@ -3397,9 +6187,6 @@ } ], "operationId": "UpdateTrustProduct", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3426,6 +6213,21 @@ "description": "The email address that will receive updates when the Customer-Profile resource changes status." } } + }, + "examples": { + "update": { + "value": { + "Status": "draft", + "StatusCallback": "http://www.example.com", + "FriendlyName": "friendly_name", + "Email": "email" + } + }, + "updateToInReview": { + "value": { + "Status": "pending-review" + } + } } } } @@ -3433,6 +6235,9 @@ }, "delete": { "description": "Delete a specific Customer-Profile.", + "tags": [ + "TrusthubV1TrustProducts" + ], "parameters": [ { "name": "Sid", @@ -3457,10 +6262,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrustProduct", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrustProduct" } }, "/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments": { @@ -3469,17 +6271,20 @@ "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.", + "tags": [ + "TrusthubV1TrustProductsChannelEndpointAssignment" + ], "parameters": [ { "name": "TrustProductSid", @@ -3500,6 +6305,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment" + }, + "examples": { + "create": { + "value": { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3512,9 +6330,6 @@ } ], "operationId": "CreateTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3538,6 +6353,14 @@ "ChannelEndpointType", "ChannelEndpointSid" ] + }, + "examples": { + "create": { + "value": { + "ChannelEndpointSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChannelEndpointType": "phone-number" + } + } } } } @@ -3545,6 +6368,9 @@ }, "get": { "description": "Retrieve a list of all Assigned Items for an account.", + "tags": [ + "TrusthubV1TrustProductsChannelEndpointAssignment" + ], "parameters": [ { "name": "TrustProductSid", @@ -3567,6 +6393,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3620,16 +6451,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3638,17 +6471,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -3663,10 +6534,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProductChannelEndpointAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments/{Sid}": { @@ -3675,17 +6543,20 @@ "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.", + "tags": [ + "TrusthubV1TrustProductsChannelEndpointAssignment" + ], "parameters": [ { "name": "TrustProductSid", @@ -3718,6 +6589,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment" + }, + "examples": { + "fetch": { + "value": { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3729,13 +6613,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProductChannelEndpointAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", + "tags": [ + "TrusthubV1TrustProductsChannelEndpointAssignment" + ], "parameters": [ { "name": "TrustProductSid", @@ -3772,10 +6656,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrustProductChannelEndpointAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/EntityAssignments": { @@ -3784,18 +6665,21 @@ "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.", + "tags": [ + "TrusthubV1TrustProductsEntityAssignments" + ], "parameters": [ { "name": "TrustProductSid", @@ -3816,6 +6700,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment" + }, + "examples": { + "create": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3828,9 +6724,6 @@ } ], "operationId": "CreateTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3849,6 +6742,13 @@ "required": [ "ObjectSid" ] + }, + "examples": { + "create": { + "value": { + "ObjectSid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3856,6 +6756,9 @@ }, "get": { "description": "Retrieve a list of all Assigned Items for an account.", + "tags": [ + "TrusthubV1TrustProductsEntityAssignments" + ], "parameters": [ { "name": "TrustProductSid", @@ -3869,6 +6772,14 @@ }, "required": true }, + { + "name": "ObjectType", + "in": "query", + "description": "A string to filter the results by (EndUserType or SupportingDocumentType) machine-name. This is useful when you want to retrieve the entity-assignment of a specific end-user or supporting document.", + "schema": { + "type": "string" + } + }, { "name": "PageSize", "in": "query", @@ -3912,16 +6823,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3930,17 +6843,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -3955,10 +6905,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProductEntityAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/EntityAssignments/{Sid}": { @@ -3967,18 +6914,21 @@ "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.", + "tags": [ + "TrusthubV1TrustProductsEntityAssignments" + ], "parameters": [ { "name": "TrustProductSid", @@ -4011,6 +6961,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment" + }, + "examples": { + "fetch": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4022,13 +6984,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProductEntityAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", + "tags": [ + "TrusthubV1TrustProductsEntityAssignments" + ], "parameters": [ { "name": "TrustProductSid", @@ -4065,10 +7027,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrustProductEntityAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/Evaluations": { @@ -4077,18 +7036,21 @@ "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", + "tags": [ + "TrusthubV1TrustProductsEvaluations" + ], "parameters": [ { "name": "TrustProductSid", @@ -4109,6 +7071,235 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation" + }, + "examples": { + "create": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + }, + "createCompliantSoleProprietorA2PProfile": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "compliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "valid": [ + { + "object_field": "brand_name", + "error_code": null, + "friendly_name": "Brand Name", + "passed": true, + "failure_reason": null + }, + { + "object_field": "mobile_phone_number", + "error_code": null, + "friendly_name": "Mobile Phone Number", + "passed": true, + "failure_reason": null + }, + { + "object_field": "vertical", + "error_code": null, + "friendly_name": "Vertical", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "sole_proprietor_information", + "friendly_name": "Sole Proprietor Information", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Sole Proprietor Information", + "error_code": null, + "requirement_name": "sole_proprietor_information" + }, + { + "valid": [ + { + "object_field": "bundle_status", + "error_code": null, + "friendly_name": "Supporting Bundle Status", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "starter_customer_profile_type_business", + "friendly_name": "Starter Customer Profile(isv customers) Proof", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Customer Profile", + "error_code": null, + "requirement_name": "customer_profile" + } + ] + } + } } } }, @@ -4121,9 +7312,6 @@ } ], "operationId": "CreateTrustProductEvaluation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4142,6 +7330,18 @@ "required": [ "PolicySid" ] + }, + "examples": { + "create": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCompliantSoleProprietorA2PProfile": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -4149,6 +7349,9 @@ }, "get": { "description": "Retrieve a list of Evaluations associated to the trust_product resource.", + "tags": [ + "TrusthubV1TrustProductsEvaluations" + ], "parameters": [ { "name": "TrustProductSid", @@ -4205,16 +7408,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4223,17 +7428,206 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -4248,10 +7642,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProductEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProductEvaluation" } }, "/v1/TrustProducts/{TrustProductSid}/Evaluations/{Sid}": { @@ -4260,18 +7651,21 @@ "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.", + "tags": [ + "TrusthubV1TrustProductsEvaluations" + ], "parameters": [ { "name": "TrustProductSid", @@ -4304,6 +7698,170 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation" + }, + "examples": { + "fetch": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + } } } }, @@ -4315,10 +7873,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProductEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProductEvaluation" } } }, @@ -4327,10 +7882,65 @@ "url": "https://trusthub.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "TrusthubV1ComplianceInquiries" + }, + { + "name": "TrusthubV1ComplianceRegistrationInquiries" + }, + { + "name": "TrusthubV1ComplianceTollfreeInquiries" + }, + { + "name": "TrusthubV1CustomerProfiles" + }, + { + "name": "TrusthubV1CustomerProfilesChannelEndpointAssignment" + }, + { + "name": "TrusthubV1CustomerProfilesEntityAssignments" + }, + { + "name": "TrusthubV1CustomerProfilesEvaluations" + }, + { + "name": "TrusthubV1CustomerProfilesProvisionalCopy" + }, + { + "name": "TrusthubV1EndUser" + }, + { + "name": "TrusthubV1EndUserType" + }, + { + "name": "TrusthubV1Policies" + }, + { + "name": "TrusthubV1SupportingDocument" + }, + { + "name": "TrusthubV1SupportingDocumentType" + }, + { + "name": "TrusthubV1TrustProducts" + }, + { + "name": "TrusthubV1TrustProductsChannelEndpointAssignment" + }, + { + "name": "TrusthubV1TrustProductsEntityAssignments" + }, + { + "name": "TrusthubV1TrustProductsEvaluations" + }, + { + "name": "TrusthubV1TrustProductsProvisionalCopy" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_verify_v2.json b/spec/json/twilio_verify_v2.json index 3ea5a6e6..a32d436e 100644 --- a/spec/json/twilio_verify_v2.json +++ b/spec/json/twilio_verify_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "verify.v2.service.access_token": { "type": "object", @@ -42,7 +48,13 @@ "factor_friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name." + "description": "A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "token": { "type": "string", @@ -177,7 +189,13 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters." + "description": "Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "factor_sid": { "type": "string", @@ -225,15 +243,33 @@ }, "details": { "nullable": true, - "description": "Details provided to give context about the Challenge. Intended to be shown to the end user." + "description": "Details provided to give context about the Challenge. Intended to be shown to the end user.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "hidden_details": { "nullable": true, - "description": "Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. `{\"ip\": \"172.168.1.234\"}`" + "description": "Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. `{\"ip\": \"172.168.1.234\"}`", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "metadata": { "nullable": true, - "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." + "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.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "factor_type": { "type": "string", @@ -300,7 +336,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters." + "description": "The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -382,7 +424,13 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters." + "description": "Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -419,7 +467,13 @@ }, "metadata": { "nullable": true, - "description": "Custom metadata associated with the factor. 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." + "description": "Custom metadata associated with the factor. 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.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -520,7 +574,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) to be used to send SMS to the country of this configuration." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration." }, "date_created": { "type": "string", @@ -580,7 +634,13 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters." + "description": "Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "binding": { "nullable": true, @@ -621,7 +681,13 @@ }, "metadata": { "nullable": true, - "description": "Custom metadata associated with the factor. 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." + "description": "Custom metadata associated with the factor. 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.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -699,7 +765,13 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters." + "description": "Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "challenge_sid": { "type": "string", @@ -804,7 +876,13 @@ "phone_number": { "type": "string", "nullable": true, - "description": "The phone number in SafeList." + "description": "The phone number in SafeList.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "url": { "type": "string", @@ -893,6 +971,11 @@ "pattern": "^HJ[0-9a-fA-F]{32}$", "nullable": true }, + "verify_event_subscription_enabled": { + "type": "boolean", + "nullable": true, + "description": "Whether to allow verifications from the service to reach the stream-events sinks if configured" + }, "date_created": { "type": "string", "format": "date-time", @@ -949,13 +1032,19 @@ "to": { "type": "string", "nullable": true, - "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164)." + "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "channel": { "type": "string", "$ref": "#/components/schemas/verification_enum_channel", "nullable": true, - "description": "The verification method used. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, or `sna`." + "description": "The verification method used. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, `sna`, or `rcs`." }, "status": { "type": "string", @@ -974,12 +1063,24 @@ "amount": { "type": "string", "nullable": true, - "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." + "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 1 + } + } }, "payee": { "type": "string", "nullable": true, - "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." + "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 1 + } + } }, "send_code_attempts": { "type": "array", @@ -1028,6 +1129,13 @@ "approved" ] }, + "verification_enum_risk_check": { + "type": "string", + "enum": [ + "enable", + "disable" + ] + }, "verify.v2.verification_attempt": { "type": "object", "properties": { @@ -1089,7 +1197,7 @@ }, "price": { "nullable": true, - "description": "An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](https://www.twilio.com/verify/pricing)." + "description": "An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](https://www.twilio.com/en-us/verify/pricing)." }, "channel_data": { "nullable": true, @@ -1226,7 +1334,13 @@ "to": { "type": "string", "nullable": true, - "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164)." + "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "channel": { "type": "string", @@ -1247,12 +1361,24 @@ "amount": { "type": "string", "nullable": true, - "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." + "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 1 + } + } }, "payee": { "type": "string", "nullable": true, - "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." + "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 1 + } + } }, "date_created": { "type": "string", @@ -1427,12 +1553,6 @@ "POST" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1448,7 +1568,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1458,7 +1578,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1471,11 +1591,14 @@ "ttl", "date_created" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new enrollment Access Token for the Entity", + "tags": [ + "VerifyV2AccessToken" + ], "parameters": [ { "name": "ServiceSid", @@ -1496,6 +1619,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.access_token" + }, + "examples": { + "createWithTtl": { + "value": { + "sid": "YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_type": "push", + "factor_friendly_name": "John Doe iPhone", + "ttl": 300, + "date_created": "2015-07-30T20:00:00Z", + "token": "eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithoutTtl": { + "value": { + "sid": "YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_type": "push", + "factor_friendly_name": "John Doe iPhone", + "ttl": 60, + "date_created": "2015-07-30T20:00:00Z", + "token": "eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1508,9 +1661,6 @@ } ], "operationId": "CreateAccessToken", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1540,6 +1690,23 @@ "Identity", "FactorType" ] + }, + "examples": { + "createWithTtl": { + "value": { + "FactorType": "push", + "FactorFriendlyName": "John Doe iPhone", + "Identity": "ff483d1ff591898a9942916050d2ca3f", + "Ttl": 300 + } + }, + "createWithoutTtl": { + "value": { + "FactorType": "push", + "FactorFriendlyName": "John Doe iPhone", + "Identity": "ff483d1ff591898a9942916050d2ca3f" + } + } } } } @@ -1552,7 +1719,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1565,11 +1732,14 @@ "ttl", "date_created" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch an Access Token for the Entity", + "tags": [ + "VerifyV2AccessToken" + ], "parameters": [ { "name": "ServiceSid", @@ -1602,6 +1772,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.access_token" + }, + "examples": { + "fetch": { + "value": { + "sid": "YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_type": "push", + "factor_friendly_name": "John Doe iPhone", + "ttl": 60, + "date_created": "2015-07-30T20:00:00Z", + "token": "eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1613,10 +1799,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccessToken", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAccessToken" } }, "/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets": { @@ -1625,7 +1808,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1637,11 +1820,14 @@ "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", + "tags": [ + "VerifyV2Bucket" + ], "parameters": [ { "name": "ServiceSid", @@ -1674,6 +1860,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit.bucket" + }, + "examples": { + "createBucket": { + "value": { + "sid": "BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rate_limit_sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "max": 5, + "interval": 60, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1686,9 +1887,6 @@ } ], "operationId": "CreateBucket", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1709,6 +1907,14 @@ "Max", "Interval" ] + }, + "examples": { + "createBucket": { + "value": { + "Max": 5, + "Interval": 60 + } + } } } } @@ -1716,6 +1922,9 @@ }, "get": { "description": "Retrieve a list of all Buckets for a Rate Limit.", + "tags": [ + "VerifyV2Bucket" + ], "parameters": [ { "name": "ServiceSid", @@ -1784,16 +1993,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1802,17 +2013,57 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "buckets": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0", + "next_page_url": null, + "key": "buckets" + } + } + }, + "readFull": { + "value": { + "buckets": [ + { + "sid": "BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rate_limit_sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "max": 5, + "interval": 60, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0", + "next_page_url": null, + "key": "buckets" } } } @@ -1827,10 +2078,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBucket", - "x-maturity": [ - "GA" - ] + "operationId": "ListBucket" } }, "/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}": { @@ -1839,7 +2087,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1851,11 +2099,14 @@ "date_created", "date_updated" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/RateLimits/{Sid}" + "parent": "/Services/{ServiceSid}/RateLimits/{Sid}", + "pathType": "instance" }, "post": { "description": "Update a specific Bucket.", + "tags": [ + "VerifyV2Bucket" + ], "parameters": [ { "name": "ServiceSid", @@ -1900,6 +2151,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit.bucket" + }, + "examples": { + "updateBucket": { + "value": { + "sid": "BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rate_limit_sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "max": 5, + "interval": 60, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1912,9 +2178,6 @@ } ], "operationId": "UpdateBucket", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1931,6 +2194,14 @@ "description": "Number of seconds that the rate limit will be enforced over." } } + }, + "examples": { + "updateBucket": { + "value": { + "Max": 5, + "Interval": 60 + } + } } } } @@ -1938,6 +2209,9 @@ }, "get": { "description": "Fetch a specific Bucket.", + "tags": [ + "VerifyV2Bucket" + ], "parameters": [ { "name": "ServiceSid", @@ -1982,6 +2256,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit.bucket" + }, + "examples": { + "fetchBucket": { + "value": { + "sid": "BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rate_limit_sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "max": 5, + "interval": 60, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1993,13 +2282,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBucket", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBucket" }, "delete": { "description": "Delete a specific Bucket.", + "tags": [ + "VerifyV2Bucket" + ], "parameters": [ { "name": "ServiceSid", @@ -2048,10 +2337,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBucket", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteBucket" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges": { @@ -2060,7 +2346,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "factor_type", @@ -2068,14 +2354,24 @@ "responded_reason", "date_created" ], - "pathType": "list", "dependentProperties": { - "notification": "{service_sid: service_sid, identity: identity, challenge_sid: sid}" + "notifications": { + "mapping": { + "service_sid": "service_sid", + "identity": "identity", + "challenge_sid": "sid" + }, + "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", + "tags": [ + "VerifyV2Challenge" + ], "parameters": [ { "name": "ServiceSid", @@ -2096,6 +2392,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -2105,6 +2407,113 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.challenge" + }, + "examples": { + "createPush": { + "value": { + "sid": "YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "pending", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "push", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + }, + "createTotpWithoutAuthPayload": { + "value": { + "sid": "YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "pending", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "totp", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + }, + "createTotpWithAuthPayload": { + "value": { + "sid": "YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "approved", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "totp", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + } } } }, @@ -2117,9 +2526,6 @@ } ], "operationId": "CreateChallenge", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2159,6 +2565,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" + } + } } } } @@ -2166,6 +2608,9 @@ }, "get": { "description": "Retrieve a list of all Challenges for a Factor.", + "tags": [ + "VerifyV2Challenge" + ], "parameters": [ { "name": "ServiceSid", @@ -2186,6 +2631,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -2260,16 +2711,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2278,17 +2731,112 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "challenges": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0", + "next_page_url": null, + "key": "challenges" + } + } + }, + "readFull": { + "value": { + "challenges": [ + { + "sid": "YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "pending", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "push", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + }, + { + "sid": "YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "pending", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "totp", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0", + "next_page_url": null, + "key": "challenges" } } } @@ -2303,10 +2851,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChallenge", - "x-maturity": [ - "GA" - ] + "operationId": "ListChallenge" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}": { @@ -2315,7 +2860,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "factor_type", @@ -2323,14 +2868,24 @@ "responded_reason", "date_created" ], - "pathType": "instance", "dependentProperties": { - "notification": "{service_sid: service_sid, identity: identity, challenge_sid: sid}" + "notifications": { + "mapping": { + "service_sid": "service_sid", + "identity": "identity", + "challenge_sid": "sid" + }, + "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.", + "tags": [ + "VerifyV2Challenge" + ], "parameters": [ { "name": "ServiceSid", @@ -2351,6 +2906,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -2372,6 +2933,45 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.challenge" + }, + "examples": { + "fetchSid": { + "value": { + "sid": "YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "approved", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": { + "os": "Android" + }, + "factor_type": "push", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + } } } }, @@ -2383,13 +2983,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChallenge", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChallenge" }, "post": { "description": "Verify a specific Challenge.", + "tags": [ + "VerifyV2Challenge" + ], "parameters": [ { "name": "ServiceSid", @@ -2410,6 +3010,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -2431,6 +3037,80 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.challenge" + }, + "examples": { + "verifyPush": { + "value": { + "sid": "YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "approved", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": { + "os": "Android" + }, + "factor_type": "push", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + }, + "verifyTotp": { + "value": { + "sid": "YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "approved", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "totp", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + } } } }, @@ -2443,9 +3123,6 @@ } ], "operationId": "UpdateChallenge", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2461,6 +3138,19 @@ "description": "Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length." } } + }, + "examples": { + "verifyPush": { + "value": { + "AuthPayload": "123456", + "Metadata": "{\"os\": \"Android\"}" + } + }, + "verifyTotp": { + "value": { + "AuthPayload": "123456" + } + } } } } @@ -2473,23 +3163,44 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "list", "dependentProperties": { - "factor": "{service_sid: service_sid, identity: identity}", - "new_factor": "{service_sid: service_sid, identity: identity}", - "challenge": "{service_sid: service_sid, identity: identity}" + "factors": { + "mapping": { + "service_sid": "service_sid", + "identity": "identity" + }, + "resource_url": "/v2/Services/{service_sid}/Entities/{identity}/Factors" + }, + "new_factors": { + "mapping": { + "service_sid": "service_sid", + "identity": "identity" + }, + "resource_url": "/v2/Services/{service_sid}/Entities/{identity}/Factors" + }, + "challenges": { + "mapping": { + "service_sid": "service_sid", + "identity": "identity" + }, + "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", + "tags": [ + "VerifyV2Entity" + ], "parameters": [ { "name": "ServiceSid", @@ -2510,6 +3221,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity" + }, + "examples": { + "create": { + "value": { + "sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f", + "links": { + "factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "new_factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "challenges": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges" + } + } + } } } }, @@ -2522,9 +3251,6 @@ } ], "operationId": "CreateEntity", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2540,6 +3266,13 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "ff483d1ff591898a9942916050d2ca3f" + } + } } } } @@ -2547,6 +3280,9 @@ }, "get": { "description": "Retrieve a list of all Entities for a Service.", + "tags": [ + "VerifyV2Entity" + ], "parameters": [ { "name": "ServiceSid", @@ -2603,16 +3339,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2621,17 +3359,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "entities": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0", + "next_page_url": null, + "key": "entities" + } + } + }, + "readFull": { + "value": { + "entities": [ + { + "sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f", + "links": { + "factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "new_factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "challenges": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0", + "next_page_url": null, + "key": "entities" } } } @@ -2646,10 +3427,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEntity", - "x-maturity": [ - "GA" - ] + "operationId": "ListEntity" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}": { @@ -2658,23 +3436,44 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "instance", "dependentProperties": { - "factor": "{service_sid: service_sid, identity: identity}", - "new_factor": "{service_sid: service_sid, identity: identity}", - "challenge": "{service_sid: service_sid, identity: identity}" + "factors": { + "mapping": { + "service_sid": "service_sid", + "identity": "identity" + }, + "resource_url": "/v2/Services/{service_sid}/Entities/{identity}/Factors" + }, + "new_factors": { + "mapping": { + "service_sid": "service_sid", + "identity": "identity" + }, + "resource_url": "/v2/Services/{service_sid}/Entities/{identity}/Factors" + }, + "challenges": { + "mapping": { + "service_sid": "service_sid", + "identity": "identity" + }, + "resource_url": "/v2/Services/{service_sid}/Entities/{identity}/Challenges" + } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "Delete a specific Entity.", + "tags": [ + "VerifyV2Entity" + ], "parameters": [ { "name": "ServiceSid", @@ -2695,6 +3494,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -2708,13 +3513,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEntity", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteEntity" }, "get": { "description": "Fetch a specific Entity.", + "tags": [ + "VerifyV2Entity" + ], "parameters": [ { "name": "ServiceSid", @@ -2735,6 +3540,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -2744,6 +3555,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity" + }, + "examples": { + "fetch": { + "value": { + "sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f", + "links": { + "factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "new_factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "challenges": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges" + } + } + } } } }, @@ -2755,10 +3584,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEntity", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEntity" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}": { @@ -2767,7 +3593,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2775,11 +3601,14 @@ "status", "factor_type" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Entities/{Identity}" + "parent": "/Services/{ServiceSid}/Entities/{Identity}", + "pathType": "instance" }, "delete": { "description": "Delete a specific Factor.", + "tags": [ + "VerifyV2Factor" + ], "parameters": [ { "name": "ServiceSid", @@ -2800,6 +3629,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -2825,13 +3660,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFactor", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteFactor" }, "get": { "description": "Fetch a specific Factor.", + "tags": [ + "VerifyV2Factor" + ], "parameters": [ { "name": "ServiceSid", @@ -2852,6 +3687,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -2873,10 +3714,58 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.factor" - } - } - }, - "description": "OK" + }, + "examples": { + "fetchPush": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "push", + "config": { + "sdk_version": "1.0", + "app_id": "com.example.myapp", + "notification_platform": "fcm", + "notification_token": "test_token" + }, + "metadata": { + "os": "Android" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchTotp": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "totp", + "config": { + "alg": "sha1", + "skew": 1, + "code_length": 6, + "time_step": 30 + }, + "metadata": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" } }, "security": [ @@ -2884,13 +3773,13 @@ "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.", + "tags": [ + "VerifyV2Factor" + ], "parameters": [ { "name": "ServiceSid", @@ -2911,6 +3800,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -2932,6 +3827,54 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.factor" + }, + "examples": { + "verifyPush": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "verified", + "factor_type": "push", + "config": { + "sdk_version": "1.0", + "app_id": "com.example.myapp", + "notification_platform": "fcm", + "notification_token": "test_token" + }, + "metadata": { + "os": "Android" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "verifyTotp": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "verified", + "factor_type": "totp", + "config": { + "alg": "sha1", + "skew": 1, + "code_length": 6, + "time_step": 30 + }, + "metadata": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2944,9 +3887,6 @@ } ], "operationId": "UpdateFactor", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2992,6 +3932,22 @@ "description": "The transport technology used to generate the Notification Token. Can be `apn`, `fcm` or `none`.\n\nRequired when `factor_type` is `push`." } } + }, + "examples": { + "verifyPush": { + "value": { + "AuthPayload": "123456", + "FriendlyName": "FriendlyName", + "Config.SdkVersion": "1.0", + "Config.NotificationToken": "test_token" + } + }, + "verifyTotp": { + "value": { + "FriendlyName": "My Friendly Name", + "AuthPayload": "123456" + } + } } } } @@ -3004,7 +3960,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3012,11 +3968,14 @@ "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.", + "tags": [ + "VerifyV2Factor" + ], "parameters": [ { "name": "ServiceSid", @@ -3037,6 +3996,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -3082,16 +4047,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3100,17 +4067,103 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "factors": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "next_page_url": null, + "key": "factors" + } + } + }, + "readFullPush": { + "value": { + "factors": [ + { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "push", + "config": { + "sdk_version": "1.0", + "app_id": "com.example.myapp", + "notification_platform": "fcm", + "notification_token": "test_token" + }, + "metadata": { + "os": "Android" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "next_page_url": null, + "key": "factors" + } + } + }, + "readFullTotp": { + "value": { + "factors": [ + { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "totp", + "config": { + "alg": "sha1", + "skew": 1, + "code_length": 6, + "time_step": 30 + }, + "metadata": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "next_page_url": null, + "key": "factors" } } } @@ -3125,13 +4178,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListFactor", - "x-maturity": [ - "GA" - ] + "operationId": "ListFactor" }, "post": { "description": "Create a new Factor for the Entity", + "tags": [ + "VerifyV2NewFactor" + ], "parameters": [ { "name": "ServiceSid", @@ -3152,6 +4205,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -3161,6 +4220,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.new_factor" + }, + "examples": { + "createPush": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "binding": { + "alg": "ES256", + "public_key": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8GdwtibWe0kpgsFl6xPQBwhtwUEyeJkeozFmi2jiJDzxFSMwVy3kVR1h/dPVYOfgkC0EkfBRJ0J/6xW47FD5vA==" + }, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "push", + "config": { + "sdk_version": "1.0", + "app_id": "com.example.myapp", + "notification_platform": "fcm", + "notification_token": "test_token" + }, + "metadata": { + "os": "Android" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createTotp": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "binding": { + "secret": "GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ", + "uri": "otpauth://totp/test-issuer:John%E2%80%99s%20Account%20Name?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=test-issuer&algorithm=SHA1&digits=6&period=30" + }, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "totp", + "config": { + "alg": "sha1", + "skew": 1, + "code_length": 6, + "time_step": 30 + }, + "metadata": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3173,9 +4288,6 @@ } ], "operationId": "CreateNewFactor", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3246,6 +4358,32 @@ "FriendlyName", "FactorType" ] + }, + "examples": { + "createPush": { + "value": { + "FactorType": "push", + "FriendlyName": "FriendlyName", + "Binding.Alg": "ES256", + "Binding.PublicKey": "dGVzdF9rZXk=", + "Config.SdkVersion": "1.0", + "Config.AppId": "com.example.myapp", + "Config.NotificationPlatform": "fcm", + "Config.NotificationToken": "test_token", + "Metadata": "{\"os\": \"Android\"}" + } + }, + "createTotp": { + "value": { + "FactorType": "totp", + "FriendlyName": "FriendlyName", + "Binding.Secret": "GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ", + "Config.Alg": "sha1", + "Config.TimeStep": 30, + "Config.CodeLength": 6, + "Config.Skew": 1 + } + } } } } @@ -3261,7 +4399,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "form_type" @@ -3270,6 +4408,9 @@ }, "get": { "description": "Fetch the forms for a specific Form Type.", + "tags": [ + "VerifyV2Form" + ], "parameters": [ { "name": "FormType", @@ -3288,6 +4429,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.form" + }, + "examples": { + "fetch": { + "value": { + "form_type": "form-push", + "forms": { + "create_factor": {}, + "verify_factor": {}, + "create_challenge": {} + }, + "form_meta": {}, + "url": "https://verify.twilio.com/v2/Forms/form-push" + } + } } } }, @@ -3299,10 +4454,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchForm", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchForm" } }, "/v2/Services/{ServiceSid}/MessagingConfigurations": { @@ -3311,7 +4463,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -3321,11 +4473,14 @@ "date_created", "date_updated" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new MessagingConfiguration for a service.", + "tags": [ + "VerifyV2MessagingConfiguration" + ], "parameters": [ { "name": "ServiceSid", @@ -3346,6 +4501,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.messaging_configuration" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "country": "CA", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA" + } + } } } }, @@ -3358,9 +4526,6 @@ } ], "operationId": "CreateMessagingConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3377,13 +4542,21 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) to be used to send SMS to the country of this configuration." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration." } }, "required": [ "Country", "MessagingServiceSid" ] + }, + "examples": { + "create": { + "value": { + "Country": "CA", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3391,6 +4564,9 @@ }, "get": { "description": "Retrieve a list of all Messaging Configurations for a Service.", + "tags": [ + "VerifyV2MessagingConfiguration" + ], "parameters": [ { "name": "ServiceSid", @@ -3447,16 +4623,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3465,17 +4643,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "messaging_configurations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0", + "next_page_url": null, + "key": "messaging_configurations" + } + } + }, + "readFull": { + "value": { + "messaging_configurations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "country": "CA", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0", + "next_page_url": null, + "key": "messaging_configurations" } } } @@ -3490,10 +4706,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessagingConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessagingConfiguration" } }, "/v2/Services/{ServiceSid}/MessagingConfigurations/{Country}": { @@ -3502,7 +4715,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -3512,11 +4725,14 @@ "date_created", "date_updated" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update a specific MessagingConfiguration", + "tags": [ + "VerifyV2MessagingConfiguration" + ], "parameters": [ { "name": "ServiceSid", @@ -3546,6 +4762,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.messaging_configuration" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "country": "CA", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA" + } + } } } }, @@ -3558,9 +4787,6 @@ } ], "operationId": "UpdateMessagingConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3573,12 +4799,19 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) to be used to send SMS to the country of this configuration." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration." } }, "required": [ "MessagingServiceSid" ] + }, + "examples": { + "update": { + "value": { + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3586,6 +4819,9 @@ }, "get": { "description": "Fetch a specific MessagingConfiguration.", + "tags": [ + "VerifyV2MessagingConfiguration" + ], "parameters": [ { "name": "ServiceSid", @@ -3615,6 +4851,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.messaging_configuration" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "country": "CA", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA" + } + } } } }, @@ -3626,13 +4875,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessagingConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessagingConfiguration" }, "delete": { "description": "Delete a specific MessagingConfiguration.", + "tags": [ + "VerifyV2MessagingConfiguration" + ], "parameters": [ { "name": "ServiceSid", @@ -3666,10 +4915,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessagingConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessagingConfiguration" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications": { @@ -3678,7 +4924,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3686,11 +4932,14 @@ "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", + "tags": [ + "VerifyV2Notification" + ], "parameters": [ { "name": "ServiceSid", @@ -3711,6 +4960,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -3732,6 +4987,34 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.challenge.notification" + }, + "examples": { + "createWithTtl": { + "value": { + "sid": "NTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "challenge_sid": "YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "priority": "high", + "ttl": 150 + } + }, + "createWithoutTtl": { + "value": { + "sid": "NTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "challenge_sid": "YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "priority": "high", + "ttl": 300 + } + } } } }, @@ -3744,9 +5027,6 @@ } ], "operationId": "CreateNotification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3759,6 +5039,16 @@ "description": "How long, in seconds, the notification is valid. Can be an integer between 0 and 300. Default is 300. Delivery is attempted until the TTL elapses, even if the device is offline. 0 means that the notification delivery is attempted immediately, only once, and is not stored for future delivery." } } + }, + "examples": { + "createWithTtl": { + "value": { + "Ttl": 150 + } + }, + "createWithoutTtl": { + "value": {} + } } } } @@ -3771,7 +5061,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3782,14 +5072,23 @@ "date_created", "date_updated" ], - "pathType": "list", "dependentProperties": { - "bucket": "{service_sid: service_sid, rate_limit_sid: sid}" + "buckets": { + "mapping": { + "service_sid": "service_sid", + "rate_limit_sid": "sid" + }, + "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", + "tags": [ + "VerifyV2RateLimit" + ], "parameters": [ { "name": "ServiceSid", @@ -3810,6 +5109,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit" + }, + "examples": { + "createRateLimit": { + "value": { + "sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique.name", + "description": "Description", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "buckets": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets" + } + } + } } } }, @@ -3822,9 +5138,6 @@ } ], "operationId": "CreateRateLimit", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3844,6 +5157,14 @@ "required": [ "UniqueName" ] + }, + "examples": { + "createRateLimit": { + "value": { + "UniqueName": "unique.name", + "Description": "Description" + } + } } } } @@ -3851,6 +5172,9 @@ }, "get": { "description": "Retrieve a list of all Rate Limits for a service.", + "tags": [ + "VerifyV2RateLimit" + ], "parameters": [ { "name": "ServiceSid", @@ -3907,16 +5231,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3925,18 +5251,46 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readAll": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "rate_limits", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits?PageSize=50&Page=0" + }, + "rate_limits": [ + { + "sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique.name", + "description": "Description", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "buckets": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets" + } + } + ] } } } @@ -3950,10 +5304,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRateLimit", - "x-maturity": [ - "GA" - ] + "operationId": "ListRateLimit" } }, "/v2/Services/{ServiceSid}/RateLimits/{Sid}": { @@ -3962,7 +5313,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3973,14 +5324,23 @@ "date_created", "date_updated" ], - "pathType": "instance", "dependentProperties": { - "bucket": "{service_sid: service_sid, rate_limit_sid: sid}" + "buckets": { + "mapping": { + "service_sid": "service_sid", + "rate_limit_sid": "sid" + }, + "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.", + "tags": [ + "VerifyV2RateLimit" + ], "parameters": [ { "name": "ServiceSid", @@ -4013,6 +5373,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit" + }, + "examples": { + "updateRateLimit": { + "value": { + "sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique.name", + "description": "Description", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "buckets": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets" + } + } + } } } }, @@ -4025,9 +5402,6 @@ } ], "operationId": "UpdateRateLimit", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4040,6 +5414,13 @@ "description": "Description of this Rate Limit" } } + }, + "examples": { + "updateRateLimit": { + "value": { + "Description": "Description" + } + } } } } @@ -4047,6 +5428,9 @@ }, "get": { "description": "Fetch a specific Rate Limit.", + "tags": [ + "VerifyV2RateLimit" + ], "parameters": [ { "name": "ServiceSid", @@ -4079,6 +5463,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit" + }, + "examples": { + "fetchRateLimit": { + "value": { + "sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique.name", + "description": "Description", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "buckets": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets" + } + } + } } } }, @@ -4090,13 +5491,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRateLimit", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRateLimit" }, "delete": { "description": "Delete a specific Rate Limit.", + "tags": [ + "VerifyV2RateLimit" + ], "parameters": [ { "name": "ServiceSid", @@ -4133,10 +5534,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRateLimit", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRateLimit" } }, "/v2/SafeList/Numbers": { @@ -4145,23 +5543,35 @@ "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.", + "tags": [ + "VerifyV2Safelist" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.safelist" + }, + "examples": { + "create": { + "value": { + "sid": "GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+18001234567", + "url": "https://verify.twilio.com/v2/SafeList/Numbers/+18001234567" + } + } } } }, @@ -4174,9 +5584,6 @@ } ], "operationId": "CreateSafelist", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4192,6 +5599,13 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "PhoneNumber": "+18001234567" + } + } } } } @@ -4204,17 +5618,20 @@ "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.", + "tags": [ + "VerifyV2Safelist" + ], "parameters": [ { "name": "PhoneNumber", @@ -4223,6 +5640,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + }, "required": true } ], @@ -4232,6 +5655,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.safelist" + }, + "examples": { + "fetch": { + "value": { + "sid": "GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+18001234567", + "url": "https://verify.twilio.com/v2/SafeList/Numbers/+18001234567" + } + } } } }, @@ -4243,13 +5675,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSafelist", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSafelist" }, "delete": { "description": "Remove a phone number from SafeList.", + "tags": [ + "VerifyV2Safelist" + ], "parameters": [ { "name": "PhoneNumber", @@ -4258,6 +5690,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + }, "required": true } ], @@ -4271,10 +5709,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSafelist", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSafelist" } }, "/v2/Services": { @@ -4283,32 +5718,113 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { - "verification": "{service_sid: sid}", - "verification_check": "{service_sid: sid}", - "rate_limit": "{service_sid: sid}", - "messaging_configuration": "{service_sid: sid}", - "entity": "{service_sid: sid}", - "webhook": "{service_sid: sid}", - "access_token": "{service_sid: sid}" - } + "verifications": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Verifications" + }, + "verification_checks": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/VerificationCheck" + }, + "rate_limits": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/RateLimits" + }, + "messaging_configurations": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/MessagingConfigurations" + }, + "entities": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Entities" + }, + "webhooks": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Webhooks" + }, + "access_tokens": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/AccessTokens" + } + }, + "pathType": "list" }, "post": { "description": "Create a new Verification Service.", + "tags": [ + "VerifyV2Service" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service" + }, + "examples": { + "createRecord": { + "value": { + "sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "code_length": 4, + "lookup_enabled": false, + "psd2_enabled": false, + "skip_sms_to_landlines": false, + "dtmf_input_required": false, + "tts_name": "name", + "mailer_sid": "MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "do_not_share_warning_enabled": false, + "custom_code_enabled": true, + "push": { + "include_date": false, + "apn_credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fcm_credential_sid": null + }, + "totp": { + "issuer": "test-issuer", + "time_step": 30, + "code_length": 3, + "skew": 2 + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + } } } }, @@ -4321,9 +5837,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4407,11 +5920,38 @@ "maxLength": 34, "pattern": "^HJ[0-9a-fA-F]{32}$", "description": "The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only." + }, + "VerifyEventSubscriptionEnabled": { + "type": "boolean", + "description": "Whether to allow verifications from the service to reach the stream-events sinks if configured" } }, "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 + } + } } } } @@ -4419,6 +5959,9 @@ }, "get": { "description": "Retrieve a list of all Verification Services for an account.", + "tags": [ + "VerifyV2Service" + ], "parameters": [ { "name": "PageSize", @@ -4463,16 +6006,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4481,18 +6026,72 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readAll": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "services", + "url": "https://verify.twilio.com/v2/Services?PageSize=50&Page=0" + }, + "services": [ + { + "sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "code_length": 4, + "lookup_enabled": false, + "psd2_enabled": false, + "skip_sms_to_landlines": false, + "dtmf_input_required": false, + "tts_name": "name", + "mailer_sid": "MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "do_not_share_warning_enabled": false, + "custom_code_enabled": true, + "push": { + "include_date": false, + "apn_credential_sid": null, + "fcm_credential_sid": null + }, + "totp": { + "issuer": null, + "time_step": null, + "code_length": null, + "skew": null + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + ] } } } @@ -4506,10 +6105,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v2/Services/{Sid}": { @@ -4518,26 +6114,64 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { - "verification": "{service_sid: sid}", - "verification_check": "{service_sid: sid}", - "rate_limit": "{service_sid: sid}", - "messaging_configuration": "{service_sid: sid}", - "entity": "{service_sid: sid}", - "webhook": "{service_sid: sid}", - "access_token": "{service_sid: sid}" - } + "verifications": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Verifications" + }, + "verification_checks": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/VerificationCheck" + }, + "rate_limits": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/RateLimits" + }, + "messaging_configurations": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/MessagingConfigurations" + }, + "entities": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Entities" + }, + "webhooks": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/Webhooks" + }, + "access_tokens": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/v2/Services/{service_sid}/AccessTokens" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch specific Verification Service Instance.", + "tags": [ + "VerifyV2Service" + ], "parameters": [ { "name": "Sid", @@ -4558,6 +6192,49 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service" + }, + "examples": { + "fetchRecord": { + "value": { + "sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "code_length": 4, + "lookup_enabled": false, + "psd2_enabled": false, + "skip_sms_to_landlines": false, + "dtmf_input_required": false, + "tts_name": "name", + "mailer_sid": "MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "do_not_share_warning_enabled": false, + "custom_code_enabled": true, + "push": { + "include_date": false, + "apn_credential_sid": null, + "fcm_credential_sid": null + }, + "totp": { + "issuer": null, + "time_step": null, + "code_length": null, + "skew": null + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + } } } }, @@ -4569,13 +6246,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "Delete a specific Verification Service Instance.", + "tags": [ + "VerifyV2Service" + ], "parameters": [ { "name": "Sid", @@ -4600,13 +6277,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "Update a specific Verification Service.", + "tags": [ + "VerifyV2Service" + ], "parameters": [ { "name": "Sid", @@ -4627,6 +6304,49 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service" + }, + "examples": { + "updateRecord": { + "value": { + "sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "code_length": 4, + "lookup_enabled": false, + "psd2_enabled": false, + "skip_sms_to_landlines": false, + "dtmf_input_required": false, + "tts_name": "name", + "mailer_sid": "MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "do_not_share_warning_enabled": false, + "custom_code_enabled": true, + "push": { + "include_date": false, + "apn_credential_sid": null, + "fcm_credential_sid": "CRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + }, + "totp": { + "issuer": "test-issuer", + "time_step": 30, + "code_length": 3, + "skew": 2 + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + } } } }, @@ -4639,9 +6359,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4725,6 +6442,34 @@ "maxLength": 34, "pattern": "^HJ[0-9a-fA-F]{32}$", "description": "The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only." + }, + "VerifyEventSubscriptionEnabled": { + "type": "boolean", + "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 } } } @@ -4739,7 +6484,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4749,11 +6494,14 @@ "valid", "date_created" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Verification using a Service", + "tags": [ + "VerifyV2Verification" + ], "parameters": [ { "name": "ServiceSid", @@ -4774,6 +6522,178 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.verification" + }, + "examples": { + "createVerification": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "SMS", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createVerificationWhatsapp": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "whatsapp", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "whatsapp", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createVerificationEmail": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "mail@email.com", + "channel": "email", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "EMAIL", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createVerificationWithRateLimits": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "SMS", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createVerificationSna": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sna", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": { + "carrier": { + "mobile_country_code": "311", + "type": "mobile", + "error_code": null, + "mobile_network_code": "180", + "name": "T-Mobile USA, Inc." + } + }, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "sna", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": { + "url": "https://mi.dnlsrv.com/m/id/ANBByzx7?data=AAAglRRdNn02iTFWfDWwdTjOzM8o%2F6JB86fH%2Bt%2FFftUPj0pFA0u8%2FibWuYwzmMeMOtdTwYlsO8V%2FXF%2BJmngMhbeGKYhHeTOF2H9VrGEYKcEEklPxHgb5GgL3XtYa33j3lIU%2By6InvoV%2FowWHBzA0QeFPBh6vmJ8LoUPJqGE7q0PRz618Z4ym1AGq%2BaomSq9PlP4rCduv9Cmtxu%2FrvPSBwocs0GCWDE8seK8t9epmPQW7gwODxkAiKr9UxhJd9KvmBVuAQPf%2BoFQVo86USXkhXqTvUzB2bNUYY9FCy3CWgZFTOa1D3H1CVxf1eHzYIswNA7SmOzP%2FBX8g6%2B0hkzwMRkcit3gBNs4evAVJiqAgYvUlrtGwwv9bFx4X7jWSHY4%3D&cipherSalt=yANeDq09bwM38SJs" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createVerificationAuto": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sna", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": { + "carrier": { + "mobile_country_code": "311", + "type": "mobile", + "error_code": null, + "mobile_network_code": "180", + "name": "T-Mobile USA, Inc." + } + }, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "sna", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": { + "url": "https://mi.dnlsrv.com/m/id/ANBByzx7?data=AAAglRRdNn02iTFWfDWwdTjOzM8o%2F6JB86fH%2Bt%2FFftUPj0pFA0u8%2FibWuYwzmMeMOtdTwYlsO8V%2FXF%2BJmngMhbeGKYhHeTOF2H9VrGEYKcEEklPxHgb5GgL3XtYa33j3lIU%2By6InvoV%2FowWHBzA0QeFPBh6vmJ8LoUPJqGE7q0PRz618Z4ym1AGq%2BaomSq9PlP4rCduv9Cmtxu%2FrvPSBwocs0GCWDE8seK8t9epmPQW7gwODxkAiKr9UxhJd9KvmBVuAQPf%2BoFQVo86USXkhXqTvUzB2bNUYY9FCy3CWgZFTOa1D3H1CVxf1eHzYIswNA7SmOzP%2FBX8g6%2B0hkzwMRkcit3gBNs4evAVJiqAgYvUlrtGwwv9bFx4X7jWSHY4%3D&cipherSalt=yANeDq09bwM38SJs" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4786,9 +6706,6 @@ } ], "operationId": "CreateVerification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4856,12 +6773,86 @@ "DeviceIp": { "type": "string", "description": "Strongly encouraged if using the auto channel. The IP address of the client's device. If provided, it has to be a valid IPv4 or IPv6 address." + }, + "RiskCheck": { + "type": "string", + "$ref": "#/components/schemas/verification_enum_risk_check", + "description": "Risk_check overrides Fraud Prevention measures like Fraud Guard, Geo Permissions etc per verification attempt basis, allowing Verify to block traffic considered fraudulent if enabled or bypass active protections if disabled. Can be: `enable`(default) or `disable`. For SMS channel only." + }, + "Tags": { + "type": "string", + "description": "A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length." } }, "required": [ "To", "Channel" ] + }, + "examples": { + "createVerification": { + "value": { + "To": "+15017122661", + "Channel": "sms", + "CustomCode": "custom_code", + "CustomFriendlyName": "custom_friendly_name", + "CustomMessage": "custom_message", + "SendDigits": "ww1", + "Locale": "en", + "Amount": "\u20ac39.99", + "Payee": "Acme Inc.", + "AppHash": "AAAAAAAAAAA", + "TemplateSid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TemplateCustomSubstitutions": "{\"AppName\": \"MyApp\", \"Contact\":\"12345689\"}", + "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" + } + } } } } @@ -4874,7 +6865,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4884,11 +6875,14 @@ "valid", "date_created" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update a Verification status", + "tags": [ + "VerifyV2Verification" + ], "parameters": [ { "name": "ServiceSid", @@ -4918,6 +6912,58 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.verification" + }, + "examples": { + "updateVerification": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "canceled", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "SMS", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "approveVerificationWithPn": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "approved", + "valid": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "SMS", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4930,9 +6976,6 @@ } ], "operationId": "UpdateVerification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4949,6 +6992,18 @@ "required": [ "Status" ] + }, + "examples": { + "updateVerification": { + "value": { + "Status": "canceled" + } + }, + "approveVerificationWithPn": { + "value": { + "Status": "approved" + } + } } } } @@ -4956,6 +7011,9 @@ }, "get": { "description": "Fetch a specific Verification", + "tags": [ + "VerifyV2Verification" + ], "parameters": [ { "name": "ServiceSid", @@ -4985,6 +7043,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.verification" + }, + "examples": { + "fetchVerification": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "SMS", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4996,10 +7081,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVerification", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVerification" } }, "/v2/Attempts": { @@ -5008,7 +7090,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5017,16 +7099,19 @@ "conversion_status", "channel" ], - "pathType": "list", - "mountName": "verification_attempts" + "mountName": "verification_attempts", + "pathType": "list" }, "get": { "description": "List all the verification attempts for a given Account.", + "tags": [ + "VerifyV2VerificationAttempt" + ], "parameters": [ { "name": "DateCreatedAfter", "in": "query", - "description": "Datetime filter used to query Verification Attempts created after this datetime. Given as GMT in RFC 2822 format.", + "description": "Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.", "schema": { "type": "string", "format": "date-time" @@ -5035,7 +7120,7 @@ { "name": "DateCreatedBefore", "in": "query", - "description": "Datetime filter used to query Verification Attempts created before this datetime. Given as GMT in RFC 2822 format.", + "description": "Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.", "schema": { "type": "string", "format": "date-time" @@ -5047,6 +7132,12 @@ "description": "Destination of a verification. It is phone number in E.164 format.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -5141,16 +7232,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5159,17 +7252,74 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "listVerificationAttemptsEmpty": { + "value": { + "attempts": [], + "meta": { + "key": "attempts", + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0", + "next_page_url": null + } + } + }, + "listVerificationAttempts": { + "value": { + "attempts": [ + { + "sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-08-11T18:36:59Z", + "date_updated": "2020-08-11T18:37:00Z", + "conversion_status": "unconverted", + "channel": "sms", + "price": { + "value": "0.005", + "currency": "usd" + }, + "channel_data": { + "verification_sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+573003003030", + "status": "unconfirmed", + "message_status": "undelivered", + "error_code": "30008", + "country": "CO", + "code_length": 6, + "locale": "es", + "mcc": "732", + "mnc": "103", + "carrier": "Colombia Movil (Tigo)" + }, + "url": "https://verify.twilio.com/v2/Attempts/VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "key": "attempts", + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0", + "next_page_url": null } } } @@ -5184,10 +7334,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVerificationAttempt", - "x-maturity": [ - "GA" - ] + "operationId": "ListVerificationAttempt" } }, "/v2/Attempts/{Sid}": { @@ -5196,7 +7343,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5205,11 +7352,14 @@ "conversion_status", "channel" ], - "pathType": "instance", - "mountName": "verification_attempts" + "mountName": "verification_attempts", + "pathType": "instance" }, "get": { "description": "Fetch a specific verification attempt.", + "tags": [ + "VerifyV2VerificationAttempt" + ], "parameters": [ { "name": "Sid", @@ -5230,6 +7380,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.verification_attempt" + }, + "examples": { + "fetchVerificationAttempt": { + "value": { + "sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-08-11T18:36:59Z", + "date_updated": "2020-08-11T18:37:00Z", + "conversion_status": "unconverted", + "channel": "sms", + "price": { + "value": "0.005", + "currency": "usd" + }, + "channel_data": { + "verification_sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+573003003030", + "status": "unconfirmed", + "message_status": "undelivered", + "error_code": "30008", + "country": "CO", + "code_length": 6, + "locale": "es", + "mcc": "732", + "mnc": "103", + "carrier": "Colombia Movil (Tigo)" + }, + "url": "https://verify.twilio.com/v2/Attempts/VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5241,10 +7423,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVerificationAttempt", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVerificationAttempt" } }, "/v2/Attempts/Summary": { @@ -5253,7 +7432,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "total_attempts", @@ -5261,11 +7440,14 @@ "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.", + "tags": [ + "VerifyV2VerificationAttemptsSummary" + ], "parameters": [ { "name": "VerifyServiceSid", @@ -5276,24 +7458,39 @@ "minLength": 34, "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$" + }, + "examples": { + "getAttemptsSummary": { + "value": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { "name": "DateCreatedAfter", "in": "query", - "description": "Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in RFC 2822 format.", + "description": "Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.", "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "getAttemptsSummary": { + "value": "2022-03-02T21:02:33Z" + } } }, { "name": "DateCreatedBefore", "in": "query", - "description": "Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in RFC 2822 format.", + "description": "Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.", "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "getAttemptsSummary": { + "value": "2022-03-02T21:02:33Z" + } } }, { @@ -5303,15 +7500,25 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "getAttemptsSummary": { + "value": "CO" + } } }, { "name": "Channel", "in": "query", - "description": "Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS` and `CALL`", + "description": "Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP`", "schema": { "type": "string", "$ref": "#/components/schemas/verification_attempts_summary_enum_channels" + }, + "examples": { + "getAttemptsSummary": { + "value": "sms" + } } }, { @@ -5320,6 +7527,11 @@ "description": "Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.", "schema": { "type": "string" + }, + "examples": { + "getAttemptsSummary": { + "value": "+57305" + } } } ], @@ -5329,6 +7541,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.verification_attempts_summary" + }, + "examples": { + "getAttemptsSummary": { + "value": { + "total_attempts": 11, + "total_converted": 9, + "total_unconverted": 2, + "conversion_rate_percentage": "81.818181818", + "url": "https://verify.twilio.com/v2/Attempts/Summary" + } + } } } }, @@ -5340,10 +7563,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVerificationAttemptsSummary", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVerificationAttemptsSummary" } }, "/v2/Services/{ServiceSid}/VerificationCheck": { @@ -5352,7 +7572,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5362,12 +7582,15 @@ "valid", "date_created" ], - "pathType": "list", "parent": "/Services/{Sid}", - "mountName": "verification_checks" + "mountName": "verification_checks", + "pathType": "list" }, "post": { "description": "challenge a specific Verification Check.", + "tags": [ + "VerifyV2VerificationCheck" + ], "parameters": [ { "name": "ServiceSid", @@ -5388,6 +7611,61 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.verification_check" + }, + "examples": { + "verificationChecks": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "approved", + "valid": true, + "amount": null, + "payee": null, + "sna_attempts_error_codes": [], + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + }, + "emailVerificationChecks": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "recipient@foo.com", + "channel": "email", + "status": "approved", + "valid": true, + "amount": null, + "payee": null, + "sna_attempts_error_codes": [], + "date_created": "2020-01-30T20:00:00Z", + "date_updated": "2020-01-30T20:00:00Z" + } + }, + "snaVerificationChecks": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sna", + "status": "approved", + "valid": true, + "amount": null, + "payee": null, + "sna_attempts_error_codes": [ + { + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "code": 60001 + } + ], + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -5400,9 +7678,6 @@ } ], "operationId": "CreateVerificationCheck", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5434,6 +7709,29 @@ "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." } } + }, + "examples": { + "verificationChecks": { + "value": { + "To": "+15017122661", + "VerificationSid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Code": "1234", + "Amount": "\u20ac39.99", + "Payee": "Acme Inc." + } + }, + "emailVerificationChecks": { + "value": { + "To": "recipient@foo.com", + "VerificationSid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Code": "123456" + } + }, + "snaVerificationChecks": { + "value": { + "To": "+15017122661" + } + } } } } @@ -5446,7 +7744,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5456,6 +7754,9 @@ }, "get": { "description": "List all the available templates for a given Account.", + "tags": [ + "VerifyV2Template" + ], "parameters": [ { "name": "FriendlyName", @@ -5508,16 +7809,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5526,17 +7829,69 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "listVerificationTemplates": { + "value": { + "templates": [ + { + "sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Base Verification Template 2 with do not share", + "channels": [ + "sms" + ], + "translations": { + "en": { + "is_default_translation": true, + "status": "approved", + "locale": "en", + "text": "Your {{friendly_name}} verification code is: {{code}}. Do not share this code with anyone.", + "date_updated": "2021-07-29T20:38:28.759979905Z", + "date_created": "2021-07-29T20:38:28.165602325Z" + } + } + }, + { + "sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Base Verification Template 3", + "channels": [ + "sms", + "voice" + ], + "translations": { + "en": { + "is_default_translation": true, + "status": "approved", + "locale": "en", + "text": "Your verification code is: {{code}}. Do not share it.", + "date_updated": "2021-07-29T20:38:28.759979905Z", + "date_created": "2021-07-29T20:38:28.165602325Z" + } + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Templates?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Templates?PageSize=50&Page=0", + "next_page_url": null, + "key": "templates" } } } @@ -5551,10 +7906,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVerificationTemplate", - "x-maturity": [ - "GA" - ] + "operationId": "ListVerificationTemplate" } }, "/v2/Services/{ServiceSid}/Webhooks": { @@ -5563,7 +7915,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5575,11 +7927,14 @@ "status", "date_created" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Webhook for the Service", + "tags": [ + "VerifyV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -5600,6 +7955,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.webhook" + }, + "examples": { + "create": { + "value": { + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "event_types": [ + "factor.deleted", + "factor.verified" + ], + "webhook_method": "POST", + "webhook_url": "https://owlbank.twilio.com", + "status": "enabled", + "version": "v2", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -5612,9 +7988,6 @@ } ], "operationId": "CreateWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5653,6 +8026,19 @@ "EventTypes", "WebhookUrl" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "name", + "EventTypes": [ + "factor.deleted", + "factor.verified" + ], + "WebhookUrl": "https://owlbank.twilio.com", + "Version": "v2" + } + } } } } @@ -5660,6 +8046,9 @@ }, "get": { "description": "Retrieve a list of all Webhooks for a Service.", + "tags": [ + "VerifyV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -5716,16 +8105,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5734,17 +8125,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "webhooks": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "next_page_url": null, + "key": "webhooks" + } + } + }, + "readFull": { + "value": { + "webhooks": [ + { + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "event_types": [ + "factor.deleted", + "factor.verified" + ], + "webhook_method": "POST", + "webhook_url": "https://owlbank.twilio.com", + "status": "enabled", + "version": "v2", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "next_page_url": null, + "key": "webhooks" } } } @@ -5759,10 +8196,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListWebhook" } }, "/v2/Services/{ServiceSid}/Webhooks/{Sid}": { @@ -5771,7 +8205,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5783,11 +8217,14 @@ "status", "date_created" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "", + "tags": [ + "VerifyV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -5820,6 +8257,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.webhook" + }, + "examples": { + "update": { + "value": { + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "event_types": [ + "factor.deleted", + "factor.verified" + ], + "webhook_method": "POST", + "webhook_url": "https://owlbank.twilio.com", + "status": "disabled", + "version": "v2", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -5832,9 +8290,6 @@ } ], "operationId": "UpdateWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5868,6 +8323,20 @@ "description": "The webhook version. Default value is `v2` which includes all the latest fields. Version `v1` is legacy and may be removed in the future." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "name", + "EventTypes": [ + "factor.deleted", + "factor.verified" + ], + "WebhookUrl": "https://owlbank.twilio.com", + "Status": "disabled", + "Version": "v2" + } + } } } } @@ -5875,6 +8344,9 @@ }, "delete": { "description": "Delete a specific Webhook.", + "tags": [ + "VerifyV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -5911,13 +8383,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWebhook" }, "get": { "description": "Fetch a specific Webhook.", + "tags": [ + "VerifyV2Webhook" + ], "parameters": [ { "name": "ServiceSid", @@ -5950,6 +8422,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.webhook" + }, + "examples": { + "fetch": { + "value": { + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "event_types": [ + "factor.deleted", + "factor.verified" + ], + "webhook_method": "POST", + "webhook_url": "https://owlbank.twilio.com", + "status": "enabled", + "version": "v2", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -5961,10 +8454,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWebhook" } } }, @@ -5973,14 +8463,65 @@ "url": "https://verify.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "VerifyV2AccessToken" + }, { - "name": "GA", - "description": "This product is Generally Available." + "name": "VerifyV2Bucket" }, { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "name": "VerifyV2Challenge" + }, + { + "name": "VerifyV2Entity" + }, + { + "name": "VerifyV2Factor" + }, + { + "name": "VerifyV2Form" + }, + { + "name": "VerifyV2MessagingConfiguration" + }, + { + "name": "VerifyV2NewFactor" + }, + { + "name": "VerifyV2Notification" + }, + { + "name": "VerifyV2RateLimit" + }, + { + "name": "VerifyV2Safelist" + }, + { + "name": "VerifyV2Service" + }, + { + "name": "VerifyV2Template" + }, + { + "name": "VerifyV2Verification" + }, + { + "name": "VerifyV2VerificationAttempt" + }, + { + "name": "VerifyV2VerificationAttemptsSummary" + }, + { + "name": "VerifyV2VerificationCheck" + }, + { + "name": "VerifyV2Webhook" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_video_v1.json b/spec/json/twilio_video_v1.json index 3923496e..60a47108 100644 --- a/spec/json/twilio_video_v1.json +++ b/spec/json/twilio_video_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "video.v1.composition": { "type": "object", @@ -58,7 +64,13 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to include in the composition. The composition includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`." + "description": "The array of track names to include in the composition. The composition includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "audio_sources_excluded": { "type": "array", @@ -66,11 +78,23 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to exclude from the composition. The composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty." + "description": "The array of track names to exclude from the composition. The composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "video_layout": { "nullable": true, - "description": "An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." + "description": "An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "resolution": { "type": "string", @@ -208,7 +232,13 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to include in the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request" + "description": "The array of track names to include in the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "audio_sources_excluded": { "type": "array", @@ -216,11 +246,23 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to exclude from the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty." + "description": "The array of track names to exclude from the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "video_layout": { "nullable": true, - "description": "A JSON object that describes the video layout of the composition in terms of regions as specified in the HTTP POST request that created the CompositionHook resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request" + "description": "A JSON object that describes the video layout of the composition in terms of regions as specified in the HTTP POST request that created the CompositionHook resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "resolution": { "type": "string", @@ -301,7 +343,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the AWS S3 bucket where the compositions are stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986." + "description": "The URL of the AWS S3 bucket where the compositions are stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "aws_storage_enabled": { "type": "boolean", @@ -410,7 +452,13 @@ "track_name": { "type": "string", "nullable": true, - "description": "The name that was given to the source track of the recording. If no name is given, the `source_sid` is used." + "description": "The name that was given to the source track of the recording. If no name is given, the `source_sid` is used.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "offset": { "type": "integer", @@ -513,7 +561,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the AWS S3 bucket where the recordings are stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986." + "description": "The URL of the AWS S3 bucket where the recordings are stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "aws_storage_enabled": { "type": "boolean", @@ -657,7 +705,7 @@ "media_region": { "type": "string", "nullable": true, - "description": "The region for the media server in Group Rooms. Can be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-address-whitelisting#media-servers). ***This feature is not available in `peer-to-peer` rooms.***" + "description": "The region for the media server in Group Rooms. Can be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#media-servers). ***This feature is not available in `peer-to-peer` rooms.***" }, "audio_only": { "type": "boolean", @@ -1297,12 +1345,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1318,7 +1360,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1336,13 +1378,21 @@ "resolution", "format" ], - "pathType": "instance", "dependentProperties": { - "video/v1/composition_media": "{composition_sid: sid}" - } + "media": { + "mapping": { + "composition_sid": "sid" + }, + "resource_url": "/v1/Compositions/{composition_sid}/Media" + } + }, + "pathType": "instance" }, "get": { "description": "Returns a single Composition resource identified by a Composition SID.", + "tags": [ + "VideoV1Composition" + ], "parameters": [ { "name": "Sid", @@ -1363,6 +1413,74 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "date_created": "2015-07-30T20:00:00Z", + "date_completed": "2015-07-30T20:01:33Z", + "date_deleted": null, + "sid": "CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user*" + ], + "audio_sources_excluded": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "video_layout": { + "grid": { + "video_sources": [ + "*" + ], + "video_sources_excluded": [ + "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + }, + "pip": { + "video_sources": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "video_sources_excluded": [], + "reuse": "none", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + } + }, + "resolution": "1280x720", + "format": "webm", + "bitrate": 64, + "size": 4, + "duration": 6, + "trim": true, + "media_external_location": null, + "encryption_key": null, + "url": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status_callback": "https://mycallbackurl.com", + "status_callback_method": "POST", + "links": { + "media": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + } } } }, @@ -1374,13 +1492,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchComposition", - "x-maturity": [ - "GA" - ] + "operationId": "FetchComposition" }, "delete": { "description": "Delete a Recording Composition resource identified by a Composition SID.", + "tags": [ + "VideoV1Composition" + ], "parameters": [ { "name": "Sid", @@ -1405,10 +1523,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteComposition", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteComposition" } }, "/v1/Compositions": { @@ -1425,13 +1540,21 @@ "resolution", "format" ], - "pathType": "list", "dependentProperties": { - "video/v1/composition_media": "{composition_sid: sid}" - } + "media": { + "mapping": { + "composition_sid": "sid" + }, + "resource_url": "/v1/Compositions/{composition_sid}/Media" + } + }, + "pathType": "list" }, "get": { "description": "List of all Recording compositions.", + "tags": [ + "VideoV1Composition" + ], "parameters": [ { "name": "Status", @@ -1440,6 +1563,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/composition_enum_status" + }, + "examples": { + "readEnqueued": { + "value": "enqueued" + }, + "readEmpty": { + "value": "completed" + }, + "readResults": { + "value": "completed" + } } }, { @@ -1449,6 +1583,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -1458,6 +1597,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -1469,6 +1613,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$" + }, + "examples": { + "readResults": { + "value": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1514,16 +1663,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1532,17 +1683,120 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEnqueued": { + "value": { + "compositions": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://video.twilio.com/v1/Compositions?Status=enqueued&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Compositions?Status=enqueued&PageSize=10&Page=0", + "next_page_url": null, + "key": "compositions" + } + } + }, + "readEmpty": { + "value": { + "compositions": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Compositions?Status=completed&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Compositions?Status=completed&PageSize=50&Page=0", + "next_page_url": null, + "key": "compositions" + } + } + }, + "readResults": { + "value": { + "compositions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "date_created": "2015-07-30T20:00:00Z", + "date_completed": "2015-07-30T20:01:33Z", + "date_deleted": null, + "sid": "CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user*" + ], + "audio_sources_excluded": [], + "video_layout": { + "grid": { + "video_sources": [ + "user*" + ], + "video_sources_excluded": [], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + }, + "pip": { + "video_sources": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "video_sources_excluded": [], + "reuse": "none", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + } + }, + "resolution": "1280x720", + "format": "webm", + "bitrate": 64, + "size": 4, + "duration": 6, + "trim": true, + "media_external_location": null, + "encryption_key": null, + "url": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status_callback": "https://mycallbackurl.com", + "status_callback_method": "POST", + "links": { + "media": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Compositions?Status=completed&RoomSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Compositions?Status=completed&RoomSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&PageSize=50&Page=0", + "next_page_url": null, + "key": "compositions" } } } @@ -1557,19 +1811,75 @@ "accountSid_authToken": [] } ], - "operationId": "ListComposition", - "x-maturity": [ - "GA" - ] + "operationId": "ListComposition" }, "post": { "description": "", + "tags": [ + "VideoV1Composition" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "processing", + "date_created": "2015-07-30T20:00:00Z", + "date_completed": null, + "date_deleted": null, + "sid": "CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user*" + ], + "audio_sources_excluded": [ + "RTbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "video_layout": { + "custom": { + "video_sources": [ + "user*" + ], + "video_sources_excluded": [ + "RTcaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 800, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [ + 2, + 3 + ] + } + }, + "trim": true, + "format": "mp4", + "resolution": "1920x1080", + "bitrate": 0, + "size": 0, + "duration": 0, + "media_external_location": null, + "encryption_key": null, + "url": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status_callback": "https://mycallbackurl.com", + "status_callback_method": "POST", + "links": { + "media": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + } } } }, @@ -1582,9 +1892,6 @@ } ], "operationId": "CreateComposition", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1651,6 +1958,24 @@ "required": [ "RoomSid" ] + }, + "examples": { + "create": { + "value": { + "RoomSid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AudioSources": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user*" + ], + "AudioSourcesExcluded": [ + "RTbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "VideoLayout": "{}", + "Trim": true, + "Format": "mp4", + "Resolution": "1920x1080" + } + } } } } @@ -1674,6 +1999,9 @@ }, "get": { "description": "Returns a single CompositionHook resource identified by a CompositionHook SID.", + "tags": [ + "VideoV1CompositionHook" + ], "parameters": [ { "name": "Sid", @@ -1694,6 +2022,64 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_hook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My composition hook", + "enabled": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "user*" + ], + "audio_sources_excluded": [ + "moderator*" + ], + "video_layout": { + "grid": { + "video_sources": [ + "*" + ], + "video_sources_excluded": [ + "moderator*" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + }, + "pip": { + "video_sources": [ + "student*" + ], + "video_sources_excluded": [], + "reuse": "none", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + } + }, + "resolution": "1280x720", + "format": "webm", + "trim": true, + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1705,13 +2091,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCompositionHook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCompositionHook" }, "delete": { "description": "Delete a Recording CompositionHook resource identified by a `CompositionHook SID`.", + "tags": [ + "VideoV1CompositionHook" + ], "parameters": [ { "name": "Sid", @@ -1736,13 +2122,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCompositionHook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCompositionHook" }, "post": { "description": "", + "tags": [ + "VideoV1CompositionHook" + ], "parameters": [ { "name": "Sid", @@ -1763,6 +2149,77 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_hook" + }, + "examples": { + "updateAllFields": { + "value": { + "friendly_name": "My composition hook", + "enabled": true, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "user*", + "moderator" + ], + "audio_sources_excluded": [ + "admin" + ], + "video_layout": { + "custom": { + "video_sources": [ + "user*" + ], + "video_sources_excluded": [ + "moderator" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 800, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [ + 2, + 3 + ] + } + }, + "trim": true, + "format": "mp4", + "resolution": "1280x720", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateWithDefaults": { + "value": { + "friendly_name": "My composition hook", + "enabled": true, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "user*", + "moderator" + ], + "audio_sources_excluded": [ + "admin" + ], + "video_layout": {}, + "trim": true, + "format": "mp4", + "resolution": "1280x720", + "status_callback": null, + "status_callback_method": "POST", + "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1775,9 +2232,6 @@ } ], "operationId": "UpdateCompositionHook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1845,6 +2299,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" + } + } } } } @@ -1868,6 +2357,9 @@ }, "get": { "description": "List of all Recording CompositionHook resources.", + "tags": [ + "VideoV1CompositionHook" + ], "parameters": [ { "name": "Enabled", @@ -1875,6 +2367,14 @@ "description": "Read only CompositionHook resources with an `enabled` value that matches this parameter.", "schema": { "type": "boolean" + }, + "examples": { + "readEmpty": { + "value": true + }, + "readResults": { + "value": true + } } }, { @@ -1884,6 +2384,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -1893,6 +2398,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -1901,6 +2411,11 @@ "description": "Read only CompositionHook resources with friendly names that match this string. The match is not case sensitive and can include asterisk `*` characters as wildcard match.", "schema": { "type": "string" + }, + "examples": { + "readResults": { + "value": "*Hook*" + } } }, { @@ -1946,16 +2461,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1964,17 +2481,98 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "composition_hooks": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/CompositionHooks?Enabled=True&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/CompositionHooks?Enabled=True&PageSize=50&Page=0", + "next_page_url": null, + "key": "composition_hooks" + } + } + }, + "readResults": { + "value": { + "composition_hooks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My Special Hook1", + "enabled": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "*" + ], + "audio_sources_excluded": [], + "video_layout": { + "grid": { + "video_sources": [ + "*" + ], + "video_sources_excluded": [ + "moderator*" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + }, + "pip": { + "video_sources": [ + "student*" + ], + "video_sources_excluded": [], + "reuse": "none", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + } + }, + "resolution": "1280x720", + "format": "webm", + "trim": true, + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/CompositionHooks?FriendlyName=%2AHook%2A&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&Enabled=True&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/CompositionHooks?FriendlyName=%2AHook%2A&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&Enabled=True&PageSize=50&Page=0", + "next_page_url": null, + "key": "composition_hooks" } } } @@ -1989,19 +2587,66 @@ "accountSid_authToken": [] } ], - "operationId": "ListCompositionHook", - "x-maturity": [ - "GA" - ] + "operationId": "ListCompositionHook" }, "post": { "description": "", + "tags": [ + "VideoV1CompositionHook" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_hook" + }, + "examples": { + "create": { + "value": { + "friendly_name": "My composition hook", + "enabled": false, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": null, + "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "user*", + "moderator" + ], + "audio_sources_excluded": [ + "admin" + ], + "video_layout": { + "custom": { + "video_sources": [ + "user*" + ], + "video_sources_excluded": [ + "moderator" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 800, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [ + 2, + 3 + ] + } + }, + "trim": true, + "format": "mp4", + "resolution": "1280x720", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2014,9 +2659,6 @@ } ], "operationId": "CreateCompositionHook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2084,6 +2726,27 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "My composition hook", + "Enabled": false, + "AudioSources": [ + "user*", + "moderator" + ], + "AudioSourcesExcluded": [ + "admin" + ], + "VideoLayout": "{}", + "Trim": true, + "Format": "mp4", + "Resolution": "1280x720", + "StatusCallback": "http://www.example.com", + "StatusCallbackMethod": "POST" + } + } } } } @@ -2103,18 +2766,35 @@ "aws_storage_enabled", "encryption_enabled" ], - "pathType": "instance", "mountName": "composition_settings", - "className": "composition_settings" + "className": "composition_settings", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "VideoV1CompositionSettings" + ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_settings" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "string", + "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "aws_storage_enabled": true, + "encryption_enabled": true, + "url": "https://video.twilio.com/v1/CompositionSettings/Default" + } + } } } }, @@ -2126,19 +2806,33 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCompositionSettings", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCompositionSettings" }, "post": { "description": "", + "tags": [ + "VideoV1CompositionSettings" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_settings" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "aws_storage_enabled": true, + "encryption_enabled": true, + "url": "https://video.twilio.com/v1/CompositionSettings/Default" + } + } } } }, @@ -2151,9 +2845,6 @@ } ], "operationId": "CreateCompositionSettings", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2182,7 +2873,7 @@ "AwsS3Url": { "type": "string", "format": "uri", - "description": "The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986." + "description": "The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "AwsStorageEnabled": { "type": "boolean", @@ -2196,6 +2887,18 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "AwsCredentialsSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "EncryptionKeySid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "AwsS3Url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "AwsStorageEnabled": true, + "EncryptionEnabled": true + } + } } } } @@ -2218,13 +2921,21 @@ "duration", "codec" ], - "pathType": "instance", "dependentProperties": { - "video/v1/recording_media": "{recording_sid: sid}" - } + "media": { + "mapping": { + "recording_sid": "sid" + }, + "resource_url": "/v1/Recordings/{recording_sid}/Media" + } + }, + "pathType": "instance" }, "get": { "description": "Returns a single Recording resource identified by a Recording SID.", + "tags": [ + "VideoV1Recording" + ], "parameters": [ { "name": "Sid", @@ -2245,6 +2956,37 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "processing", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T21:00:00Z", + "date_deleted": "2015-07-30T22:00:00Z", + "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 0, + "url": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "audio", + "duration": 0, + "container_format": "mka", + "codec": "OPUS", + "track_name": "A name", + "offset": 10, + "status_callback": "https://mycallbackurl.com", + "status_callback_method": "POST", + "grouping_sids": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "encryption_key": "public_key", + "links": { + "media": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + } } } }, @@ -2256,13 +2998,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecording" }, "delete": { "description": "Delete a Recording resource identified by a Recording SID.", + "tags": [ + "VideoV1Recording" + ], "parameters": [ { "name": "Sid", @@ -2287,10 +3029,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecording" } }, "/v1/Recordings": { @@ -2309,13 +3048,21 @@ "duration", "codec" ], - "pathType": "list", "dependentProperties": { - "video/v1/recording_media": "{recording_sid: sid}" - } + "media": { + "mapping": { + "recording_sid": "sid" + }, + "resource_url": "/v1/Recordings/{recording_sid}/Media" + } + }, + "pathType": "list" }, "get": { "description": "List of all Track recordings.", + "tags": [ + "VideoV1Recording" + ], "parameters": [ { "name": "Status", @@ -2324,6 +3071,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/recording_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + }, + "readResults": { + "value": "completed" + } } }, { @@ -2335,6 +3090,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "source_sid" + }, + "readResults": { + "value": "source_sid" + } } }, { @@ -2349,6 +3112,19 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" } + }, + "examples": { + "readEmpty": { + "value": [ + "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "readResults": { + "value": [ + "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } } }, { @@ -2358,6 +3134,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -2367,6 +3148,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -2376,6 +3162,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/recording_enum_type" + }, + "examples": { + "readEmpty": { + "value": "audio" + }, + "readResults": { + "value": "audio" + } } }, { @@ -2421,16 +3215,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2439,17 +3235,74 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "recordings": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Recordings?Status=completed&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Recordings?Status=completed&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "recordings" + } + } + }, + "readResults": { + "value": { + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T21:00:00Z", + "date_deleted": "2015-07-30T22:00:00Z", + "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 23, + "type": "audio", + "duration": 10, + "container_format": "mka", + "codec": "OPUS", + "track_name": "A name", + "offset": 10, + "status_callback": "https://mycallbackurl.com", + "status_callback_method": "POST", + "grouping_sids": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "encryption_key": "public_key", + "url": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "media": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Recordings?Status=completed&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Recordings?Status=completed&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "recordings" } } } @@ -2464,10 +3317,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecording" } }, "/v1/RecordingSettings/Default": { @@ -2483,18 +3333,35 @@ "aws_storage_enabled", "encryption_enabled" ], - "pathType": "instance", "mountName": "recording_settings", - "className": "recording_settings" + "className": "recording_settings", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "VideoV1RecordingSettings" + ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.recording_settings" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "string", + "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "aws_storage_enabled": true, + "encryption_enabled": true, + "url": "https://video.twilio.com/v1/RecordingSettings/Default" + } + } } } }, @@ -2506,19 +3373,33 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingSettings", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingSettings" }, "post": { "description": "", + "tags": [ + "VideoV1RecordingSettings" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.recording_settings" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "aws_storage_enabled": true, + "encryption_enabled": true, + "url": "https://video.twilio.com/v1/RecordingSettings/Default" + } + } } } }, @@ -2531,9 +3412,6 @@ } ], "operationId": "CreateRecordingSettings", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2562,7 +3440,7 @@ "AwsS3Url": { "type": "string", "format": "uri", - "description": "The URL of the AWS S3 bucket where the recordings should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986." + "description": "The URL of the AWS S3 bucket where the recordings should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "AwsStorageEnabled": { "type": "boolean", @@ -2576,6 +3454,18 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "AwsCredentialsSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "EncryptionKeySid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "AwsS3Url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "AwsStorageEnabled": true, + "EncryptionEnabled": true + } + } } } } @@ -2595,15 +3485,33 @@ "unique_name", "status" ], - "pathType": "instance", "dependentProperties": { - "room_recording": "{room_sid: sid}", - "participant": "{room_sid: sid}", - "recording_rules": "{room_sid: sid}" - } + "recordings": { + "mapping": { + "room_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Recordings" + }, + "participants": { + "mapping": { + "room_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Participants" + }, + "recording_rules": { + "mapping": { + "room_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/RecordingRules" + } + }, + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "VideoV1Room" + ], "parameters": [ { "name": "Sid", @@ -2621,6 +3529,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "peer-to-peer", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "unique_name", + "max_participants": 10, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 0, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "audio_only": false, + "media_region": "us1", + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + } } } }, @@ -2632,13 +3576,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoom", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoom" }, "post": { "description": "", + "tags": [ + "VideoV1Room" + ], "parameters": [ { "name": "Sid", @@ -2656,6 +3600,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "completed", + "type": "peer-to-peer", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "unique_name", + "max_participants": 10, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 10, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "duration": 10, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + } } } }, @@ -2668,9 +3648,6 @@ } ], "operationId": "UpdateRoom", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2687,6 +3664,13 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "completed" + } + } } } } @@ -2706,21 +3690,275 @@ "unique_name", "status" ], - "pathType": "list", "dependentProperties": { - "room_recording": "{room_sid: sid}", - "participant": "{room_sid: sid}", - "recording_rules": "{room_sid: sid}" - } + "recordings": { + "mapping": { + "room_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Recordings" + }, + "participants": { + "mapping": { + "room_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Participants" + }, + "recording_rules": { + "mapping": { + "room_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/RecordingRules" + } + }, + "pathType": "list" }, "post": { "description": "", + "tags": [ + "VideoV1Room" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "peer-to-peer", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "max_concurrent_published_tracks": 0, + "max_participants": 10, + "max_participant_duration": 86400, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createWebrtcGo": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "go", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "room1", + "max_participants": 10, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 0, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createGroupRooms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "group", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "grouproom", + "max_participants": 50, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 170, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createGroupRoomsWithAudioOnlyEnabled": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "group", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "grouproom", + "max_participants": 50, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 170, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [], + "media_region": "us1", + "audio_only": true, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createSmallGroupRooms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "group-small", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "SmallDailyStandup", + "max_participants": 4, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 170, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createLargeGroupRooms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "group", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "MyWebinar", + "max_participants": 50, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 16, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createLargeGroupRoomsWithAudioOnlyEnabled": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "group", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "MyWebinar", + "max_participants": 50, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 16, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [], + "media_region": "us1", + "audio_only": true, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + } } } }, @@ -2733,9 +3971,6 @@ } ], "operationId": "CreateRoom", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2792,7 +4027,7 @@ }, "MediaRegion": { "type": "string", - "description": "The region for the media server in Group Rooms. Can be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-address-whitelisting#group-rooms-media-servers). ***This feature is not available in `peer-to-peer` rooms.***" + "description": "The region for the media server in Group Rooms. Can be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#group-rooms-media-servers). ***This feature is not available in `peer-to-peer` rooms.***" }, "RecordingRules": { "description": "A collection of Recording Rules that describe how to include or exclude matching tracks for recording" @@ -2818,6 +4053,53 @@ "description": "When set to true, indicated that this is the large room." } } + }, + "examples": { + "create": { + "value": {} + }, + "createWebrtcGo": { + "value": { + "Type": "go", + "UniqueName": "room1" + } + }, + "createGroupRooms": { + "value": { + "Type": "group", + "UniqueName": "grouproom", + "RecordingRules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D" + } + }, + "createGroupRoomsWithAudioOnlyEnabled": { + "value": { + "Type": "group", + "UniqueName": "grouproom", + "RecordingRules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D", + "AudioOnly": true + } + }, + "createSmallGroupRooms": { + "value": { + "Type": "group-small", + "UniqueName": "SmallDailyStandup" + } + }, + "createLargeGroupRooms": { + "value": { + "Type": "group", + "UniqueName": "MyWebinar", + "MaxParticipants": 90 + } + }, + "createLargeGroupRoomsWithAudioOnlyEnabled": { + "value": { + "Type": "group", + "UniqueName": "MyWebinar", + "MaxParticipants": 90, + "AudioOnly": true + } + } } } } @@ -2825,6 +4107,9 @@ }, "get": { "description": "", + "tags": [ + "VideoV1Room" + ], "parameters": [ { "name": "Status", @@ -2833,6 +4118,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/room_enum_room_status" + }, + "examples": { + "readWithStatus": { + "value": "completed" + } } }, { @@ -2904,16 +4194,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2922,17 +4214,78 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "rooms": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms?PageSize=50&Page=0", + "next_page_url": null, + "key": "rooms" + } + } + }, + "readWithStatus": { + "value": { + "rooms": [ + { + "sid": "RM4070b618362c1682b2385b1f9982833c", + "status": "completed", + "date_created": "2017-04-03T22:21:49Z", + "date_updated": "2017-04-03T22:21:51Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "peer-to-peer", + "enable_turn": true, + "unique_name": "RM4070b618362c1682b2385b1f9982833c", + "status_callback": null, + "status_callback_method": "POST", + "end_time": "2017-04-03T22:21:51Z", + "duration": 2, + "max_participants": 10, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 10, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/RecordingRules" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms?Status=completed&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms?Status=completed&PageSize=50&Page=0", + "next_page_url": null, + "key": "rooms" } } } @@ -2947,10 +4300,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoom", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoom" } }, "/v1/Rooms/{RoomSid}/Participants/{Sid}": { @@ -2966,17 +4316,44 @@ "identity", "status" ], - "pathType": "instance", "dependentProperties": { - "published_track": "{room_sid: room_sid, participant_sid: sid}", - "subscribed_track": "{room_sid: room_sid, participant_sid: sid}", - "subscribe_rules": "{room_sid: room_sid, participant_sid: sid}", - "anonymize": "{room_sid: room_sid, sid: sid}" + "published_tracks": { + "mapping": { + "room_sid": "room_sid", + "participant_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/PublishedTracks" + }, + "subscribed_tracks": { + "mapping": { + "room_sid": "room_sid", + "participant_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribedTracks" + }, + "subscribe_rules": { + "mapping": { + "room_sid": "room_sid", + "participant_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribeRules" + }, + "anonymize": { + "mapping": { + "room_sid": "room_sid", + "sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Participants/{sid}/Anonymize" + } }, - "parent": "/Rooms/{Sid}" + "parent": "/Rooms/{Sid}", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "VideoV1Participant" + ], "parameters": [ { "name": "RoomSid", @@ -3003,6 +4380,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "start_time": "2015-07-30T20:00:00Z", + "end_time": null, + "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob", + "status": "connected", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "duration": null, + "links": { + "published_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks", + "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks", + "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules", + "anonymize": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize" + } + } + } } } }, @@ -3014,13 +4414,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipant" }, "post": { "description": "", + "tags": [ + "VideoV1Participant" + ], "parameters": [ { "name": "RoomSid", @@ -3047,6 +4447,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-30T20:00:00Z", + "date_updated": "2017-07-30T20:00:00Z", + "start_time": "2017-07-30T20:00:00Z", + "end_time": "2017-07-30T20:00:01Z", + "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "alice", + "status": "disconnected", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "duration": 1, + "links": { + "published_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks", + "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks", + "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules", + "anonymize": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize" + } + } + } } } }, @@ -3059,9 +4482,6 @@ } ], "operationId": "UpdateRoomParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3075,6 +4495,13 @@ "description": "The new status of the resource. Can be: `connected` or `disconnected`. For `in-progress` Rooms the default Status is `connected`, for `completed` Rooms only `disconnected` Participants are returned." } } + }, + "examples": { + "update": { + "value": { + "Status": "disconnected" + } + } } } } @@ -3094,17 +4521,44 @@ "identity", "status" ], - "pathType": "list", "dependentProperties": { - "published_track": "{room_sid: room_sid, participant_sid: sid}", - "subscribed_track": "{room_sid: room_sid, participant_sid: sid}", - "subscribe_rules": "{room_sid: room_sid, participant_sid: sid}", - "anonymize": "{room_sid: room_sid, sid: sid}" + "published_tracks": { + "mapping": { + "room_sid": "room_sid", + "participant_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/PublishedTracks" + }, + "subscribed_tracks": { + "mapping": { + "room_sid": "room_sid", + "participant_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribedTracks" + }, + "subscribe_rules": { + "mapping": { + "room_sid": "room_sid", + "participant_sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribeRules" + }, + "anonymize": { + "mapping": { + "room_sid": "room_sid", + "sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Participants/{sid}/Anonymize" + } }, - "parent": "/Rooms/{Sid}" + "parent": "/Rooms/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "VideoV1Participant" + ], "parameters": [ { "name": "RoomSid", @@ -3122,6 +4576,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/room_participant_enum_status" + }, + "examples": { + "readFilters": { + "value": "disconnected" + } } }, { @@ -3130,6 +4589,11 @@ "description": "Read only the Participants with this [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value.", "schema": { "type": "string" + }, + "examples": { + "readFilters": { + "value": "alice" + } } }, { @@ -3139,6 +4603,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFilters": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -3148,6 +4617,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFilters": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -3193,16 +4667,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3211,17 +4687,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "participants": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "next_page_url": null, + "key": "participants" + } + } + }, + "readFilters": { + "value": { + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-30T20:00:00Z", + "date_updated": "2017-07-30T20:00:00Z", + "start_time": "2017-07-30T20:00:00Z", + "end_time": "2017-07-30T20:00:01Z", + "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "alice", + "status": "disconnected", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "duration": 1, + "links": { + "published_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks", + "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks", + "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules", + "anonymize": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0", + "next_page_url": null, + "key": "participants" } } } @@ -3236,10 +4760,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomParticipant" } }, "/v1/Rooms/{RoomSid}/Participants/{Sid}/Anonymize": { @@ -3248,18 +4769,21 @@ "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": "", + "tags": [ + "VideoV1Anonymize" + ], "parameters": [ { "name": "RoomSid", @@ -3286,6 +4810,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_anonymize" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "start_time": "2015-07-30T20:00:00Z", + "end_time": null, + "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "disconnected", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize", + "duration": 1 + } + } } } }, @@ -3297,10 +4838,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateRoomParticipantAnonymize", - "x-maturity": [ - "GA" - ] + "operationId": "UpdateRoomParticipantAnonymize" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks/{Sid}": { @@ -3309,7 +4847,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3317,11 +4855,14 @@ "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.", + "tags": [ + "VideoV1PublishedTrack" + ], "parameters": [ { "name": "RoomSid", @@ -3357,6 +4898,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_published_track" + }, + "examples": { + "fetch": { + "value": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "bob-track", + "kind": "data", + "enabled": true, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks/MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3368,10 +4924,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipantPublishedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipantPublishedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks": { @@ -3380,7 +4933,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3388,11 +4941,14 @@ "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.", + "tags": [ + "VideoV1PublishedTrack" + ], "parameters": [ { "name": "RoomSid", @@ -3455,16 +5011,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3473,17 +5031,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "published_tracks": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0", + "next_page_url": null, + "key": "published_tracks" } } } @@ -3498,10 +5070,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomParticipantPublishedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomParticipantPublishedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules": { @@ -3510,19 +5079,22 @@ "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.", + "tags": [ + "VideoV1SubscribeRules" + ], "parameters": [ { "name": "RoomSid", @@ -3549,6 +5121,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule" + }, + "examples": { + "readEmpty": { + "value": { + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": null, + "date_updated": null, + "rules": [ + { + "type": "include", + "all": true, + "publisher": null, + "track": null, + "kind": null, + "priority": null + } + ] + } + } } } }, @@ -3560,13 +5152,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipantSubscribeRule", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipantSubscribeRule" }, "post": { "description": "Update the Subscribe Rules for the Participant", + "tags": [ + "VideoV1SubscribeRules" + ], "parameters": [ { "name": "RoomSid", @@ -3593,6 +5185,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule" + }, + "examples": { + "updateFilters": { + "value": { + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": null, + "date_updated": null, + "rules": [ + { + "type": "exclude", + "all": true, + "publisher": null, + "track": null, + "kind": null, + "priority": null + } + ] + } + } } } }, @@ -3605,9 +5217,6 @@ } ], "operationId": "UpdateRoomParticipantSubscribeRule", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3619,6 +5228,13 @@ "description": "A JSON-encoded array of subscribe rules. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) section for further information." } } + }, + "examples": { + "updateFilters": { + "value": { + "Rules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D" + } + } } } } @@ -3631,7 +5247,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3639,11 +5255,14 @@ "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.", + "tags": [ + "VideoV1SubscribedTrack" + ], "parameters": [ { "name": "RoomSid", @@ -3682,6 +5301,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribed_track" + }, + "examples": { + "fetch": { + "value": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisher_sid": "PAbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "bob-track", + "kind": "data", + "enabled": true, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks/MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3693,10 +5328,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipantSubscribedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipantSubscribedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks": { @@ -3705,7 +5337,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3713,11 +5345,14 @@ "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.", + "tags": [ + "VideoV1SubscribedTrack" + ], "parameters": [ { "name": "RoomSid", @@ -3780,16 +5415,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3798,17 +5435,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "subscribed_tracks": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks?PageSize=50&Page=0", + "next_page_url": null, + "key": "subscribed_tracks" } } } @@ -3823,10 +5474,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomParticipantSubscribedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomParticipantSubscribedTrack" } }, "/v1/Rooms/{RoomSid}/Recordings/{Sid}": { @@ -3845,15 +5493,24 @@ "duration", "codec" ], - "pathType": "instance", "dependentProperties": { - "video/v1/room_recording_media": "{room_sid: room_sid, sid: sid}" + "media": { + "mapping": { + "room_sid": "room_sid", + "sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Recordings/{sid}/Media" + } }, "parent": "/Rooms/{Sid}", - "className": "room_recording" + "className": "room_recording", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "VideoV1RoomRecording" + ], "parameters": [ { "name": "RoomSid", @@ -3886,6 +5543,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "processing", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T21:00:00Z", + "date_deleted": "2015-07-30T22:00:00Z", + "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 0, + "type": "audio", + "duration": 0, + "container_format": "mka", + "codec": "OPUS", + "track_name": "A name", + "offset": 10, + "grouping_sids": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "encryption_key": "public_key", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "media": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + } } } }, @@ -3897,13 +5584,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomRecording" }, "delete": { "description": "", + "tags": [ + "VideoV1RoomRecording" + ], "parameters": [ { "name": "RoomSid", @@ -3940,10 +5627,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRoomRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRoomRecording" } }, "/v1/Rooms/{RoomSid}/Recordings": { @@ -3962,15 +5646,24 @@ "duration", "codec" ], - "pathType": "list", "dependentProperties": { - "video/v1/room_recording_media": "{room_sid: room_sid, sid: sid}" + "media": { + "mapping": { + "room_sid": "room_sid", + "sid": "sid" + }, + "resource_url": "/v1/Rooms/{room_sid}/Recordings/{sid}/Media" + } }, "parent": "/Rooms/{Sid}", - "className": "room_recording" + "className": "room_recording", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "VideoV1RoomRecording" + ], "parameters": [ { "name": "RoomSid", @@ -3991,6 +5684,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/room_recording_enum_status" + }, + "examples": { + "readResults": { + "value": "completed" + } } }, { @@ -4002,6 +5700,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readResults": { + "value": "source_sid" + } } }, { @@ -4011,6 +5714,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -4020,6 +5728,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -4065,16 +5778,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4083,17 +5798,73 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "recordings": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?PageSize=50&Page=0", + "next_page_url": null, + "key": "recordings" + } + } + }, + "readResults": { + "value": { + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T21:00:00Z", + "date_deleted": "2015-07-30T22:00:00Z", + "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 23, + "type": "audio", + "duration": 10, + "container_format": "mka", + "codec": "OPUS", + "track_name": "A name", + "offset": 10, + "grouping_sids": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "encryption_key": "public_key", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "media": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?Status=completed&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&SourceSid=source_sid&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?Status=completed&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&SourceSid=source_sid&PageSize=50&Page=0", + "next_page_url": null, + "key": "recordings" } } } @@ -4108,10 +5879,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomRecording" } }, "/v1/Rooms/{RoomSid}/RecordingRules": { @@ -4120,18 +5888,21 @@ "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.", + "tags": [ + "VideoV1RecordingRules" + ], "parameters": [ { "name": "RoomSid", @@ -4149,6 +5920,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_recording_rule" + }, + "examples": { + "fetch": { + "value": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "rules": [ + { + "type": "include", + "all": true + } + ] + } + } } } }, @@ -4160,13 +5946,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomRecordingRule", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomRecordingRule" }, "post": { "description": "Update the Recording Rules for the Room", + "tags": [ + "VideoV1RecordingRules" + ], "parameters": [ { "name": "RoomSid", @@ -4184,6 +5970,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_recording_rule" + }, + "examples": { + "update": { + "value": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "rules": [ + { + "type": "include", + "all": true + } + ] + } + } } } }, @@ -4196,9 +5997,6 @@ } ], "operationId": "UpdateRoomRecordingRule", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4210,6 +6008,13 @@ "description": "A JSON-encoded array of recording rules." } } + }, + "examples": { + "update": { + "value": { + "Rules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D" + } + } } } } @@ -4222,10 +6027,53 @@ "url": "https://video.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "VideoV1Anonymize" + }, + { + "name": "VideoV1Composition" + }, + { + "name": "VideoV1CompositionHook" + }, + { + "name": "VideoV1CompositionSettings" + }, + { + "name": "VideoV1Media" + }, + { + "name": "VideoV1Participant" + }, + { + "name": "VideoV1PublishedTrack" + }, + { + "name": "VideoV1Recording" + }, + { + "name": "VideoV1RecordingRules" + }, + { + "name": "VideoV1RecordingSettings" + }, + { + "name": "VideoV1Room" + }, + { + "name": "VideoV1RoomRecording" + }, + { + "name": "VideoV1SubscribeRules" + }, + { + "name": "VideoV1SubscribedTrack" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_voice_v1.json b/spec/json/twilio_voice_v1.json index 61a45e84..e472a6be 100644 --- a/spec/json/twilio_voice_v1.json +++ b/spec/json/twilio_voice_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "voice.v1.archived_call": { "type": "object", @@ -54,7 +60,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `voice_method` when the BYOC Trunk receives a call." + "description": "The URL we call using the `voice_method` when the BYOC Trunk receives a call.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "voice_method": { "type": "string", @@ -74,7 +86,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`." + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "voice_fallback_method": { "type": "string", @@ -94,7 +112,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call to pass status parameters (such as call ended) to your application." + "description": "The URL that we call to pass status parameters (such as call ended) to your application.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status_callback_method": { "type": "string", @@ -237,7 +261,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The SIP address you want Twilio to route your calls to. This must be a `sip:` schema. `sips` is NOT supported." + "description": "The SIP address you want Twilio to route your calls to. This must be a `sip:` schema. `sips` is NOT supported.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "priority": { "type": "integer", @@ -318,7 +348,7 @@ "high_risk_tollfraud_numbers_enabled": { "type": "boolean", "nullable": true, - "description": "Whether dialing to high-risk [toll fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) numbers is enabled. These prefixes include narrow number ranges that have a high-risk of international revenue sharing fraud (IRSF) attacks, also known as [toll fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud). These prefixes are collected from anti-fraud databases and verified by analyzing calls on our network. These prefixes are not available for download and are updated frequently" + "description": "Whether dialing to high-risk [toll fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html) numbers is enabled. These prefixes include narrow number ranges that have a high-risk of international revenue sharing fraud (IRSF) attacks, also known as [toll fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html). These prefixes are collected from anti-fraud databases and verified by analyzing calls on our network. These prefixes are not available for download and are updated frequently" }, "url": { "type": "string", @@ -374,7 +404,7 @@ "high_risk_tollfraud_numbers_enabled": { "type": "boolean", "nullable": true, - "description": "Whether dialing to high-risk [toll fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) numbers is enabled. These prefixes include narrow number ranges that have a high-risk of international revenue sharing fraud (IRSF) attacks, also known as [toll fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud). These prefixes are collected from anti-fraud databases and verified by analyzing calls on our network. These prefixes are not available for download and are updated frequently" + "description": "Whether dialing to high-risk [toll fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html) numbers is enabled. These prefixes include narrow number ranges that have a high-risk of international revenue sharing fraud (IRSF) attacks, also known as [toll fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html). These prefixes are collected from anti-fraud databases and verified by analyzing calls on our network. These prefixes are not available for download and are updated frequently" }, "url": { "type": "string", @@ -458,7 +488,13 @@ "ip_address": { "type": "string", "nullable": true, - "description": "An IP address in dotted decimal notation, IPv4 only." + "description": "An IP address in dotted decimal notation, IPv4 only.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "cidr_prefix_length": { "type": "integer", @@ -485,6 +521,29 @@ } } }, + "recording_enum_status": { + "type": "string", + "enum": [ + "in-progress", + "paused", + "stopped", + "processing", + "completed", + "absent" + ] + }, + "recording_enum_source": { + "type": "string", + "enum": [ + "DialVerb", + "Conference", + "OutboundAPI", + "Trunking", + "RecordVerb", + "StartCallRecordingAPI", + "StartConferenceRecordingAPI" + ] + }, "voice.v1.source_ip_mapping": { "type": "object", "properties": { @@ -532,12 +591,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -553,7 +606,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -563,14 +616,17 @@ "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.", + "tags": [ + "VoiceV1ArchivedCall" + ], "parameters": [ { "name": "Date", @@ -605,10 +661,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteArchivedCall", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteArchivedCall" } }, "/v1/ByocTrunks": { @@ -628,12 +681,36 @@ }, "post": { "description": "", + "tags": [ + "VoiceV1ByocTrunk" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.byoc_trunk" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_url": "https://byoc.example.com/twilio/app", + "voice_method": "POST", + "voice_fallback_method": "POST", + "voice_fallback_url": "https://byoc.example.com/twilio/fallback", + "status_callback_method": "POST", + "status_callback_url": "https://byoc.example.com/twilio/status_callback", + "cnam_lookup_enabled": false, + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "from_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:36Z", + "url": "https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -646,9 +723,6 @@ } ], "operationId": "CreateByocTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -733,6 +807,22 @@ "description": "The SID of the SIP Domain that should be used in the `From` header of originating calls sent to your SIP infrastructure. If your SIP infrastructure allows users to \"call back\" an incoming call, configure this with a [SIP Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure proper routing. If not configured, the from domain will default to \"sip.twilio.com\"." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "VoiceUrl": "https://byoc.example.com/twilio/app", + "VoiceMethod": "POST", + "VoiceFallbackUrl": "https://byoc.example.com/twilio/fallback", + "VoiceFallbackMethod": "POST", + "StatusCallbackUrl": "https://byoc.example.com/twilio/status_callback", + "StatusCallbackMethod": "POST", + "CnamLookupEnabled": false, + "ConnectionPolicySid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FromDomainSid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -740,6 +830,9 @@ }, "get": { "description": "", + "tags": [ + "VoiceV1ByocTrunk" + ], "parameters": [ { "name": "PageSize", @@ -784,16 +877,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -802,18 +897,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0", + "next_page_url": null, + "key": "byoc_trunks" + }, + "byoc_trunks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_url": "https://byoc.example.com/twilio/app", + "voice_method": "POST", + "voice_fallback_method": "POST", + "voice_fallback_url": "https://byoc.example.com/twilio/fallback", + "status_callback_method": "POST", + "status_callback_url": "https://byoc.example.com/twilio/status_callback", + "cnam_lookup_enabled": false, + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "from_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0", + "next_page_url": null, + "key": "byoc_trunks" + }, + "byoc_trunks": [] } } } @@ -827,10 +968,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListByocTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "ListByocTrunk" } }, "/v1/ByocTrunks/{Sid}": { @@ -850,6 +988,9 @@ }, "get": { "description": "", + "tags": [ + "VoiceV1ByocTrunk" + ], "parameters": [ { "name": "Sid", @@ -870,6 +1011,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.byoc_trunk" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_url": "https://byoc.example.com/twilio/app", + "voice_method": "POST", + "voice_fallback_method": "POST", + "voice_fallback_url": "https://byoc.example.com/twilio/fallback", + "status_callback_method": "POST", + "status_callback_url": "https://byoc.example.com/twilio/status_callback", + "cnam_lookup_enabled": false, + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "from_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -881,13 +1043,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchByocTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "FetchByocTrunk" }, "post": { "description": "", + "tags": [ + "VoiceV1ByocTrunk" + ], "parameters": [ { "name": "Sid", @@ -908,6 +1070,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.byoc_trunk" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "update_name", + "voice_url": "https://byoc.example.com/twilio_updated/app", + "voice_method": "GET", + "voice_fallback_method": "GET", + "voice_fallback_url": "https://byoc.example.com/twilio_updated/fallback", + "status_callback_method": "GET", + "status_callback_url": "https://byoc.example.com/twilio_updated/status_callback", + "cnam_lookup_enabled": true, + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "from_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -920,9 +1103,6 @@ } ], "operationId": "UpdateByocTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1007,6 +1187,22 @@ "description": "The SID of the SIP Domain that should be used in the `From` header of originating calls sent to your SIP infrastructure. If your SIP infrastructure allows users to \"call back\" an incoming call, configure this with a [SIP Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure proper routing. If not configured, the from domain will default to \"sip.twilio.com\"." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "update_name", + "VoiceUrl": "https://byoc.example.com/twilio_updated/app", + "VoiceMethod": "GET", + "VoiceFallbackUrl": "https://byoc.example.com/twilio_updated/fallback", + "VoiceFallbackMethod": "GET", + "StatusCallbackUrl": "https://byoc.example.com/twilio_updated/status_callback", + "StatusCallbackMethod": "GET", + "CnamLookupEnabled": true, + "ConnectionPolicySid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "FromDomainSid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } + } } } } @@ -1014,6 +1210,9 @@ }, "delete": { "description": "", + "tags": [ + "VoiceV1ByocTrunk" + ], "parameters": [ { "name": "Sid", @@ -1038,10 +1237,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteByocTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteByocTrunk" } }, "/v1/ConnectionPolicies": { @@ -1056,19 +1252,42 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { - "connection_policy_target": "{connection_policy_sid: sid}" - } + "targets": { + "mapping": { + "connection_policy_sid": "sid" + }, + "resource_url": "/v1/ConnectionPolicies/{connection_policy_sid}/Targets" + } + }, + "pathType": "list" }, "post": { "description": "", + "tags": [ + "VoiceV1ConnectionPolicy" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:36Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "targets": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets" + } + } + } } } }, @@ -1081,9 +1300,6 @@ } ], "operationId": "CreateConnectionPolicy", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1096,6 +1312,13 @@ "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -1103,6 +1326,9 @@ }, "get": { "description": "", + "tags": [ + "VoiceV1ConnectionPolicy" + ], "parameters": [ { "name": "PageSize", @@ -1147,16 +1373,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1165,18 +1393,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0", + "next_page_url": null, + "key": "connection_policies" + }, + "connection_policies": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "targets": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0", + "next_page_url": null, + "key": "connection_policies" + }, + "connection_policies": [] } } } @@ -1190,10 +1458,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConnectionPolicy", - "x-maturity": [ - "GA" - ] + "operationId": "ListConnectionPolicy" } }, "/v1/ConnectionPolicies/{Sid}": { @@ -1208,13 +1473,21 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { - "connection_policy_target": "{connection_policy_sid: sid}" - } + "targets": { + "mapping": { + "connection_policy_sid": "sid" + }, + "resource_url": "/v1/ConnectionPolicies/{connection_policy_sid}/Targets" + } + }, + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "VoiceV1ConnectionPolicy" + ], "parameters": [ { "name": "Sid", @@ -1235,6 +1508,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "targets": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets" + } + } + } } } }, @@ -1246,13 +1534,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConnectionPolicy", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConnectionPolicy" }, "post": { "description": "", + "tags": [ + "VoiceV1ConnectionPolicy" + ], "parameters": [ { "name": "Sid", @@ -1273,6 +1561,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "updated_name", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "targets": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets" + } + } + } } } }, @@ -1285,9 +1588,6 @@ } ], "operationId": "UpdateConnectionPolicy", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1300,6 +1600,13 @@ "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "updated_name" + } + } } } } @@ -1307,6 +1614,9 @@ }, "delete": { "description": "", + "tags": [ + "VoiceV1ConnectionPolicy" + ], "parameters": [ { "name": "Sid", @@ -1331,10 +1641,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConnectionPolicy", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConnectionPolicy" } }, "/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets": { @@ -1351,12 +1658,15 @@ "target", "enabled" ], - "pathType": "list", "parent": "/ConnectionPolicies/{Sid}", - "className": "connection_policy_target" + "className": "connection_policy_target", + "pathType": "list" }, "post": { "description": "", + "tags": [ + "VoiceV1ConnectionPolicyTarget" + ], "parameters": [ { "name": "ConnectionPolicySid", @@ -1377,6 +1687,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy.connection_policy_target" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "target": "sip:sip-box.com:1234", + "priority": 1, + "weight": 20, + "enabled": true, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:36Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1389,9 +1716,6 @@ } ], "operationId": "CreateConnectionPolicyTarget", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1424,6 +1748,17 @@ "required": [ "Target" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Target": "sip:sip-box.com:1234", + "Priority": 1, + "Weight": 20, + "Enabled": true + } + } } } } @@ -1431,6 +1766,9 @@ }, "get": { "description": "", + "tags": [ + "VoiceV1ConnectionPolicyTarget" + ], "parameters": [ { "name": "ConnectionPolicySid", @@ -1487,16 +1825,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1505,18 +1845,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0", + "next_page_url": null, + "key": "targets" + }, + "targets": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "target": "sip:sip-box.com:1234", + "priority": 1, + "weight": 20, + "enabled": true, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0", + "next_page_url": null, + "key": "targets" + }, + "targets": [] } } } @@ -1530,10 +1912,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConnectionPolicyTarget", - "x-maturity": [ - "GA" - ] + "operationId": "ListConnectionPolicyTarget" } }, "/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid}": { @@ -1550,12 +1929,15 @@ "target", "enabled" ], - "pathType": "instance", "parent": "/ConnectionPolicies/{Sid}", - "className": "connection_policy_target" + "className": "connection_policy_target", + "pathType": "instance" }, "get": { "description": "", + "tags": [ + "VoiceV1ConnectionPolicyTarget" + ], "parameters": [ { "name": "ConnectionPolicySid", @@ -1588,6 +1970,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy.connection_policy_target" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "target": "sip:sip-box.com:1234", + "priority": 1, + "weight": 20, + "enabled": true, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1599,13 +1998,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConnectionPolicyTarget", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConnectionPolicyTarget" }, "post": { "description": "", + "tags": [ + "VoiceV1ConnectionPolicyTarget" + ], "parameters": [ { "name": "ConnectionPolicySid", @@ -1638,6 +2037,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy.connection_policy_target" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "updated_name", + "target": "sip:sip-updated.com:4321", + "priority": 2, + "weight": 10, + "enabled": false, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1650,9 +2066,6 @@ } ], "operationId": "UpdateConnectionPolicyTarget", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1682,6 +2095,17 @@ "description": "Whether the Target is enabled." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "updated_name", + "Target": "sip:sip-updated.com:4321", + "Priority": 2, + "Weight": 10, + "Enabled": false + } + } } } } @@ -1689,6 +2113,9 @@ }, "delete": { "description": "", + "tags": [ + "VoiceV1ConnectionPolicyTarget" + ], "parameters": [ { "name": "ConnectionPolicySid", @@ -1725,10 +2152,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConnectionPolicyTarget", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConnectionPolicyTarget" } }, "/v1/DialingPermissions": { @@ -1737,11 +2161,11 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "className": "dialing_permissions" + "className": "dialing_permissions", + "pathType": "list" } }, "/v1/DialingPermissions/Countries/{IsoCode}": { @@ -1750,21 +2174,29 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "iso_code", "name", "continent" ], - "pathType": "instance", "dependentProperties": { - "highrisk_special_prefix": "{iso_code: iso_code}" + "highrisk_special_prefixes": { + "mapping": { + "iso_code": "iso_code" + }, + "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", + "tags": [ + "VoiceV1Country" + ], "parameters": [ { "name": "IsoCode", @@ -1783,6 +2215,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country-instance" + }, + "examples": { + "fetch": { + "value": { + "iso_code": "US", + "name": "United States/Canada", + "country_codes": [ + "+1" + ], + "continent": "NORTH_AMERICA", + "low_risk_numbers_enabled": false, + "high_risk_special_numbers_enabled": false, + "high_risk_tollfraud_numbers_enabled": false, + "url": "https://voice.twilio.com/v1/DialingPermissions/Countries/US", + "links": { + "highrisk_special_prefixes": "https://voice.twilio.com/v1/DialingPermissions/Countries/US/HighRiskSpecialPrefixes" + } + } + } } } }, @@ -1794,10 +2245,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDialingPermissionsCountry", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDialingPermissionsCountry" } }, "/v1/DialingPermissions/Countries": { @@ -1806,21 +2254,29 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "iso_code", "name", "continent" ], - "pathType": "list", "dependentProperties": { - "highrisk_special_prefix": "{iso_code: iso_code}" + "highrisk_special_prefixes": { + "mapping": { + "iso_code": "iso_code" + }, + "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", + "tags": [ + "VoiceV1Country" + ], "parameters": [ { "name": "IsoCode", @@ -1829,6 +2285,11 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "readUs": { + "value": "US" + } } }, { @@ -1866,7 +2327,7 @@ { "name": "HighRiskTollfraudNumbersEnabled", "in": "query", - "description": "Filter to retrieve the country permissions with dialing to high-risk [toll fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) numbers enabled. Can be: `true` or `false`.", + "description": "Filter to retrieve the country permissions with dialing to high-risk [toll fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html) numbers enabled. Can be: `true` or `false`.", "schema": { "type": "boolean" } @@ -1914,16 +2375,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1932,17 +2395,47 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readUs": { + "value": { + "content": [ + { + "iso_code": "US", + "name": "United States/Canada", + "country_codes": [ + "+1" + ], + "continent": "NORTH_AMERICA", + "low_risk_numbers_enabled": false, + "high_risk_special_numbers_enabled": false, + "high_risk_tollfraud_numbers_enabled": false, + "url": "https://voice.twilio.com/v1/DialingPermissions/Countries/US", + "links": { + "highrisk_special_prefixes": "https://voice.twilio.com/v1/DialingPermissions/Countries/US/HighRiskSpecialPrefixes" + } + } + ], + "meta": { + "first_page_url": "https://voice.twilio.com/v1/DialingPermissions/Countries?IsoCode=US&PageSize=50&Page=0", + "key": "content", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/DialingPermissions/Countries?IsoCode=US&PageSize=50&Page=0" } } } @@ -1957,10 +2450,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDialingPermissionsCountry", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDialingPermissionsCountry" } }, "/v1/DialingPermissions/BulkCountryUpdates": { @@ -1969,23 +2459,34 @@ "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)", + "tags": [ + "VoiceV1BulkCountryUpdate" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country_bulk_update" + }, + "examples": { + "create": { + "value": { + "update_count": 1, + "update_request": "accepted" + } + } } } }, @@ -1998,9 +2499,6 @@ } ], "operationId": "CreateDialingPermissionsCountryBulkUpdate", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2016,6 +2514,13 @@ "required": [ "UpdateRequest" ] + }, + "examples": { + "create": { + "value": { + "UpdateRequest": "[ { \"iso_code\": \"GB\", \"low_risk_numbers\": \"Enabled\", \"high_risk_special_numbers\":\"Enabled\", \"high_risk_irsf_numbers\": \"Enabled\" } ]" + } + } } } } @@ -2028,17 +2533,20 @@ "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)", + "tags": [ + "VoiceV1HighriskSpecialPrefix" + ], "parameters": [ { "name": "IsoCode", @@ -2093,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" @@ -2111,17 +2621,38 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readLv": { + "value": { + "content": [ + { + "prefix": "+37181" + }, + { + "prefix": "+3719000" + } + ], + "meta": { + "first_page_url": "https://voice.twilio.com/v1/DialingPermissions/Countries/LV/HighRiskSpecialPrefixes?PageSize=50&Page=0", + "key": "content", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/DialingPermissions/Countries/LV/HighRiskSpecialPrefixes?PageSize=50&Page=0" } } } @@ -2136,10 +2667,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDialingPermissionsHrsPrefixes", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDialingPermissionsHrsPrefixes" } }, "/v1/Settings": { @@ -2148,23 +2676,34 @@ "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", + "tags": [ + "VoiceV1Settings" + ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_settings" + }, + "examples": { + "fetch": { + "value": { + "dialing_permissions_inheritance": true, + "url": "https://voice.twilio.com/v1/Settings" + } + } } } }, @@ -2176,19 +2715,27 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDialingPermissionsSettings", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDialingPermissionsSettings" }, "post": { "description": "Update voice dialing permissions inheritance for the sub-account", + "tags": [ + "VoiceV1Settings" + ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_settings" + }, + "examples": { + "update": { + "value": { + "dialing_permissions_inheritance": true, + "url": "https://voice.twilio.com/v1/Settings" + } + } } } }, @@ -2201,9 +2748,6 @@ } ], "operationId": "UpdateDialingPermissionsSettings", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2216,6 +2760,13 @@ "description": "`true` for the sub-account to inherit voice dialing permissions from the Master Project; otherwise `false`." } } + }, + "examples": { + "update": { + "value": { + "DialingPermissionsInheritance": true + } + } } } } @@ -2240,12 +2791,29 @@ }, "post": { "description": "", + "tags": [ + "VoiceV1IpRecord" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.ip_record" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "ip_address": "10.2.3.4", + "cidr_prefix_length": 30, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:36Z", + "url": "https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2258,9 +2826,6 @@ } ], "operationId": "CreateIpRecord", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2284,6 +2849,15 @@ "required": [ "IpAddress" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "IpAddress": "10.2.3.4", + "CidrPrefixLength": 30 + } + } } } } @@ -2291,6 +2865,9 @@ }, "get": { "description": "", + "tags": [ + "VoiceV1IpRecord" + ], "parameters": [ { "name": "PageSize", @@ -2335,16 +2912,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2353,18 +2932,57 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0", + "next_page_url": null, + "key": "ip_records" + }, + "ip_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "ip_address": "10.2.3.4", + "cidr_prefix_length": 30, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0", + "next_page_url": null, + "key": "ip_records" + }, + "ip_records": [] } } } @@ -2378,10 +2996,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIpRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListIpRecord" } }, "/v1/IpRecords/{Sid}": { @@ -2402,6 +3017,9 @@ }, "get": { "description": "", + "tags": [ + "VoiceV1IpRecord" + ], "parameters": [ { "name": "Sid", @@ -2422,6 +3040,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.ip_record" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "ip_address": "10.2.3.4", + "cidr_prefix_length": 30, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2433,13 +3065,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIpRecord", - "x-maturity": [ - "GA" - ] + "operationId": "FetchIpRecord" }, "post": { "description": "", + "tags": [ + "VoiceV1IpRecord" + ], "parameters": [ { "name": "Sid", @@ -2460,6 +3092,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.ip_record" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "update_name", + "ip_address": "10.2.3.4", + "cidr_prefix_length": 30, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2472,9 +3118,6 @@ } ], "operationId": "UpdateIpRecord", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2487,6 +3130,13 @@ "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "update_name" + } + } } } } @@ -2494,6 +3144,9 @@ }, "delete": { "description": "", + "tags": [ + "VoiceV1IpRecord" + ], "parameters": [ { "name": "Sid", @@ -2518,10 +3171,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIpRecord", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteIpRecord" } }, "/v1/SourceIpMappings": { @@ -2541,12 +3191,27 @@ }, "post": { "description": "", + "tags": [ + "VoiceV1SourceIpMapping" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.source_ip_mapping" + }, + "examples": { + "create": { + "value": { + "sid": "IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_record_sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sip_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:36Z", + "url": "https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2559,9 +3224,6 @@ } ], "operationId": "CreateSourceIpMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2588,6 +3250,14 @@ "IpRecordSid", "SipDomainSid" ] + }, + "examples": { + "create": { + "value": { + "IpRecordSid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SipDomainSid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2595,6 +3265,9 @@ }, "get": { "description": "", + "tags": [ + "VoiceV1SourceIpMapping" + ], "parameters": [ { "name": "PageSize", @@ -2639,16 +3312,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2657,18 +3332,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0", + "next_page_url": null, + "key": "source_ip_mappings" + }, + "source_ip_mappings": [ + { + "sid": "IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_record_sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sip_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0", + "next_page_url": null, + "key": "source_ip_mappings" + }, + "source_ip_mappings": [] } } } @@ -2682,10 +3394,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSourceIpMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSourceIpMapping" } }, "/v1/SourceIpMappings/{Sid}": { @@ -2705,6 +3414,9 @@ }, "get": { "description": "", + "tags": [ + "VoiceV1SourceIpMapping" + ], "parameters": [ { "name": "Sid", @@ -2725,6 +3437,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.source_ip_mapping" + }, + "examples": { + "fetch": { + "value": { + "sid": "IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_record_sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sip_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2736,13 +3460,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSourceIpMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSourceIpMapping" }, "post": { "description": "", + "tags": [ + "VoiceV1SourceIpMapping" + ], "parameters": [ { "name": "Sid", @@ -2763,6 +3487,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.source_ip_mapping" + }, + "examples": { + "update": { + "value": { + "sid": "IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_record_sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sip_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2775,9 +3511,6 @@ } ], "operationId": "UpdateSourceIpMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2796,6 +3529,13 @@ "required": [ "SipDomainSid" ] + }, + "examples": { + "update": { + "value": { + "SipDomainSid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } + } } } } @@ -2803,6 +3543,9 @@ }, "delete": { "description": "", + "tags": [ + "VoiceV1SourceIpMapping" + ], "parameters": [ { "name": "Sid", @@ -2827,10 +3570,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSourceIpMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSourceIpMapping" } } }, @@ -2839,18 +3579,50 @@ "url": "https://voice.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "VoiceV1ArchivedCall" + }, { - "name": "GA", - "description": "This product is Generally Available." + "name": "VoiceV1BulkCountryUpdate" }, { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "name": "VoiceV1ByocTrunk" }, { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." + "name": "VoiceV1ConnectionPolicy" + }, + { + "name": "VoiceV1ConnectionPolicyTarget" + }, + { + "name": "VoiceV1Country" + }, + { + "name": "VoiceV1HighriskSpecialPrefix" + }, + { + "name": "VoiceV1IpRecord" + }, + { + "name": "VoiceV1Media" + }, + { + "name": "VoiceV1MediaUrl" + }, + { + "name": "VoiceV1Recording" + }, + { + "name": "VoiceV1Settings" + }, + { + "name": "VoiceV1SourceIpMapping" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_wireless_v1.json b/spec/json/twilio_wireless_v1.json index aa4901ab..1b3c8c55 100644 --- a/spec/json/twilio_wireless_v1.json +++ b/spec/json/twilio_wireless_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "wireless.v1.account_usage_record": { "type": "object", @@ -18,11 +24,11 @@ }, "commands": { "nullable": true, - "description": "An object that describes the aggregated Commands usage for all SIMs during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/wireless/api/account-usagerecord-resource#commands-usage-object)." + "description": "An object that describes the aggregated Commands usage for all SIMs during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/iot/wireless/api/account-usagerecord-resource#commands-usage-object)." }, "data": { "nullable": true, - "description": "An object that describes the aggregated Data usage for all SIMs over the period. See [Data Usage Object](https://www.twilio.com/docs/wireless/api/account-usagerecord-resource#data-usage-object)." + "description": "An object that describes the aggregated Data usage for all SIMs over the period. See [Data Usage Object](https://www.twilio.com/docs/iot/wireless/api/account-usagerecord-resource#data-usage-object)." } } }, @@ -59,12 +65,18 @@ "maxLength": 34, "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) that the Command was sent to or from." + "description": "The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that the Command was sent to or from." }, "command": { "type": "string", "nullable": true, - "description": "The message being sent to or from the SIM. For text mode messages, this can be up to 160 characters. For binary mode messages, this is a series of up to 140 bytes of data encoded using base64." + "description": "The message being sent to or from the SIM. For text mode messages, this can be up to 160 characters. For binary mode messages, this is a series of up to 140 bytes of data encoded using base64.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "command_mode": { "type": "string", @@ -87,7 +99,7 @@ "type": "string", "$ref": "#/components/schemas/command_enum_status", "nullable": true, - "description": "The status of the Command. Can be: `queued`, `sent`, `delivered`, `received`, or `failed`. See [Status Values](https://www.twilio.com/docs/wireless/api/command-resource#status-values) for a description of each state." + "description": "The status of the Command. Can be: `queued`, `sent`, `delivered`, `received`, or `failed`. See [Status Values](https://www.twilio.com/docs/iot/wireless/api/command-resource#status-values) for a description of each state." }, "direction": { "type": "string", @@ -157,7 +169,7 @@ "sim_sid": { "type": "string", "nullable": true, - "description": "The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) that the Data Session is for." + "description": "The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that the Data Session is for." }, "account_sid": { "type": "string", @@ -190,7 +202,7 @@ "operator_name": { "type": "string", "nullable": true, - "description": "The friendly name of the mobile operator network that the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource)-connected device is attached to. This is determined by looking up the `operator_mnc`." + "description": "The friendly name of the mobile operator network that the [SIM](https://www.twilio.com/docs/iot/wireless/api/sim-resource)-connected device is attached to. This is determined by looking up the `operator_mnc`." }, "cell_id": { "type": "string", @@ -199,7 +211,7 @@ }, "cell_location_estimate": { "nullable": true, - "description": "An object that describes the estimated location in latitude and longitude where the device's Data Session took place. The location is derived from the `cell_id` when the Data Session was last updated. See [Cell Location Estimate Object](https://www.twilio.com/docs/wireless/api/datasession-resource#cell-location-estimate-object). " + "description": "An object that describes the estimated location in latitude and longitude where the device's Data Session took place. The location is derived from the `cell_id` when the Data Session was last updated. See [Cell Location Estimate Object](https://www.twilio.com/docs/iot/wireless/api/datasession-resource#cell-location-estimate-object). " }, "packets_uploaded": { "type": "integer", @@ -273,7 +285,7 @@ "data_metering": { "type": "string", "nullable": true, - "description": "The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans)." + "description": "The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans)." }, "data_limit": { "type": "integer", @@ -283,7 +295,7 @@ "messaging_enabled": { "type": "boolean", "nullable": true, - "description": "Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/wireless/api/command-resource)." + "description": "Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/iot/wireless/api/command-resource)." }, "voice_enabled": { "type": "boolean", @@ -293,7 +305,7 @@ "national_roaming_enabled": { "type": "boolean", "nullable": true, - "description": "Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming)." + "description": "Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming)." }, "national_roaming_data_limit": { "type": "integer", @@ -354,7 +366,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -370,17 +388,29 @@ "maxLength": 34, "pattern": "^WP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) to which the Sim resource is assigned." + "description": "The SID of the [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource) to which the Sim resource is assigned." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Sim resource." + "description": "The string that you assigned to describe the Sim resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "iccid": { "type": "string", "nullable": true, - "description": "The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM." + "description": "The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "e_id": { "type": "string", @@ -391,7 +421,7 @@ "type": "string", "$ref": "#/components/schemas/sim_enum_status", "nullable": true, - "description": "The status of the Sim resource. Can be: `new`, `ready`, `active`, `deactivated`, `canceled`, `deleted`, `scheduled`, or `updating`. See [Status Values](https://www.twilio.com/docs/wireless/api/sim-resource#status-values) for the description of each status." + "description": "The status of the Sim resource. Can be: `new`, `ready`, `active`, `deactivated`, `canceled`, `deleted`, `scheduled`, or `updating`. See [Status Values](https://www.twilio.com/docs/iot/wireless/api/sim-resource#status-values) for the description of each status." }, "reset_status": { "type": "string", @@ -403,7 +433,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `commands_callback_method` when the SIM originates a machine-to-machine [Command](https://www.twilio.com/docs/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body will be ignored." + "description": "The URL we call using the `commands_callback_method` when the SIM originates a machine-to-machine [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body will be ignored." }, "commands_callback_method": { "type": "string", @@ -555,7 +585,7 @@ "sim_sid": { "type": "string", "nullable": true, - "description": "The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) that this Usage Record is for." + "description": "The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that this Usage Record is for." }, "account_sid": { "type": "string", @@ -571,11 +601,11 @@ }, "commands": { "nullable": true, - "description": "An object that describes the SIM's usage of Commands during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/wireless/api/sim-usagerecord-resource#commands-usage-object)." + "description": "An object that describes the SIM's usage of Commands during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/iot/wireless/api/sim-usagerecord-resource#commands-usage-object)." }, "data": { "nullable": true, - "description": "An object that describes the SIM's data usage during the specified period. See [Data Usage Object](https://www.twilio.com/docs/wireless/api/sim-usagerecord-resource#data-usage-object)." + "description": "An object that describes the SIM's data usage during the specified period. See [Data Usage Object](https://www.twilio.com/docs/iot/wireless/api/sim-usagerecord-resource#data-usage-object)." } } }, @@ -587,12 +617,6 @@ "all" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -608,7 +632,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -627,6 +651,9 @@ }, "get": { "description": "", + "tags": [ + "WirelessV1UsageRecord" + ], "parameters": [ { "name": "End", @@ -635,6 +662,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -644,6 +676,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -698,16 +735,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -716,17 +755,92 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "fetch": { + "value": { + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "commands": { + "billing_units": "USD", + "billed": 0, + "total": 3, + "from_sim": 1, + "to_sim": 2, + "home": { + "billing_units": "USD", + "billed": 0, + "total": 3, + "from_sim": 1, + "to_sim": 2 + }, + "national_roaming": { + "billing_units": "USD", + "billed": 0, + "total": 0, + "from_sim": 0, + "to_sim": 0 + }, + "international_roaming": [] + }, + "data": { + "billing_units": "USD", + "billed": 0.35, + "total": 3494609, + "upload": 731560, + "download": 2763049, + "units": "bytes", + "home": { + "billing_units": "USD", + "billed": 0.35, + "total": 3494609, + "upload": 731560, + "download": 2763049, + "units": "bytes" + }, + "national_roaming": { + "billing_units": "USD", + "billed": 0, + "total": 0, + "upload": 0, + "download": 0, + "units": "bytes" + }, + "international_roaming": [] + }, + "period": { + "start": "2015-07-30T20:00:00Z", + "end": "2015-07-30T20:00:00Z" + } + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "commands": {}, + "data": {}, + "period": {} + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0" } } } @@ -741,10 +855,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccountUsageRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListAccountUsageRecord" } }, "/v1/Commands/{Sid}": { @@ -767,6 +878,9 @@ }, "get": { "description": "Fetch a Command instance from your account.", + "tags": [ + "WirelessV1Command" + ], "parameters": [ { "name": "Sid", @@ -787,6 +901,40 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.command" + }, + "examples": { + "fetchCommandSms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "text", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": true, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "from_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "sms", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchCommandIp": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "text", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": false, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "to_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "ip", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -798,13 +946,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCommand", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCommand" }, "delete": { "description": "Delete a Command instance from your account.", + "tags": [ + "WirelessV1Command" + ], "parameters": [ { "name": "Sid", @@ -829,10 +977,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCommand", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCommand" } }, "/v1/Commands": { @@ -855,13 +1000,27 @@ }, "get": { "description": "Retrieve a list of Commands from your account.", + "tags": [ + "WirelessV1Command" + ], "parameters": [ { "name": "Sim", "in": "query", - "description": "The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read.", + "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" + } } }, { @@ -871,6 +1030,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/command_enum_status" + }, + "examples": { + "readEmpty": { + "value": "queued" + }, + "readFull": { + "value": "queued" + }, + "readIp": { + "value": "queued" + } } }, { @@ -880,6 +1050,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/command_enum_direction" + }, + "examples": { + "readEmpty": { + "value": "from_sim" + }, + "readFull": { + "value": "from_sim" + }, + "readIp": { + "value": "to_sim" + } } }, { @@ -889,6 +1070,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/command_enum_transport" + }, + "examples": { + "readIp": { + "value": "ip" + } } }, { @@ -934,16 +1120,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -952,17 +1140,89 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "commands": [], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0", + "key": "commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "commands": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "text", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": true, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "from_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "sms", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0", + "key": "commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0" + } + } + }, + "readIp": { + "value": { + "commands": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "binary", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": true, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "to_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "ip", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0", + "key": "commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0" } } } @@ -977,19 +1237,53 @@ "accountSid_authToken": [] } ], - "operationId": "ListCommand", - "x-maturity": [ - "GA" - ] + "operationId": "ListCommand" }, "post": { "description": "Send a Command to a Sim.", + "tags": [ + "WirelessV1Command" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.command" + }, + "examples": { + "createCommandSms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "text", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": true, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "from_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "sms", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCommandIp": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "binary", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": true, + "direction": "to_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "ip", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1002,9 +1296,6 @@ } ], "operationId": "CreateCommand", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1018,7 +1309,7 @@ }, "Sim": { "type": "string", - "description": "The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource) to send the Command to." + "description": "The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to send the Command to." }, "CallbackMethod": { "type": "string", @@ -1055,6 +1346,29 @@ "required": [ "Command" ] + }, + "examples": { + "createCommandSms": { + "value": { + "CallbackMethod": "callback_method", + "CallbackUrl": "http://www.example.com", + "Command": "command", + "CommandMode": "text", + "Sim": "sim", + "IncludeSid": "include_sid" + } + }, + "createCommandIp": { + "value": { + "CallbackMethod": "callback_method", + "CallbackUrl": "http://www.example.com", + "Command": "command", + "CommandMode": "binary", + "DeliveryReceiptRequested": true, + "Sim": "sim", + "IncludeSid": "include_sid" + } + } } } } @@ -1076,16 +1390,19 @@ "start", "end" ], - "pathType": "list", - "parent": "/Sims/{Sid}" + "parent": "/Sims/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "WirelessV1DataSession" + ], "parameters": [ { "name": "SimSid", "in": "path", - "description": "The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) with the Data Sessions to read.", + "description": "The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) with the Data Sessions to read.", "schema": { "type": "string" }, @@ -1134,16 +1451,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1152,17 +1471,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "fetch": { + "value": { + "data_sessions": [ + { + "sid": "WNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "radio_link": "LTE", + "operator_mcc": "", + "operator_mnc": "", + "operator_country": "", + "operator_name": "", + "cell_id": "", + "cell_location_estimate": {}, + "packets_uploaded": 0, + "packets_downloaded": 0, + "last_updated": "2015-07-30T20:00:00Z", + "start": "2015-07-30T20:00:00Z", + "end": null, + "imei": null + }, + { + "sid": "WNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "radio_link": "3G", + "operator_mcc": "", + "operator_mnc": "", + "operator_country": "", + "operator_name": "", + "cell_id": "", + "cell_location_estimate": {}, + "packets_uploaded": 0, + "packets_downloaded": 0, + "last_updated": "2015-07-30T20:00:00Z", + "start": "2015-07-30T20:00:00Z", + "end": "2015-07-30T20:00:00Z", + "imei": "014931000129700" + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions?PageSize=50&Page=0", + "key": "data_sessions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions?PageSize=50&Page=0" } } } @@ -1177,10 +1547,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDataSession", - "x-maturity": [ - "GA" - ] + "operationId": "ListDataSession" } }, "/v1/RatePlans": { @@ -1201,6 +1568,9 @@ }, "get": { "description": "", + "tags": [ + "WirelessV1RatePlan" + ], "parameters": [ { "name": "PageSize", @@ -1245,16 +1615,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1263,18 +1635,72 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0", + "key": "rate_plans", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0" + }, + "rate_plans": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0", + "key": "rate_plans", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0" + }, + "rate_plans": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "national_roaming_data_limit": 1000, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "international_roaming_data_limit": 1000, + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_notification_method": "POST", + "usage_notification_url": "https://callback.com", + "data_limit_strategy": "block", + "url": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -1288,19 +1714,48 @@ "accountSid_authToken": [] } ], - "operationId": "ListRatePlan", - "x-maturity": [ - "GA" - ] + "operationId": "ListRatePlan" }, "post": { "description": "", + "tags": [ + "WirelessV1RatePlan" + ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.rate_plan" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_limit_strategy": "block", + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "national_roaming_data_limit": 1000, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "international_roaming_data_limit": 1000, + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_notification_method": "POST", + "usage_notification_url": "https://callback.com", + "url": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1313,9 +1768,6 @@ } ], "operationId": "CreateRatePlan", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1341,11 +1793,11 @@ }, "DataMetering": { "type": "string", - "description": "The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans)." + "description": "The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans)." }, "MessagingEnabled": { "type": "boolean", - "description": "Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/wireless/api/command-resource)." + "description": "Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/iot/wireless/api/command-resource)." }, "VoiceEnabled": { "type": "boolean", @@ -1353,7 +1805,7 @@ }, "NationalRoamingEnabled": { "type": "boolean", - "description": "Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming)." + "description": "Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming)." }, "InternationalRoaming": { "type": "array", @@ -1364,13 +1816,35 @@ }, "NationalRoamingDataLimit": { "type": "integer", - "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming) for more info." + "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming) for more info." }, "InternationalRoamingDataLimit": { "type": "integer", "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" + } + } } } } @@ -1395,6 +1869,9 @@ }, "get": { "description": "", + "tags": [ + "WirelessV1RatePlan" + ], "parameters": [ { "name": "Sid", @@ -1412,6 +1889,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.rate_plan" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "national_roaming_data_limit": 1000, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "international_roaming_data_limit": 1000, + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_notification_method": "POST", + "usage_notification_url": "https://callback.com", + "data_limit_strategy": "block", + "url": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1423,13 +1929,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRatePlan", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRatePlan" }, "post": { "description": "", + "tags": [ + "WirelessV1RatePlan" + ], "parameters": [ { "name": "Sid", @@ -1447,6 +1953,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.rate_plan" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "national_roaming_data_limit": 1000, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "international_roaming_data_limit": 1000, + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_notification_method": "POST", + "usage_notification_url": "https://callback.com", + "data_limit_strategy": "block", + "url": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1459,9 +1994,6 @@ } ], "operationId": "UpdateRatePlan", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1478,6 +2010,16 @@ "description": "A descriptive string that you create to describe the resource. It does not have to be unique." } } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "FriendlyName": "friendly_name", + "UsageNotificationMethod": "POST", + "UsageNotificationUrl": "https://callback.com" + } + } } } } @@ -1485,6 +2027,9 @@ }, "delete": { "description": "", + "tags": [ + "WirelessV1RatePlan" + ], "parameters": [ { "name": "Sid", @@ -1506,10 +2051,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRatePlan", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRatePlan" } }, "/v1/Sims/{Sid}": { @@ -1526,14 +2068,27 @@ "friendly_name", "status" ], - "pathType": "instance", "dependentProperties": { - "usage_record": "{sim_sid: sid}", - "data_session": "{sim_sid: sid}" - } + "usage_records": { + "mapping": { + "sim_sid": "sid" + }, + "resource_url": "/v1/Sims/{sim_sid}/UsageRecords" + }, + "data_sessions": { + "mapping": { + "sim_sid": "sid" + }, + "resource_url": "/v1/Sims/{sim_sid}/DataSessions" + } + }, + "pathType": "instance" }, "get": { "description": "Fetch a Sim resource on your Account.", + "tags": [ + "WirelessV1Sim" + ], "parameters": [ { "name": "Sid", @@ -1551,6 +2106,40 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.sim" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "POST", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "sms_fallback_method": "POST", + "sms_fallback_url": "http://www.example.com", + "sms_method": "POST", + "sms_url": "http://www.example.com", + "voice_fallback_method": "POST", + "voice_fallback_url": "http://www.example.com", + "voice_method": "POST", + "voice_url": "http://www.example.com", + "links": { + "data_sessions": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions", + "rate_plan": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_records": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "new", + "reset_status": null, + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.1" + } + } } } }, @@ -1562,13 +2151,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSim", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSim" }, "post": { "description": "Updates the given properties of a Sim resource on your Account.", + "tags": [ + "WirelessV1Sim" + ], "parameters": [ { "name": "Sid", @@ -1586,6 +2175,104 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.sim" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "POST", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "data_sessions": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions", + "rate_plan": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_records": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "new", + "reset_status": null, + "sms_fallback_method": "POST", + "sms_fallback_url": "http://www.example.com", + "sms_method": "POST", + "sms_url": "http://www.example.com", + "voice_fallback_method": "POST", + "voice_fallback_url": "http://www.example.com", + "voice_method": "POST", + "voice_url": "http://www.example.com", + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.30" + } + }, + "updateMoveToSubaccount": { + "value": { + "account_sid": "ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "unique_name": "unique_name", + "commands_callback_method": "POST", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "data_sessions": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions", + "rate_plan": "https://wireless.twilio.com/v1/RatePlans/WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "usage_records": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords" + }, + "rate_plan_sid": "WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "new", + "reset_status": null, + "sms_fallback_method": "POST", + "sms_fallback_url": "http://www.example.com", + "sms_method": "POST", + "sms_url": "http://www.example.com", + "voice_fallback_method": "POST", + "voice_fallback_url": "http://www.example.com", + "voice_method": "POST", + "voice_url": "http://www.example.com", + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.30" + } + }, + "updateResetConnectivity": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "GET", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "data_sessions": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions", + "rate_plan": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_records": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "active", + "reset_status": "resetting", + "sms_fallback_method": "POST", + "sms_fallback_url": "http://www.example.com", + "sms_method": "POST", + "sms_url": "http://www.example.com", + "voice_fallback_method": "POST", + "voice_fallback_url": "http://www.example.com", + "voice_method": "POST", + "voice_url": "http://www.example.com", + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.30" + } + } } } }, @@ -1598,9 +2285,6 @@ } ], "operationId": "UpdateSim", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1636,7 +2320,7 @@ }, "RatePlan": { "type": "string", - "description": "The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) to which the Sim resource should be assigned." + "description": "The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource) to which the Sim resource should be assigned." }, "Status": { "type": "string", @@ -1659,7 +2343,7 @@ "CommandsCallbackUrl": { "type": "string", "format": "uri", - "description": "The URL we should call using the `commands_callback_method` when the SIM sends a [Command](https://www.twilio.com/docs/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored." + "description": "The URL we should call using the `commands_callback_method` when the SIM sends a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored." }, "SmsFallbackMethod": { "type": "string", @@ -1695,7 +2379,7 @@ "SmsUrl": { "type": "string", "format": "uri", - "description": "The URL we should call using the `sms_method` when the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/wireless/api/command-resource)." + "description": "The URL we should call using the `sms_method` when the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource)." }, "VoiceFallbackMethod": { "type": "string", @@ -1740,7 +2424,42 @@ }, "AccountSid": { "type": "string", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts)." + "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" } } } @@ -1750,6 +2469,9 @@ }, "delete": { "description": "Delete a Sim resource on your Account.", + "tags": [ + "WirelessV1Sim" + ], "parameters": [ { "name": "Sid", @@ -1771,10 +2493,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSim", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSim" } }, "/v1/Sims": { @@ -1791,14 +2510,27 @@ "friendly_name", "status" ], - "pathType": "list", "dependentProperties": { - "usage_record": "{sim_sid: sid}", - "data_session": "{sim_sid: sid}" - } + "usage_records": { + "mapping": { + "sim_sid": "sid" + }, + "resource_url": "/v1/Sims/{sim_sid}/UsageRecords" + }, + "data_sessions": { + "mapping": { + "sim_sid": "sid" + }, + "resource_url": "/v1/Sims/{sim_sid}/DataSessions" + } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of Sim resources on your Account.", + "tags": [ + "WirelessV1Sim" + ], "parameters": [ { "name": "Status", @@ -1807,6 +2539,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sim_enum_status" + }, + "examples": { + "readEmpty": { + "value": "new" + }, + "readFull": { + "value": "new" + } } }, { @@ -1815,14 +2555,36 @@ "description": "Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "iccid" + }, + "readFull": { + "value": "iccid" + } } }, { "name": "RatePlan", "in": "query", - "description": "The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.", + "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" + } } }, { @@ -1884,16 +2646,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1902,17 +2666,76 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sims": [], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "sims": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "POST", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "data_sessions": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions", + "rate_plan": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_records": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "new", + "reset_status": "resetting", + "sms_fallback_method": "POST", + "sms_fallback_url": "http://www.example.com", + "sms_method": "POST", + "sms_url": "http://www.example.com", + "voice_fallback_method": "POST", + "voice_fallback_url": "http://www.example.com", + "voice_method": "POST", + "voice_url": "http://www.example.com", + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.30" + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" } } } @@ -1927,10 +2750,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSim", - "x-maturity": [ - "GA" - ] + "operationId": "ListSim" } }, "/v1/Sims/{SimSid}/UsageRecords": { @@ -1944,16 +2764,19 @@ "defaultOutputProperties": [ "period" ], - "pathType": "list", - "parent": "/Sims/{Sid}" + "parent": "/Sims/{Sid}", + "pathType": "list" }, "get": { "description": "", + "tags": [ + "WirelessV1UsageRecord" + ], "parameters": [ { "name": "SimSid", "in": "path", - "description": "The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) to read the usage from.", + "description": "The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to read the usage from.", "schema": { "type": "string" }, @@ -1966,6 +2789,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -1975,6 +2803,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -2029,16 +2862,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2047,17 +2882,94 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "fetch": { + "value": { + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "commands": { + "billing_units": "USD", + "billed": 0, + "total": 3, + "from_sim": 1, + "to_sim": 2, + "home": { + "billing_units": "USD", + "billed": 0, + "total": 3, + "from_sim": 1, + "to_sim": 2 + }, + "national_roaming": { + "billing_units": "USD", + "billed": 0, + "total": 0, + "from_sim": 0, + "to_sim": 0 + }, + "international_roaming": [] + }, + "data": { + "billing_units": "USD", + "billed": 0.35, + "total": 3494609, + "upload": 731560, + "download": 2763049, + "units": "bytes", + "home": { + "billing_units": "USD", + "billed": 0.35, + "total": 3494609, + "upload": 731560, + "download": 2763049, + "units": "bytes" + }, + "national_roaming": { + "billing_units": "USD", + "billed": 0, + "total": 0, + "upload": 0, + "download": 0, + "units": "bytes" + }, + "international_roaming": [] + }, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "period": { + "start": "2015-07-30T20:00:00Z", + "end": "2015-07-30T20:00:00Z" + } + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "commands": {}, + "data": {}, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "period": {} + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0" } } } @@ -2072,10 +2984,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecord" } } }, @@ -2084,10 +2993,26 @@ "url": "https://wireless.twilio.com" } ], - "x-maturity": [ + "tags": [ + { + "name": "WirelessV1Command" + }, + { + "name": "WirelessV1DataSession" + }, + { + "name": "WirelessV1RatePlan" + }, + { + "name": "WirelessV1Sim" + }, + { + "name": "WirelessV1UsageRecord" + } + ], + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/yaml/twilio_accounts_v1.yaml b/spec/yaml/twilio_accounts_v1.yaml index 32c67399..5ffc3e7a 100644 --- a/spec/yaml/twilio_accounts_v1.yaml +++ b/spec/yaml/twilio_accounts_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: accounts.v1.auth_token_promotion: type: object @@ -16,6 +20,10 @@ components: nullable: true description: The promoted Auth Token that must be used to authenticate future API requests. + x-twilio: + pii: + handling: sensitive + deleteSla: 0 date_created: type: string format: date-time @@ -58,6 +66,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 0 date_created: type: string format: date-time @@ -98,6 +110,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 0 date_created: type: string format: date-time @@ -115,6 +131,25 @@ components: format: uri nullable: true description: The URI for this resource, relative to `https://accounts.twilio.com` + accounts.v1.safelist: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GN[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the SafeList + resource. + phone_number: + type: string + nullable: true + description: The phone number in SafeList. + x-twilio: + pii: + handling: standard + deleteSla: 0 accounts.v1.secondary_auth_token: type: object properties: @@ -143,15 +178,15 @@ components: nullable: true description: The generated secondary Auth Token that can be used to authenticate future API requests. + x-twilio: + pii: + handling: sensitive + deleteSla: 0 url: type: string format: uri nullable: true description: The URI for this resource, relative to `https://accounts.twilio.com` - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Accounts description: This is the public Twilio REST API. @@ -163,7 +198,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/AuthTokens/Promote: @@ -175,28 +210,36 @@ paths: - account_sid - auth_token - date_created - pathType: instance mountName: auth_token_promotion + pathType: instance post: description: Promote the secondary Auth Token to primary. After promoting the new token, all requests to Twilio using your old primary Auth Token will result in an error. + tags: + - AccountsV1AuthTokenPromotion responses: '200': content: application/json: schema: $ref: '#/components/schemas/accounts.v1.auth_token_promotion' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + auth_token: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + url: https://accounts.twilio.com/v1/AuthTokens/Promote description: OK security: - accountSid_authToken: [] operationId: UpdateAuthTokenPromotion - x-maturity: - - GA /v1/Credentials: servers: - url: https://accounts.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: list @@ -209,11 +252,13 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Credentials + pathType: list get: description: Retrieves a collection of AWS Credentials belonging to the account used to make the request + tags: + - AccountsV1Aws parameters: - name: PageSize in: query @@ -247,48 +292,84 @@ paths: items: $ref: '#/components/schemas/accounts.v1.credential.credential_aws' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + credentials: [] + meta: + first_page_url: https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0 + key: credentials + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0 + readFull: + value: + credentials: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0 + key: credentials + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCredentialAws - x-maturity: - - GA post: description: Create a new AWS Credential + tags: + - AccountsV1Aws responses: '201': content: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_aws' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredentialAws - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -315,6 +396,12 @@ paths: issuing the request. required: - Credentials + examples: + create: + value: + AccountSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + Credentials: aws_credentials /v1/Credentials/AWS/{Sid}: servers: - url: https://accounts.twilio.com @@ -324,11 +411,13 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Credentials + pathType: instance get: description: Fetch the AWS credentials specified by the provided Credential Sid + tags: + - AccountsV1Aws parameters: - name: Sid in: path @@ -346,14 +435,23 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_aws' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredentialAws - x-maturity: - - GA post: description: Modify the properties of a given Account + tags: + - AccountsV1Aws parameters: - name: Sid in: path @@ -371,12 +469,19 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_aws' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredentialAws - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -388,8 +493,15 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + update: + value: + FriendlyName: friendly_name + Credentials: aws_credentials delete: description: Delete a Credential from your account + tags: + - AccountsV1Aws parameters: - name: Sid in: path @@ -407,8 +519,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredentialAws - x-maturity: - - GA /v1/Credentials/PublicKeys: servers: - url: https://accounts.twilio.com @@ -418,12 +528,14 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Credentials mountName: public_key + pathType: list get: description: Retrieves a collection of Public Key Credentials belonging to the account used to make the request + tags: + - AccountsV1PublicKey parameters: - name: PageSize in: query @@ -457,48 +569,84 @@ paths: items: $ref: '#/components/schemas/accounts.v1.credential.credential_public_key' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + credentials: [] + meta: + first_page_url: https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0 + key: credentials + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0 + readFull: + value: + credentials: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0 + key: credentials + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCredentialPublicKey - x-maturity: - - GA post: description: Create a new Public Key Credential + tags: + - AccountsV1PublicKey responses: '201': content: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_public_key' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredentialPublicKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -525,6 +673,12 @@ paths: issuing the request required: - PublicKey + examples: + create: + value: + AccountSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + PublicKey: public_key /v1/Credentials/PublicKeys/{Sid}: servers: - url: https://accounts.twilio.com @@ -534,11 +688,13 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Credentials mountName: public_key + pathType: instance get: description: Fetch the public key specified by the provided Credential Sid + tags: + - AccountsV1PublicKey parameters: - name: Sid in: path @@ -556,14 +712,23 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_public_key' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredentialPublicKey - x-maturity: - - GA post: description: Modify the properties of a given Account + tags: + - AccountsV1PublicKey parameters: - name: Sid in: path @@ -581,12 +746,19 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_public_key' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredentialPublicKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -598,8 +770,15 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + update: + value: + FriendlyName: friendly_name + PublicKey: public_key delete: description: Delete a Credential from your account + tags: + - AccountsV1PublicKey parameters: - name: Sid in: path @@ -617,8 +796,109 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredentialPublicKey - x-maturity: - - GA + /v1/SafeList/Numbers: + servers: + - url: https://accounts.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - phone_number + mountName: safelist + pathType: list + post: + description: Add a new phone number to SafeList. + tags: + - AccountsV1Safelist + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accounts.v1.safelist' + examples: + create: + value: + sid: GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+18001234567' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateSafelist + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSafelistRequest + properties: + PhoneNumber: + type: string + description: The phone number to be added in SafeList. Phone numbers + must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + required: + - PhoneNumber + examples: + create: + value: + PhoneNumber: '+18001234567' + get: + description: Check if a phone number exists in SafeList. + tags: + - AccountsV1Safelist + parameters: + - name: PhoneNumber + in: query + description: The phone number to be fetched from SafeList. Phone numbers must + be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 0 + examples: + fetch: + value: '+18001234567' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accounts.v1.safelist' + examples: + fetch: + value: + sid: GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+18001234567' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchSafelist + delete: + description: Remove a phone number from SafeList. + tags: + - AccountsV1Safelist + parameters: + - name: PhoneNumber + in: query + description: The phone number to be removed from SafeList. Phone numbers must + be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 0 + examples: + delete: + value: '+18001234567' + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSafelist /v1/AuthTokens/Secondary: servers: - url: https://accounts.twilio.com @@ -628,34 +908,47 @@ paths: - account_sid - secondary_auth_token - date_created - pathType: instance mountName: secondary_auth_token + pathType: instance post: description: Create a new secondary Auth Token + tags: + - AccountsV1SecondaryAuthToken responses: '201': content: application/json: schema: $ref: '#/components/schemas/accounts.v1.secondary_auth_token' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + secondary_auth_token: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + url: https://accounts.twilio.com/v1/AuthTokens/Secondary description: Created security: - accountSid_authToken: [] operationId: CreateSecondaryAuthToken - x-maturity: - - GA delete: description: Delete the secondary Auth Token from your account + tags: + - AccountsV1SecondaryAuthToken responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSecondaryAuthToken - x-maturity: - - GA servers: - url: https://accounts.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: AccountsV1AuthTokenPromotion +- name: AccountsV1Aws +- name: AccountsV1PublicKey +- name: AccountsV1Safelist +- name: AccountsV1SecondaryAuthToken +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index 8197bf9d..265164d7 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: api.v2010.account: type: object @@ -8,6 +12,10 @@ components: nullable: true description: The authorization token for this account. This token should be kept a secret, so no sharing. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -25,6 +33,10 @@ components: nullable: true description: A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address. + x-twilio: + pii: + handling: standard + deleteSla: 30 owner_account_sid: type: string minLength: 34 @@ -62,6 +74,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Account")' account_enum_status: type: string enum: @@ -93,6 +106,10 @@ components: nullable: true description: The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -109,6 +126,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 iso_country: type: string format: iso-country-code @@ -118,6 +139,10 @@ components: type: string nullable: true description: The postal code of the address. + x-twilio: + pii: + handling: standard + deleteSla: 30 region: type: string nullable: true @@ -134,6 +159,10 @@ components: type: string nullable: true description: The number and street address of the address. + x-twilio: + pii: + handling: standard + deleteSla: 30 uri: type: string nullable: true @@ -161,6 +190,11 @@ components: type: string nullable: true description: The additional number and street address of the address. + x-twilio: + pii: + handling: standard + deleteSla: 30 + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Address")' api.v2010.account.application: type: object properties: @@ -321,6 +355,7 @@ components: nullable: true description: 'Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Application")' api.v2010.account.authorized_connect_app: type: object properties: @@ -356,18 +391,6 @@ components: pattern: ^CN[0-9a-fA-F]{32}$ nullable: true description: The SID that we assigned to the Connect App. - date_created: - type: string - format: date-time-rfc-2822 - 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-rfc-2822 - 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. permissions: type: array items: @@ -380,6 +403,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthorizedConnectApp")' authorized_connect_app_enum_permission: type: string enum: @@ -415,6 +439,7 @@ components: nullable: true description: A list of related AvailablePhoneNumber resources identified by their URIs relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumberCountry")' api.v2010.account.available_phone_number_country.available_phone_number_local: type: object properties: @@ -502,6 +527,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Local")' api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine: type: object properties: @@ -589,6 +615,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "MachineToMachine")' api.v2010.account.available_phone_number_country.available_phone_number_mobile: type: object properties: @@ -676,6 +703,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Mobile")' api.v2010.account.available_phone_number_country.available_phone_number_national: type: object properties: @@ -763,6 +791,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "National")' api.v2010.account.available_phone_number_country.available_phone_number_shared_cost: type: object properties: @@ -850,6 +879,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "SharedCost")' api.v2010.account.available_phone_number_country.available_phone_number_toll_free: type: object properties: @@ -937,6 +967,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "TollFree")' api.v2010.account.available_phone_number_country.available_phone_number_voip: type: object properties: @@ -1024,6 +1055,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Voip")' api.v2010.account.balance: type: object properties: @@ -1044,6 +1076,7 @@ components: type: string nullable: true description: The units of currency for the account balance + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Balance")' api.v2010.account.call: type: object properties: @@ -1089,6 +1122,10 @@ components: format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`. + x-twilio: + pii: + handling: standard + deleteSla: 120 to_formatted: type: string nullable: true @@ -1096,6 +1133,10 @@ components: this call. Formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750). + x-twilio: + pii: + handling: standard + deleteSla: 120 from: type: string nullable: true @@ -1104,12 +1145,20 @@ components: format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`. + x-twilio: + pii: + handling: standard + deleteSla: 120 from_formatted: type: string nullable: true description: The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750). + x-twilio: + pii: + handling: standard + deleteSla: 120 phone_number_sid: type: string minLength: 34 @@ -1182,6 +1231,10 @@ components: description: The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty. + x-twilio: + pii: + handling: standard + deleteSla: 120 group_sid: type: string minLength: 34 @@ -1195,6 +1248,10 @@ components: nullable: true description: The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty. + x-twilio: + pii: + handling: standard + deleteSla: 120 queue_time: type: string nullable: true @@ -1218,6 +1275,7 @@ components: nullable: true description: A list of subresources available to this call, identified by their URIs relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Call")' call_enum_event: type: string enum: @@ -1247,154 +1305,19 @@ components: request: nullable: true description: Contains a dictionary representing the request of the call. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 response: nullable: true description: Contains a dictionary representing the call response, including a list of the call events. - api.v2010.account.call.call_feedback: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) - responsible for this resource. - date_created: - type: string - format: date-time-rfc-2822 - nullable: true - description: The date that this resource was created, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) - format. - date_updated: - type: string - format: date-time-rfc-2822 - nullable: true - description: The date that this resource was last updated, given in [RFC - 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) - format. - issues: - type: array - items: - type: string - $ref: '#/components/schemas/call_feedback_enum_issues' - nullable: true - description: 'A list of issues experienced during the call. The issues can - be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, - `digits-not-captured`, `audio-latency`, `unsolicited-call`, or `one-way-audio`.' - quality_score: - type: integer - nullable: true - description: '`1` to `5` quality score where `1` represents imperfect experience - and `5` represents a perfect call.' - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^CA[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies this resource. - call_feedback_enum_issues: - type: string - enum: - - audio-latency - - digits-not-captured - - dropped-call - - imperfect-audio - - incorrect-caller-id - - one-way-audio - - post-dial-delay - - unsolicited-call - api.v2010.account.call.call_feedback_summary: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) - responsible for this resource. - call_count: - type: integer - nullable: true - description: The total number of calls. - call_feedback_count: - type: integer - nullable: true - description: The total number of calls with a feedback entry. - date_created: - type: string - format: date-time-rfc-2822 - nullable: true - description: The date that this resource was created, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) - format. - date_updated: - type: string - format: date-time-rfc-2822 - nullable: true - description: The date that this resource was last updated, given in [RFC - 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) - format. - end_date: - type: string - format: date - nullable: true - description: The last date for which feedback entries are included in this - Feedback Summary, formatted as `YYYY-MM-DD` and specified in UTC. - include_subaccounts: - type: boolean - nullable: true - description: Whether the feedback summary includes subaccounts; `true` if - it does, otherwise `false`. - issues: - type: array - items: {} - nullable: true - description: 'A list of issues experienced during the call. The issues can - be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, - `digits-not-captured`, `audio-latency`, or `one-way-audio`.' - quality_score_average: - type: number - nullable: true - description: The average QualityScore of the feedback entries. - quality_score_median: - type: number - nullable: true - description: The median QualityScore of the feedback entries. - quality_score_standard_deviation: - type: number - nullable: true - description: The standard deviation of the quality scores. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^FS[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies this resource. - start_date: - type: string - format: date - nullable: true - description: The first date for which feedback entries are included in this - feedback summary, formatted as `YYYY-MM-DD` and specified in UTC. - status: - type: string - $ref: '#/components/schemas/call_feedback_summary_enum_status' - nullable: true - description: The status of the feedback summary can be `queued`, `in-progress`, - `completed`, or `failed`. - call_feedback_summary_enum_status: - type: string - enum: - - queued - - in-progress - - completed - - failed + x-twilio: + pii: + handling: sensitive + deleteSla: 30 + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Event")' api.v2010.account.call.call_notification: type: object properties: @@ -1493,6 +1416,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Notification")' api.v2010.account.call.call_notification-instance: type: object properties: @@ -1717,6 +1641,7 @@ components: type: string nullable: true description: 'The recorded track. Can be: `inbound`, `outbound`, or `both`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recording")' call_recording_enum_status: type: string enum: @@ -1814,6 +1739,7 @@ components: pattern: ^CA[0-9a-fA-F]{32}$ nullable: true description: The call SID that caused the conference to end. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Conference")' conference_enum_status: type: string enum: @@ -1939,6 +1865,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recording")' conference_recording_enum_status: type: string enum: @@ -1975,10 +1902,18 @@ components: nullable: true description: The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App. + x-twilio: + pii: + handling: standard + deleteSla: 30 company_name: type: string nullable: true description: The company name set for the Connect App. + x-twilio: + pii: + handling: standard + deleteSla: 30 deauthorize_callback_method: type: string format: http-method @@ -1997,20 +1932,36 @@ components: nullable: true description: The URL we call using the `deauthorize_callback_method` to de-authorize the Connect App. + x-twilio: + pii: + handling: standard + deleteSla: 30 description: type: string nullable: true description: The description of the Connect App. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 homepage_url: type: string format: uri nullable: true description: The public URL where users can obtain more information about this Connect App. + x-twilio: + pii: + handling: standard + deleteSla: 30 permissions: type: array items: @@ -2030,6 +1981,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ConnectApp")' connect_app_enum_permission: type: string enum: @@ -2059,6 +2011,10 @@ components: format: phone-number nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 phone_number: type: string format: phone-number @@ -2241,6 +2197,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "DependentPhoneNumber")' dependent_phone_number_enum_address_requirement: type: string enum: @@ -2318,6 +2275,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity_sid: type: string minLength: 34 @@ -2517,6 +2478,7 @@ components: status: type: string nullable: true + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IncomingPhoneNumber")' incoming_phone_number_enum_address_requirement: type: string enum: @@ -2572,6 +2534,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 description: type: string nullable: true @@ -2607,6 +2573,7 @@ components: format: uri-map nullable: true description: A list of related resources identified by their relative URIs. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AssignedAddOn")' ? api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension : type: object properties: @@ -2643,6 +2610,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 product_name: type: string nullable: true @@ -2662,6 +2633,7 @@ components: type: boolean nullable: true description: Whether the Extension will be invoked. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AssignedAddOnExtension")' api.v2010.account.incoming_phone_number.incoming_phone_number_local: type: object properties: @@ -2727,6 +2699,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity_sid: type: string minLength: 34 @@ -2925,6 +2901,7 @@ components: status: type: string nullable: true + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Local")' incoming_phone_number_local_enum_address_requirement: type: string enum: @@ -3016,6 +2993,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity_sid: type: string minLength: 34 @@ -3214,6 +3195,7 @@ components: status: type: string nullable: true + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Mobile")' incoming_phone_number_mobile_enum_address_requirement: type: string enum: @@ -3305,6 +3287,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity_sid: type: string minLength: 34 @@ -3503,6 +3489,7 @@ components: status: type: string nullable: true + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "TollFree")' incoming_phone_number_toll_free_enum_address_requirement: type: string enum: @@ -3544,6 +3531,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -3556,6 +3547,7 @@ components: 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. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Key")' api.v2010.account.message.media: type: object properties: @@ -3566,43 +3558,45 @@ components: 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 this Media resource. + associated with this Media resource. content_type: type: string nullable: true - description: The default [mime-type](https://en.wikipedia.org/wiki/Internet_media_type) - of the media, for example `image/jpeg`, `image/png`, or `image/gif` + description: The default [MIME type](https://en.wikipedia.org/wiki/Internet_media_type) + of the media, for example `image/jpeg`, `image/png`, or `image/gif`. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The date and time in GMT that this resource was created specified - in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + description: The date and time in GMT when this Media resource was created, + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time-rfc-2822 nullable: true - description: The date and time in GMT that this resource was last updated, - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + description: The date and time in GMT when this Media resource was last + updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) + format. parent_sid: type: string minLength: 34 maxLength: 34 pattern: ^(SM|MM)[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource that created the media. + description: The SID of the Message resource that is associated with this + Media resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^ME[0-9a-fA-F]{32}$ nullable: true - description: The unique string that that we created to identify this Media - resource. + description: The unique string that identifies this Media resource. uri: type: string nullable: true - description: The URI of this resource, relative to `https://api.twilio.com`. + description: The URI of this Media resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Media")' api.v2010.account.queue.member: type: object properties: @@ -3638,70 +3632,84 @@ components: pattern: ^QU[0-9a-fA-F]{32}$ nullable: true description: The SID of the Queue the member is in. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Member")' api.v2010.account.message: type: object properties: body: type: string nullable: true - description: The message text. Can be up to 1,600 characters long. + description: The text content of the message + x-twilio: + pii: + handling: standard + deleteSla: 30 num_segments: type: string nullable: true description: 'The number of segments that make up the complete message. - A message body that is too large to be sent in a single SMS message is - segmented and charged as multiple messages. Inbound messages over 160 - characters are reassembled when the message is received. Note: When using - a Messaging Service to send messages, `num_segments` will always be 0 - in Twilio''s response to your API request.' + SMS message bodies that exceed the [character limit](https://www.twilio.com/docs/glossary/what-sms-character-limit) + are segmented and charged as multiple messages. Note: For messages sent + via a Messaging Service, `num_segments` is initially `0`, since a sender + hasn''t yet been assigned.' direction: type: string $ref: '#/components/schemas/message_enum_direction' nullable: true description: 'The direction of the message. Can be: `inbound` for incoming - messages, `outbound-api` for messages initiated by a REST API, `outbound-call` - for messages initiated during a call, or `outbound-reply` for messages - initiated in response to an incoming message.' + messages, `outbound-api` for messages created by the REST API, `outbound-call` + for messages created during a call, or `outbound-reply` for messages created + in response to an incoming message.' from: type: string format: phone-number nullable: true - description: The phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) - format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), - or [Wireless SIM](https://www.twilio.com/docs/wireless/tutorials/communications-guides/how-to-send-and-receive-text-messages) - that initiated the message. For incoming messages, this will be the number - of the sending phone. For outgoing messages, this value will be one of - your Twilio phone numbers or the alphanumeric sender ID used. + description: The sender's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) + format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), + [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), + [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), + or [channel address](https://www.twilio.com/docs/messaging/channels) + (e.g., `whatsapp:+15554449999`). For incoming messages, this is the number + or channel address of the sender. For outgoing messages, this value is + a Twilio phone number, alphanumeric sender ID, short code, or channel + address from which the message is sent. + x-twilio: + pii: + handling: standard + deleteSla: 120 to: type: string nullable: true - description: The phone number in [E.164](https://en.wikipedia.org/wiki/E.164) - format that received the message. For incoming messages, this will be - one of your Twilio phone numbers. For outgoing messages, this will be - the sending phone. + description: The recipient's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) + format) or [channel address](https://www.twilio.com/docs/messaging/channels) + (e.g. `whatsapp:+15552229999`) + x-twilio: + pii: + handling: standard + deleteSla: 120 date_updated: type: string format: date-time-rfc-2822 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. + description: The [RFC 2822](https://datatracker.ietf.org/doc/html/rfc2822#section-3.3) + timestamp (in GMT) of when the Message resource was last updated price: type: string nullable: true - description: The amount billed for the message, in the currency specified - by `price_unit`. Note that your account is charged for each segment we - send to the handset. Populated after the message has been sent. May not - be immediately available. + description: The amount billed for the message in the currency specified + by `price_unit`. The `price` is populated after the message has been sent/received, + and may not be immediately availalble. View the [Pricing page](https://www.twilio.com/en-us/pricing) + for more details. error_message: type: string nullable: true - description: The description of the `error_code` if your message `status` - is `failed` or `undelivered`. If the message was successful, this value - is null. + description: The description of the `error_code` if the Message `status` + is `failed` or `undelivered`. If no error was encountered, the value is + `null`. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com`. + description: The URI of the Message resource, relative to `https://api.twilio.com`. account_sid: type: string minLength: 34 @@ -3709,17 +3717,16 @@ components: pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that sent the message that created the resource. + associated with the Message resource num_media: type: string nullable: true - description: The number of media files associated with the message. A message - can send up to 10 media files. + description: The number of media files associated with the Message resource. status: type: string $ref: '#/components/schemas/message_enum_status' nullable: true - description: 'The status of the message. Can be: `accepted`, `scheduled`, + description: 'The status of the Message. Possible values: `accepted`, `scheduled`, `canceled`, `queued`, `sending`, `sent`, `failed`, `delivered`, `undelivered`, `receiving`, `received`, or `read` (WhatsApp only). For more information, See [detailed descriptions](https://www.twilio.com/docs/sms/api/message-resource#message-status-values).' @@ -3729,37 +3736,37 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) - used with the message. The value is null if a Messaging Service was not - used. + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) + associated with the Message resource. The value is `null` if a Messaging + Service was not used. sid: type: string minLength: 34 maxLength: 34 pattern: ^(SM|MM)[0-9a-fA-F]{32}$ nullable: true - description: The unique string that that we created to identify the Message + description: The unique, Twilio-provided string that identifies the Message resource. date_sent: type: string format: date-time-rfc-2822 nullable: true - description: 'The date and time in GMT that the resource was sent specified - in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. For outgoing - messages, this is when we sent the message. For incoming messages, this - is when we made the HTTP request to your application. ' + description: The [RFC 2822](https://datatracker.ietf.org/doc/html/rfc2822#section-3.3) + timestamp (in GMT) of when the Message was sent. For an outgoing message, + this is when Twilio sent the message. For an incoming message, this is + when Twilio sent the HTTP request to your incoming message webhook URL. date_created: type: string format: date-time-rfc-2822 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. + description: The [RFC 2822](https://datatracker.ietf.org/doc/html/rfc2822#section-3.3) + timestamp (in GMT) of when the Message resource was created error_code: type: integer nullable: true - description: The error code returned if your message `status` is `failed` - or `undelivered`. The error_code provides more information about the failure. - If the message was successful, this value is null. + description: The [error code](https://www.twilio.com/docs/api/errors) returned + if the Message `status` is `failed` or `undelivered`. If no error was + encountered, the value is `null`. price_unit: type: string format: currency @@ -3769,13 +3776,14 @@ components: api_version: type: string nullable: true - description: The API version used to process the message. + description: The API version used to process the Message subresource_uris: type: object format: uri-map nullable: true description: A list of related resources identified by their URIs relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Message")' message_enum_status: type: string enum: @@ -3807,10 +3815,12 @@ components: type: string enum: - retain + - discard message_enum_address_retention: type: string enum: - retain + - obfuscate message_enum_traffic_type: type: string enum: @@ -3819,6 +3829,11 @@ components: type: string enum: - fixed + message_enum_risk_check: + type: string + enum: + - enable + - disable api.v2010.account.message.message_feedback: type: object properties: @@ -3829,39 +3844,42 @@ components: 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 MessageFeedback resource. + associated with this MessageFeedback resource. message_sid: type: string minLength: 34 maxLength: 34 pattern: ^(SM|MM)[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Message resource for which the feedback was - provided. + description: The SID of the Message resource associated with this MessageFeedback + resource. outcome: type: string $ref: '#/components/schemas/message_feedback_enum_outcome' nullable: true - description: 'Whether the feedback has arrived. Can be: `unconfirmed` or - `confirmed`. If `provide_feedback`=`true` in [the initial HTTP POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), - the initial value of this property is `unconfirmed`. After the message - arrives, update the value to `confirmed`.' + description: 'Reported outcome indicating whether there is confirmation + that the Message recipient performed a tracked user action. Can be: `unconfirmed` + or `confirmed`. For more details see [How to Optimize Message Deliverability + with Message Feedback](https://www.twilio.com/docs/messaging/guides/send-message-feedback-to-twilio).' date_created: type: string format: date-time-rfc-2822 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. + description: The date and time in GMT when this MessageFeedback resource + was created, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) + format. date_updated: type: string format: date-time-rfc-2822 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. + description: The date and time in GMT when this MessageFeedback resource + was last updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) + format. uri: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Feedback")' message_feedback_enum_outcome: type: string enum: @@ -3883,6 +3901,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -3902,6 +3924,7 @@ components: to authenticate to the REST API (you will use this as the basic-auth `password`). **Note that for security reasons, this field is ONLY returned when the API Key is first created.** + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "NewKey")' api.v2010.account.new_signing_key: type: object properties: @@ -3917,6 +3940,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -3936,6 +3963,7 @@ components: to authenticate to the REST API (you will use this as the basic-auth `password`). **Note that for security reasons, this field is ONLY returned when the API Key is first created.** + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "NewSigningKey")' api.v2010.account.notification: type: object properties: @@ -4036,6 +4064,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Notification")' api.v2010.account.notification-instance: type: object properties: @@ -4177,6 +4206,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -4192,10 +4225,15 @@ components: description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. + x-twilio: + pii: + handling: standard + deleteSla: 30 uri: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "OutgoingCallerId")' api.v2010.account.conference.participant: type: object properties: @@ -4287,6 +4325,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Participant")' participant_enum_status: type: string enum: @@ -4339,6 +4378,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Payment")' payments_enum_payment_method: type: string enum: @@ -4422,6 +4462,7 @@ components: nullable: true description: ' The maximum number of calls that can be in the queue. The default is 1000 and the maximum is 5000.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Queue")' api.v2010.account.recording: type: object properties: @@ -4540,6 +4581,7 @@ components: nullable: true description: The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recording")' recording_enum_status: type: string enum: @@ -4630,6 +4672,7 @@ components: format: uri-map nullable: true description: A list of related resources identified by their relative URIs. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AddOnResult")' recording_add_on_result_enum_status: type: string enum: @@ -4714,6 +4757,7 @@ components: format: uri-map nullable: true description: A list of related resources identified by their relative URIs. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Payload")' api.v2010.account.recording.recording_transcription: type: object properties: @@ -4783,6 +4827,10 @@ components: type: string nullable: true description: The text content of the transcription. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string nullable: true @@ -4791,6 +4839,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Transcription")' recording_transcription_enum_status: type: string enum: @@ -4884,6 +4933,7 @@ components: type: string nullable: true description: The URI of this resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ShortCode")' api.v2010.account.signing_key: type: object properties: @@ -4904,15 +4954,19 @@ components: type: string format: date-time-rfc-2822 nullable: true + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "SigningKey")' api.v2010.account.sip: type: object properties: {} + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Sip")' api.v2010.account.sip.sip_domain.sip_auth: type: object properties: {} + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthTypes")' api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls: type: object properties: {} + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthTypeCalls")' api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping: type: object properties: @@ -4940,6 +4994,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 0 sid: type: string minLength: 34 @@ -4948,6 +5006,7 @@ components: nullable: true description: The unique string that that we created to identify the CredentialListMapping resource. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthCallsCredentialListMapping")' api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping: type: object properties: @@ -4975,6 +5034,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 0 sid: type: string minLength: 34 @@ -4983,9 +5046,11 @@ components: nullable: true description: The unique string that that we created to identify the IpAccessControlListMapping resource. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthCallsIpAccessControlListMapping")' api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations: type: object properties: {} + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthTypeRegistrations")' api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping: type: object properties: @@ -5013,6 +5078,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 0 sid: type: string minLength: 34 @@ -5021,6 +5090,7 @@ components: nullable: true description: The unique string that that we created to identify the CredentialListMapping resource. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthRegistrationsCredentialListMapping")' api.v2010.account.sip.sip_credential_list.sip_credential: type: object properties: @@ -5050,6 +5120,10 @@ components: type: string nullable: true description: The username for this credential. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -5068,6 +5142,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Credential")' api.v2010.account.sip.sip_credential_list: type: object properties: @@ -5114,6 +5189,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "CredentialList")' api.v2010.account.sip.sip_domain.sip_credential_list_mapping: type: object properties: @@ -5162,6 +5238,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "CredentialListMapping")' api.v2010.account.sip.sip_domain: type: object properties: @@ -5237,6 +5314,10 @@ components: nullable: true description: The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`. + x-twilio: + pii: + handling: standard + deleteSla: 30 voice_method: type: string format: http-method @@ -5269,12 +5350,20 @@ components: nullable: true description: The URL that we call to pass status parameters (such as call ended) to your application. + x-twilio: + pii: + handling: standard + deleteSla: 30 voice_url: type: string format: uri nullable: true description: The URL we call using the `voice_method` when the domain receives a call. + x-twilio: + pii: + handling: standard + deleteSla: 30 subresource_uris: type: object format: uri-map @@ -5315,6 +5404,7 @@ components: 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. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Domain")' api.v2010.account.sip.sip_ip_access_control_list: type: object properties: @@ -5361,6 +5451,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAccessControlList")' api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping: type: object properties: @@ -5409,6 +5500,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAccessControlListMapping")' api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address: type: object properties: @@ -5469,6 +5561,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAddress")' api.v2010.account.call.siprec: type: object properties: @@ -5515,6 +5608,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Siprec")' siprec_enum_track: type: string enum: @@ -5530,6 +5624,21 @@ components: type: string enum: - stopped + sms_message_enum_status: + type: string + enum: + - queued + - sending + - sent + - failed + - received + sms_message_enum_direction: + type: string + enum: + - inbound + - outbound-api + - outbound-call + - outbound-reply api.v2010.account.call.stream: type: object properties: @@ -5576,6 +5685,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Stream")' stream_enum_track: type: string enum: @@ -5645,6 +5755,7 @@ components: type: string nullable: true description: The temporary username that uniquely identifies a Token. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Token")' api.v2010.account.transcription: type: object properties: @@ -5714,6 +5825,10 @@ components: type: string nullable: true description: The text content of the transcription. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string nullable: true @@ -5722,6 +5837,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Transcription")' transcription_enum_status: type: string enum: @@ -5731,6 +5847,7 @@ components: api.v2010.account.usage: type: object properties: {} + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Usage")' api.v2010.account.usage.usage_record: type: object properties: @@ -5812,6 +5929,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Record")' usage_record_enum_category: type: string enum: @@ -5998,6 +6116,7 @@ components: - trunking-recordings - trunking-secure - trunking-termination + - tts-google - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil @@ -6019,6 +6138,9 @@ components: - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute + - voice-intelligence + - voice-intelligence-transcription + - voice-intelligence-operators - wireless - wireless-orders - wireless-orders-artwork @@ -6141,6 +6263,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AllTime")' usage_record_all_time_enum_category: type: string enum: @@ -6327,6 +6450,7 @@ components: - trunking-recordings - trunking-secure - trunking-termination + - tts-google - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil @@ -6348,6 +6472,9 @@ components: - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute + - voice-intelligence + - voice-intelligence-transcription + - voice-intelligence-operators - wireless - wireless-orders - wireless-orders-artwork @@ -6470,6 +6597,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Daily")' usage_record_daily_enum_category: type: string enum: @@ -6656,6 +6784,7 @@ components: - trunking-recordings - trunking-secure - trunking-termination + - tts-google - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil @@ -6677,6 +6806,9 @@ components: - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute + - voice-intelligence + - voice-intelligence-transcription + - voice-intelligence-operators - wireless - wireless-orders - wireless-orders-artwork @@ -6799,6 +6931,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "LastMonth")' usage_record_last_month_enum_category: type: string enum: @@ -6985,6 +7118,7 @@ components: - trunking-recordings - trunking-secure - trunking-termination + - tts-google - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil @@ -7006,6 +7140,9 @@ components: - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute + - voice-intelligence + - voice-intelligence-transcription + - voice-intelligence-operators - wireless - wireless-orders - wireless-orders-artwork @@ -7128,6 +7265,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Monthly")' usage_record_monthly_enum_category: type: string enum: @@ -7314,6 +7452,7 @@ components: - trunking-recordings - trunking-secure - trunking-termination + - tts-google - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil @@ -7335,6 +7474,9 @@ components: - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute + - voice-intelligence + - voice-intelligence-transcription + - voice-intelligence-operators - wireless - wireless-orders - wireless-orders-artwork @@ -7457,6 +7599,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ThisMonth")' usage_record_this_month_enum_category: type: string enum: @@ -7643,6 +7786,7 @@ components: - trunking-recordings - trunking-secure - trunking-termination + - tts-google - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil @@ -7664,6 +7808,9 @@ components: - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute + - voice-intelligence + - voice-intelligence-transcription + - voice-intelligence-operators - wireless - wireless-orders - wireless-orders-artwork @@ -7786,6 +7933,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Today")' usage_record_today_enum_category: type: string enum: @@ -7972,6 +8120,7 @@ components: - trunking-recordings - trunking-secure - trunking-termination + - tts-google - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil @@ -7993,6 +8142,9 @@ components: - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute + - voice-intelligence + - voice-intelligence-transcription + - voice-intelligence-operators - wireless - wireless-orders - wireless-orders-artwork @@ -8115,6 +8267,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Yearly")' usage_record_yearly_enum_category: type: string enum: @@ -8301,6 +8454,7 @@ components: - trunking-recordings - trunking-secure - trunking-termination + - tts-google - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil @@ -8322,6 +8476,9 @@ components: - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute + - voice-intelligence + - voice-intelligence-transcription + - voice-intelligence-operators - wireless - wireless-orders - wireless-orders-artwork @@ -8444,6 +8601,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Yesterday")' usage_record_yesterday_enum_category: type: string enum: @@ -8630,6 +8788,7 @@ components: - trunking-recordings - trunking-secure - trunking-termination + - tts-google - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil @@ -8651,6 +8810,9 @@ components: - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute + - voice-intelligence + - voice-intelligence-transcription + - voice-intelligence-operators - wireless - wireless-orders - wireless-orders-artwork @@ -8726,6 +8888,10 @@ components: nullable: true description: The URL we call using the `callback_method` when the trigger fires. + x-twilio: + pii: + handling: sensitive + deleteSla: 60 current_value: type: string nullable: true @@ -8795,6 +8961,7 @@ components: nullable: true description: The URI of the [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource this trigger watches, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Trigger")' usage_trigger_enum_usage_category: type: string enum: @@ -8981,6 +9148,7 @@ components: - trunking-recordings - trunking-secure - trunking-termination + - tts-google - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil @@ -9002,6 +9170,9 @@ components: - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute + - voice-intelligence + - voice-intelligence-transcription + - voice-intelligence-operators - wireless - wireless-orders - wireless-orders-artwork @@ -9088,6 +9259,7 @@ components: nullable: true description: The date that this User Defined Message was created, given in RFC 2822 format. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UserDefinedMessage")' api.v2010.account.call.user_defined_message_subscription: type: object properties: @@ -9127,6 +9299,7 @@ components: nullable: true description: The URI of the User Defined Message Subscription Resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UserDefinedMessageSubscription")' api.v2010.account.validation_request: type: object properties: @@ -9150,6 +9323,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 phone_number: type: string format: phone-number @@ -9157,15 +9334,16 @@ components: description: The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. + x-twilio: + pii: + handling: standard + deleteSla: 30 validation_code: type: string nullable: true description: The 6 digit validation code that someone must enter to validate the Caller ID when `phone_number` is called. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ValidationRequest")' info: title: Twilio - Api description: This is the public Twilio REST API. @@ -9177,7 +9355,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /2010-04-01/Accounts.json: @@ -9189,48 +9367,155 @@ paths: - sid - friendly_name - status - pathType: list dependentProperties: - address: '{account_sid: sid}' - application: '{account_sid: sid}' - authorized_connect_app: '{account_sid: sid}' - available_phone_number_country: '{account_sid: sid}' - balance: '{account_sid: sid}' - call: '{account_sid: sid}' - conference: '{account_sid: sid}' - connect_app: '{account_sid: sid}' - incoming_phone_number: '{account_sid: sid}' - key: '{account_sid: sid}' - message: '{account_sid: sid}' - api/v2010/message_real_resource: '{account_sid: sid}' - new_key: '{account_sid: sid}' - new_signing_key: '{account_sid: sid}' - notification: '{account_sid: sid}' - outgoing_caller_id: '{account_sid: sid}' - queue: '{account_sid: sid}' - recording: '{account_sid: sid}' - signing_key: '{account_sid: sid}' - sip: '{account_sid: sid}' - api/v2010/sms: '{account_sid: sid}' - short_code: '{account_sid: sid}' - token: '{account_sid: sid}' - transcription: '{account_sid: sid}' - usage: '{account_sid: sid}' - validation_request: '{account_sid: sid}' + addresses: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Addresses.json + applications: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Applications.json + authorized_connect_apps: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/AuthorizedConnectApps.json + available_phone_numbers: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers.json + balance: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Balance.json + calls: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls.json + conferences: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Conferences.json + connect_apps: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/ConnectApps.json + incoming_phone_numbers: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers.json + keys: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Keys.json + messages: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Messages.json + new_keys: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Keys.json + new_signing_keys: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SigningKeys.json + notifications: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Notifications.json + outgoing_caller_ids: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/OutgoingCallerIds.json + queues: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Queues.json + recordings: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings.json + signing_keys: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SigningKeys.json + sip: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP.json + sms: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SMS.json + short_codes: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SMS/ShortCodes.json + tokens: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Tokens.json + transcriptions: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Transcriptions.json + usage: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Usage.json + validation_requests: + mapping: + account_sid: sid + 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 + tags: + - Api20100401Account responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account' + examples: + create: + value: + auth_token: auth_token + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + owner_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + subresource_uris: + available_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + calls: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json + conferences: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json + incoming_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + outgoing_caller_ids: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json + signing_keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json + connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json + sip: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json + authorized_connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json + usage: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json + keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json + applications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json + short_codes: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + queues: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json + messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json + balance: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json + type: Full + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateAccount - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -9242,9 +9527,15 @@ paths: type: string description: A human readable description of the account to create, defaults to `SubAccount Created at {YYYY-MM-DD HH:MM meridian}` + examples: + create: + value: + FriendlyName: friendly_name get: description: Retrieves a collection of Accounts belonging to the account used to make the request + tags: + - Api20100401Account parameters: - name: FriendlyName in: query @@ -9252,6 +9543,15 @@ paths: match this name. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: friendly_name + readFull: + value: friendly_name - name: Status in: query description: Only return Account resources with the given status. Can be `closed`, @@ -9259,6 +9559,11 @@ paths: schema: type: string $ref: '#/components/schemas/account_enum_status' + examples: + readEmpty: + value: active + readFull: + value: active - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9283,41 +9588,133 @@ paths: content: application/json: schema: - type: object - title: ListAccountResponse - properties: - accounts: - type: array - items: - $ref: '#/components/schemas/api.v2010.account' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListAccountResponse + properties: + accounts: + type: array + items: + $ref: '#/components/schemas/api.v2010.account' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Account") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Account")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Accounts")' + examples: + readEmpty: + value: + first_page_uri: /2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0 + end: 0 + previous_page_uri: null + accounts: [] + uri: /2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readFull: + value: + first_page_uri: /2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0 + end: 0 + previous_page_uri: null + accounts: + - auth_token: auth_token + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + owner_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + subresource_uris: + available_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + calls: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json + conferences: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json + incoming_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + outgoing_caller_ids: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json + signing_keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json + connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json + sip: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json + authorized_connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json + usage: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json + keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json + applications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json + short_codes: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + queues: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json + messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json + balance: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json + type: Full + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + uri: /2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListAccount - x-maturity: - - GA /2010-04-01/Accounts/{Sid}.json: servers: - url: https://api.twilio.com @@ -9327,36 +9724,112 @@ paths: - sid - friendly_name - status - pathType: instance dependentProperties: - address: '{account_sid: sid}' - application: '{account_sid: sid}' - authorized_connect_app: '{account_sid: sid}' - available_phone_number_country: '{account_sid: sid}' - balance: '{account_sid: sid}' - call: '{account_sid: sid}' - conference: '{account_sid: sid}' - connect_app: '{account_sid: sid}' - incoming_phone_number: '{account_sid: sid}' - key: '{account_sid: sid}' - message: '{account_sid: sid}' - api/v2010/message_real_resource: '{account_sid: sid}' - new_key: '{account_sid: sid}' - new_signing_key: '{account_sid: sid}' - notification: '{account_sid: sid}' - outgoing_caller_id: '{account_sid: sid}' - queue: '{account_sid: sid}' - recording: '{account_sid: sid}' - signing_key: '{account_sid: sid}' - sip: '{account_sid: sid}' - api/v2010/sms: '{account_sid: sid}' - short_code: '{account_sid: sid}' - token: '{account_sid: sid}' - transcription: '{account_sid: sid}' - usage: '{account_sid: sid}' - validation_request: '{account_sid: sid}' + addresses: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Addresses.json + applications: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Applications.json + authorized_connect_apps: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/AuthorizedConnectApps.json + available_phone_numbers: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers.json + balance: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Balance.json + calls: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls.json + conferences: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Conferences.json + connect_apps: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/ConnectApps.json + incoming_phone_numbers: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers.json + keys: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Keys.json + messages: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Messages.json + new_keys: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Keys.json + new_signing_keys: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SigningKeys.json + notifications: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Notifications.json + outgoing_caller_ids: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/OutgoingCallerIds.json + queues: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Queues.json + recordings: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings.json + signing_keys: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SigningKeys.json + sip: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP.json + sms: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SMS.json + short_codes: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SMS/ShortCodes.json + tokens: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Tokens.json + transcriptions: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Transcriptions.json + usage: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Usage.json + validation_requests: + mapping: + account_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/OutgoingCallerIds.json + pathType: instance get: description: Fetch the account specified by the provided Account Sid + tags: + - Api20100401Account parameters: - name: Sid in: path @@ -9373,14 +9846,47 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account' + examples: + fetch: + value: + auth_token: auth_token + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + owner_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + subresource_uris: + available_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + calls: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json + conferences: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json + incoming_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + outgoing_caller_ids: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json + signing_keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json + connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json + sip: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json + authorized_connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json + usage: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json + keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json + applications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json + short_codes: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + queues: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json + messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json + balance: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json + type: Full + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchAccount - x-maturity: - - GA post: description: Modify the properties of a given Account + tags: + - Api20100401Account parameters: - name: Sid in: path @@ -9397,12 +9903,75 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account' + examples: + update: + value: + auth_token: auth_token + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + owner_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + subresource_uris: + available_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + calls: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json + conferences: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json + incoming_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + outgoing_caller_ids: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json + signing_keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json + connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json + sip: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json + authorized_connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json + usage: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json + keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json + applications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json + short_codes: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + queues: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json + messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json + balance: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json + type: Full + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + updateWithNumericStatus: + value: + auth_token: auth_token + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + owner_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + subresource_uris: + available_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + calls: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json + conferences: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json + incoming_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + outgoing_caller_ids: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json + signing_keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json + connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json + sip: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json + authorized_connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json + usage: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json + keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json + applications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json + short_codes: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + queues: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json + messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json + balance: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json + type: Full + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateAccount - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -9419,6 +9988,14 @@ paths: description: 'Alter the status of this account: use `closed` to irreversibly close this account, `suspended` to temporarily suspend it, or `active` to reactivate it.' + examples: + update: + value: + FriendlyName: friendly_name + Status: active + updateWithNumericStatus: + value: + Status: '1' /2010-04-01/Accounts/{AccountSid}/Addresses.json: servers: - url: https://api.twilio.com @@ -9432,12 +10009,18 @@ paths: - friendly_name - validated - verified - pathType: list dependentProperties: - dependent_phone_number: '{account_sid: account_sid, address_sid: sid}' + dependent_phone_numbers: + mapping: + account_sid: account_sid + address_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Addresses/{address_sid}/DependentPhoneNumbers.json parent: /Accounts/{Sid}.json + pathType: list post: description: '' + tags: + - Api20100401Address parameters: - name: AccountSid in: path @@ -9455,12 +10038,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.address' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + city: SF + customer_name: name + date_created: Tue, 18 Aug 2015 17:07:30 +0000 + date_updated: Tue, 18 Aug 2015 17:07:30 +0000 + emergency_enabled: false + friendly_name: null + iso_country: US + postal_code: '94019' + region: CA + sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + street: 4th + street_secondary: null + validated: false + verified: false + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -9511,8 +10111,20 @@ paths: - Region - PostalCode - IsoCountry + examples: + create: + value: + City: city + CustomerName: customer_name + FriendlyName: friendly_name + IsoCountry: US + PostalCode: postal_code + Region: region + Street: street get: description: '' + tags: + - Api20100401Address parameters: - name: AccountSid in: path @@ -9529,17 +10141,40 @@ paths: description: The `customer_name` of the Address resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readFull: + value: customer_name + readEmpty: + value: customer_name - name: FriendlyName in: query description: The string that identifies the Address resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: IsoCountry in: query description: The ISO country code of the Address resources to read. schema: type: string format: iso-country-code + examples: + readFull: + value: US + readEmpty: + value: US - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9564,41 +10199,125 @@ paths: content: application/json: schema: - type: object - title: ListAddressResponse - properties: - addresses: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.address' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListAddressResponse + properties: + addresses: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.address' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Address") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Address")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Addresses")' + examples: + readFull: + value: + addresses: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + city: SF + customer_name: name + date_created: Tue, 18 Aug 2015 17:07:30 +0000 + date_updated: Tue, 18 Aug 2015 17:07:30 +0000 + emergency_enabled: false + friendly_name: null + iso_country: US + postal_code: '94019' + region: CA + sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + street: 4th + street_secondary: null + validated: false + verified: false + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 + readEmpty: + value: + addresses: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListAddress - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json: servers: - url: https://api.twilio.com @@ -9612,12 +10331,18 @@ paths: - friendly_name - validated - verified - pathType: instance dependentProperties: - dependent_phone_number: '{account_sid: account_sid, address_sid: sid}' + dependent_phone_numbers: + mapping: + account_sid: account_sid + address_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Addresses/{address_sid}/DependentPhoneNumbers.json parent: /Accounts/{Sid}.json + pathType: instance delete: description: '' + tags: + - Api20100401Address parameters: - name: AccountSid in: path @@ -9645,10 +10370,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteAddress - x-maturity: - - GA get: description: '' + tags: + - Api20100401Address parameters: - name: AccountSid in: path @@ -9676,14 +10401,33 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.address' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + city: SF + customer_name: name + date_created: Tue, 18 Aug 2015 17:07:30 +0000 + date_updated: Tue, 18 Aug 2015 17:07:30 +0000 + emergency_enabled: false + friendly_name: null + iso_country: US + postal_code: '94019' + region: CA + sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + street: 4th + street_secondary: null + validated: false + verified: false + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchAddress - x-maturity: - - GA post: description: '' + tags: + - Api20100401Address parameters: - name: AccountSid in: path @@ -9711,12 +10455,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.address' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + city: SF + customer_name: name + date_created: Tue, 18 Aug 2015 17:07:30 +0000 + date_updated: Tue, 18 Aug 2015 17:07:30 +0000 + emergency_enabled: false + friendly_name: null + iso_country: US + postal_code: '94019' + region: CA + sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + street: 4th + street_secondary: null + validated: false + verified: false + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -9756,6 +10517,15 @@ paths: StreetSecondary: type: string description: The additional number and street address of the address. + examples: + update: + value: + City: city + CustomerName: customer_name + FriendlyName: friendly_name + PostalCode: postal_code + Region: region + Street: street /2010-04-01/Accounts/{AccountSid}/Applications.json: servers: - url: https://api.twilio.com @@ -9768,10 +10538,12 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Accounts/{Sid}.json + pathType: list post: description: Create a new application within your account + tags: + - Api20100401Application parameters: - name: AccountSid in: path @@ -9789,12 +10561,34 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.application' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Mon, 22 Aug 2011 20:59:45 +0000 + date_updated: Tue, 18 Aug 2015 16:48:57 +0000 + friendly_name: Application Friendly Name + message_status_callback: http://www.example.com/sms-status-callback + sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: http://www.example.com/sms-fallback + sms_method: GET + sms_status_callback: http://www.example.com/sms-status-callback + sms_url: http://example.com + status_callback: http://example.com + status_callback_method: GET + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_caller_id_lookup: false + voice_fallback_method: GET + voice_fallback_url: http://www.example.com/voice-callback + voice_method: GET + voice_url: http://example.com + public_application_connect_enabled: true description: Created security: - accountSid_authToken: [] operationId: CreateApplication - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -9915,9 +10709,29 @@ paths: type: boolean description: 'Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`.' + examples: + create: + value: + FriendlyName: friendly_name + MessageStatusCallback: https://example.com + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsStatusCallback: https://example.com + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceCallerIdLookup: true + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + PublicApplicationConnectEnabled: true get: description: Retrieve a list of applications representing an application within the requesting account + tags: + - Api20100401Application parameters: - name: AccountSid in: path @@ -9934,6 +10748,11 @@ paths: description: The string that identifies the Application resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9958,41 +10777,124 @@ paths: content: application/json: schema: - type: object - title: ListApplicationResponse - properties: - applications: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.application' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListApplicationResponse + properties: + applications: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.application' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Application") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Application")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Applications")' + examples: + readFull: + value: + applications: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Fri, 21 Aug 2015 00:07:25 +0000 + date_updated: Fri, 21 Aug 2015 00:07:25 +0000 + friendly_name: d8821fb7-4d01-48b2-bdc5-34e46252b90b + message_status_callback: null + sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: POST + sms_fallback_url: null + sms_method: POST + sms_status_callback: null + sms_url: null + status_callback: null + status_callback_method: POST + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + public_application_connect_enabled: false + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 + next_page_uri: null + previous_page_uri: null + page_size: 1 + page: 0 + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 + readEmpty: + value: + applications: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 + previous_page_uri: null + page_size: 1 + start: 0 + next_page_uri: null + page: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListApplication - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json: servers: - url: https://api.twilio.com @@ -10005,10 +10907,12 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance delete: description: Delete the application by the specified application sid + tags: + - Api20100401Application parameters: - name: AccountSid in: path @@ -10036,10 +10940,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteApplication - x-maturity: - - GA get: description: Fetch the application specified by the provided sid + tags: + - Api20100401Application parameters: - name: AccountSid in: path @@ -10067,14 +10971,38 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.application' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Mon, 22 Aug 2011 20:59:45 +0000 + date_updated: Tue, 18 Aug 2015 16:48:57 +0000 + friendly_name: Application Friendly Name + message_status_callback: http://www.example.com/sms-status-callback + sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: http://www.example.com/sms-fallback + sms_method: GET + sms_status_callback: http://www.example.com/sms-status-callback + sms_url: http://example.com + status_callback: http://example.com + status_callback_method: GET + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_caller_id_lookup: false + voice_fallback_method: GET + voice_fallback_url: http://www.example.com/voice-callback + voice_method: GET + voice_url: http://example.com + public_application_connect_enabled: false description: OK security: - accountSid_authToken: [] operationId: FetchApplication - x-maturity: - - GA post: description: Updates the application's properties + tags: + - Api20100401Application parameters: - name: AccountSid in: path @@ -10102,12 +11030,34 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.application' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Mon, 22 Aug 2011 20:59:45 +0000 + date_updated: Tue, 18 Aug 2015 16:48:57 +0000 + friendly_name: Application Friendly Name + message_status_callback: http://www.example.com/sms-status-callback + sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: http://www.example.com/sms-fallback + sms_method: GET + sms_status_callback: http://www.example.com/sms-status-callback + sms_url: http://example.com + status_callback: http://example.com + status_callback_method: GET + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_caller_id_lookup: false + voice_fallback_method: GET + voice_fallback_url: http://www.example.com/voice-callback + voice_method: GET + voice_url: http://example.com + public_application_connect_enabled: true description: OK security: - accountSid_authToken: [] operationId: UpdateApplication - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -10230,6 +11180,24 @@ paths: type: boolean description: 'Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`.' + examples: + update: + value: + FriendlyName: friendly_name + MessageStatusCallback: https://example.com + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsStatusCallback: https://example.com + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceCallerIdLookup: true + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + PublicApplicationConnectEnabled: true /2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}.json: servers: - url: https://api.twilio.com @@ -10238,10 +11206,12 @@ paths: defaultOutputProperties: - connect_app_sid - connect_app_friendly_name - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of an authorized-connect-app + tags: + - Api20100401AuthorizedConnectApp parameters: - name: AccountSid in: path @@ -10268,12 +11238,22 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.authorized_connect_app' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + connect_app_company_name: aaa + connect_app_description: alksjdfl;ajseifj;alsijfl;ajself;jasjfjas;lejflj + connect_app_friendly_name: aaa + connect_app_homepage_url: http://www.google.com + connect_app_sid: CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + permissions: + - get-all + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchAuthorizedConnectApp - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps.json: servers: - url: https://api.twilio.com @@ -10282,11 +11262,13 @@ paths: defaultOutputProperties: - connect_app_sid - connect_app_friendly_name - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of authorized-connect-apps belonging to the account used to make the request + tags: + - Api20100401AuthorizedConnectApp parameters: - name: AccountSid in: path @@ -10322,41 +11304,112 @@ paths: content: application/json: schema: - type: object - title: ListAuthorizedConnectAppResponse - properties: - authorized_connect_apps: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.authorized_connect_app' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListAuthorizedConnectAppResponse + properties: + authorized_connect_apps: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.authorized_connect_app' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AuthorizedConnectApp") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AuthorizedConnectApp")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthorizedConnectApps")' + 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 + 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 description: OK security: - accountSid_authToken: [] operationId: ListAuthorizedConnectApp - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json: servers: - url: https://api.twilio.com @@ -10366,19 +11419,49 @@ paths: - country_code - country - beta - pathType: list dependentProperties: - local: '{account_sid: account_sid, country_code: country_code}' - toll_free: '{account_sid: account_sid, country_code: country_code}' - mobile: '{account_sid: account_sid, country_code: country_code}' - national: '{account_sid: account_sid, country_code: country_code}' - voip: '{account_sid: account_sid, country_code: country_code}' - shared_cost: '{account_sid: account_sid, country_code: country_code}' - machine_to_machine: '{account_sid: account_sid, country_code: country_code}' + local: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Local.json + toll_free: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/TollFree.json + mobile: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Mobile.json + national: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/National.json + voip: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Voip.json + shared_cost: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/SharedCost.json + machine_to_machine: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/MachineToMachine.json parent: /Accounts/{Sid}.json className: available_phone_number_country + pathType: list get: description: '' + tags: + - Api20100401AvailablePhoneNumberCountry parameters: - name: AccountSid in: path @@ -10414,41 +11497,96 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberCountryResponse - properties: - countries: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListAvailablePhoneNumberCountryResponse + properties: + countries: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AvailablePhoneNumberCountry") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AvailablePhoneNumberCountry")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Countries")' + examples: + readFull: + value: + countries: + - beta: false + country: Denmark + country_code: DK + subresource_uris: + local: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/DK/Local.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/DK.json + end: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + readEmpty: + value: + countries: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberCountry - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json: servers: - url: https://api.twilio.com @@ -10458,19 +11596,49 @@ paths: - country_code - country - beta - pathType: instance dependentProperties: - local: '{account_sid: account_sid, country_code: country_code}' - toll_free: '{account_sid: account_sid, country_code: country_code}' - mobile: '{account_sid: account_sid, country_code: country_code}' - national: '{account_sid: account_sid, country_code: country_code}' - voip: '{account_sid: account_sid, country_code: country_code}' - shared_cost: '{account_sid: account_sid, country_code: country_code}' - machine_to_machine: '{account_sid: account_sid, country_code: country_code}' + local: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Local.json + toll_free: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/TollFree.json + mobile: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Mobile.json + national: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/National.json + voip: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/Voip.json + shared_cost: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/SharedCost.json + machine_to_machine: + mapping: + account_sid: account_sid + country_code: country_code + resource_url: /2010-04-01/Accounts/{account_sid}/AvailablePhoneNumbers/{country_code}/MachineToMachine.json parent: /Accounts/{Sid}.json className: available_phone_number_country + pathType: instance get: description: '' + tags: + - Api20100401AvailablePhoneNumberCountry parameters: - name: AccountSid in: path @@ -10497,12 +11665,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country' + examples: + fetch: + value: + beta: null + country: United States + country_code: US + subresource_uris: + local: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json + toll_free: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US.json description: OK security: - accountSid_authToken: [] operationId: FetchAvailablePhoneNumberCountry - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json: servers: - url: https://api.twilio.com @@ -10512,10 +11688,12 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' + tags: + - Api20100401Local parameters: - name: AccountSid in: path @@ -10592,6 +11770,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -10678,41 +11861,105 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberLocalResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListAvailablePhoneNumberLocalResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Local") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Local")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: true + sms: false + voice: true + friendly_name: (808) 925-1571 + iso_country: US + lata: '834' + latitude: '19.720000' + locality: Hilo + longitude: '-155.090000' + phone_number: '+18089251571' + postal_code: '96720' + rate_center: HILO + region: HI + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberLocal - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/MachineToMachine.json: servers: - url: https://api.twilio.com @@ -10722,10 +11969,12 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' + tags: + - Api20100401MachineToMachine parameters: - name: AccountSid in: path @@ -10802,6 +12051,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -10888,41 +12142,105 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberMachineToMachineResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListAvailablePhoneNumberMachineToMachineResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine' + x-field-extra-annotation: '@JacksonXmlProperty(localName="MachineToMachine") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="MachineToMachine")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: false + sms: true + voice: false + friendly_name: '+4759440374' + iso_country: 'NO' + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+4759440374' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/MachineToMachine.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/MachineToMachine.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberMachineToMachine - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Mobile.json: servers: - url: https://api.twilio.com @@ -10932,10 +12250,12 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' + tags: + - Api20100401Mobile parameters: - name: AccountSid in: path @@ -11012,6 +12332,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -11098,41 +12423,105 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberMobileResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListAvailablePhoneNumberMobileResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Mobile") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Mobile")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: false + sms: true + voice: false + friendly_name: '+4759440374' + iso_country: 'NO' + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+4759440374' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Mobile.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Mobile.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberMobile - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/National.json: servers: - url: https://api.twilio.com @@ -11142,10 +12531,12 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' + tags: + - Api20100401National parameters: - name: AccountSid in: path @@ -11222,6 +12613,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -11308,41 +12704,105 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberNationalResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListAvailablePhoneNumberNationalResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national' + x-field-extra-annotation: '@JacksonXmlProperty(localName="National") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="National")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: false + sms: true + voice: false + friendly_name: '+4759440374' + iso_country: 'NO' + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+4759440374' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/National.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/National.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberNational - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/SharedCost.json: servers: - url: https://api.twilio.com @@ -11352,10 +12812,12 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' + tags: + - Api20100401SharedCost parameters: - name: AccountSid in: path @@ -11432,6 +12894,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -11518,41 +12985,105 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberSharedCostResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListAvailablePhoneNumberSharedCostResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost' + x-field-extra-annotation: '@JacksonXmlProperty(localName="SharedCost") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="SharedCost")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: false + sms: true + voice: false + friendly_name: '+4759440374' + iso_country: 'NO' + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+4759440374' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/SharedCost.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/SharedCost.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberSharedCost - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/TollFree.json: servers: - url: https://api.twilio.com @@ -11562,10 +13093,12 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' + tags: + - Api20100401TollFree parameters: - name: AccountSid in: path @@ -11642,6 +13175,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -11728,41 +13266,105 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberTollFreeResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListAvailablePhoneNumberTollFreeResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free' + x-field-extra-annotation: '@JacksonXmlProperty(localName="TollFree") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="TollFree")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: true + sms: true + voice: true + friendly_name: (800) 100-0052 + iso_country: US + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+18001000052' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberTollFree - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Voip.json: servers: - url: https://api.twilio.com @@ -11772,10 +13374,12 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' + tags: + - Api20100401Voip parameters: - name: AccountSid in: path @@ -11852,6 +13456,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -11938,41 +13547,105 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberVoipResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListAvailablePhoneNumberVoipResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Voip") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Voip")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: false + sms: true + voice: false + friendly_name: '+4759440374' + iso_country: 'NO' + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+4759440374' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Voip.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Voip.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberVoip - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Balance.json: servers: - url: https://api.twilio.com @@ -11982,12 +13655,14 @@ paths: - account_sid - balance - currency - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Fetch the balance for an Account based on Account Sid. Balance changes may not be reflected immediately. Child accounts do not contain balance information + tags: + - Api20100401Balance parameters: - name: AccountSid in: path @@ -12004,12 +13679,16 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.balance' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + balance: '0.05' + currency: USD description: OK security: - accountSid_authToken: [] operationId: FetchBalance - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls.json: servers: - url: https://api.twilio.com @@ -12022,21 +13701,54 @@ paths: - to - status - start_time - pathType: list dependentProperties: - recording: '{account_sid: account_sid, call_sid: sid}' - notification: '{account_sid: account_sid, call_sid: sid}' - feedback: '{account_sid: account_sid, call_sid: sid}' - event: '{account_sid: account_sid, call_sid: sid}' - payment: '{account_sid: account_sid, call_sid: sid}' - siprec: '{account_sid: account_sid, call_sid: sid}' - stream: '{account_sid: account_sid, call_sid: sid}' - user_defined_message_subscription: '{account_sid: account_sid, call_sid: sid}' - user_defined_message: '{account_sid: account_sid, call_sid: sid}' + recordings: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json + notifications: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Notifications.json + events: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Events.json + payments: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Payments.json + siprec: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json + streams: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Streams.json + user_defined_message_subscriptions: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/UserDefinedMessageSubscriptions.json + user_defined_messages: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/UserDefinedMessages.json parent: /Accounts/{Sid}.json + pathType: list post: description: Create a new outgoing call to phones, SIP-enabled endpoints or Twilio Client connections + tags: + - Api20100401Call parameters: - name: AccountSid in: path @@ -12054,12 +13766,85 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: null + answered_by: null + api_version: '2010-04-01' + caller_name: null + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + date_updated: Tue, 31 Aug 2010 20:36:44 +0000 + direction: inbound + duration: '15' + end_time: Tue, 31 Aug 2010 20:36:44 +0000 + forwarded_from: '+141586753093' + from: '+14158675308' + from_formatted: (415) 867-5308 + group_sid: null + parent_call_sid: null + phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + price: '-0.03000' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Tue, 31 Aug 2010 20:36:29 +0000 + status: completed + subresource_uris: + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + 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' description: Created security: - accountSid_authToken: [] operationId: CreateCall - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -12333,6 +14118,73 @@ paths: required: - To - From + examples: + create: + value: + ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FallbackMethod: GET + FallbackUrl: https://example.com + From: '+987654321' + IfMachine: if_machine + MachineDetection: enable + MachineDetectionTimeout: 15 + Method: GET + Record: 'true' + RecordingTrack: both + Trim: do-not-trim + SendDigits: send_digits + StatusCallback: https://example.com + StatusCallbackMethod: GET + Timeout: 1 + To: '+123456789' + Url: https://example.com + CallerId: Caller + MachineDetectionSpeechThreshold: 3000 + MachineDetectionSpeechEndThreshold: 3000 + MachineDetectionSilenceTimeout: 3000 + AsyncAmd: 'true' + AsyncAmdStatusCallback: http://statuscallback.com + AsyncAmdStatusCallbackMethod: POST + MachineDetectionEngine: Lumenvox + MachineDetectionMinWordLength: 100 + MachineDetectionMaxWordLength: 5000 + MachineDetectionWordsSilence: 50 + MachineDetectionMaxNumOfWords: 5 + MachineDetectionSilenceThreshold: 256 + Byoc: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + CallReason: Reason for the call (Beta) + TimeLimit: 3600 + CallToken: call-token-string + Transcribe: 'true' + TranscriptionConfiguration: JVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithTwiml: + value: + ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FallbackMethod: GET + FallbackUrl: https://example.com + From: '+987654321' + IfMachine: if_machine + MachineDetection: enable + MachineDetectionTimeout: 15 + Method: '' + Record: 'true' + Trim: do-not-trim + SendDigits: send_digits + StatusCallback: https://example.com + StatusCallbackMethod: GET + Timeout: 1 + To: '+123456789' + Url: '' + CallerId: Caller + MachineDetectionSpeechThreshold: 3000 + MachineDetectionSpeechEndThreshold: 3000 + MachineDetectionSilenceTimeout: 3000 + Twiml: Enjoy + CallReason: Reason for the call (Beta) + TimeLimit: 3600 + CallToken: call-token-string + Transcribe: 'true' + TranscriptionConfiguration: JVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa x-twilio: conditional: - - url @@ -12340,6 +14192,8 @@ paths: - application_sid get: description: Retrieves a collection of calls made to and from your account + tags: + - Api20100401Call parameters: - name: AccountSid in: path @@ -12358,6 +14212,21 @@ paths: schema: type: string format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 120 + examples: + readFullPage1: + value: '+123456789' + readFullPage2: + value: '+123456789' + readEmptyDatesGreater: + value: '+123456789' + readEmptyDatesLess: + value: '+123456789' + readEmptyDateFunDateFormats: + value: '+123456789' - name: From in: query description: Only include calls from this phone number, SIP address, Client @@ -12365,6 +14234,21 @@ paths: schema: type: string format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 120 + examples: + readFullPage1: + value: '+987654321' + readFullPage2: + value: '+987654321' + readEmptyDatesGreater: + value: '+987654321' + readEmptyDatesLess: + value: '+987654321' + readEmptyDateFunDateFormats: + value: '+987654321' - name: ParentCallSid in: query description: Only include calls spawned by calls with this SID. @@ -12373,6 +14257,17 @@ paths: minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ + examples: + readFullPage1: + value: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFullPage2: + value: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmptyDatesGreater: + value: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmptyDatesLess: + value: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmptyDateFunDateFormats: + value: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: 'The status of the calls to include. Can be: `queued`, `ringing`, @@ -12380,6 +14275,17 @@ paths: schema: type: string $ref: '#/components/schemas/call_enum_status' + examples: + readFullPage1: + value: completed + readFullPage2: + value: completed + readEmptyDatesGreater: + value: completed + readEmptyDatesLess: + value: completed + readEmptyDateFunDateFormats: + value: completed - name: StartTime in: query description: 'Only include calls that started on this date. Specify a date @@ -12390,6 +14296,11 @@ paths: schema: type: string format: date-time + examples: + readFullPage1: + value: '2008-01-02' + readFullPage2: + value: '2008-01-02' - name: StartTime< in: query description: 'Only include calls that started on this date. Specify a date @@ -12400,6 +14311,14 @@ paths: schema: type: string format: date-time + x-twilio: + shortDescription: Only include calls that started on this date + ignoreFormat: true + examples: + readEmptyDatesLess: + value: '2008-01-02' + readEmptyDateFunDateFormats: + value: 06/11/2019 22:05:25 MST - name: StartTime> in: query description: 'Only include calls that started on this date. Specify a date @@ -12410,6 +14329,12 @@ paths: schema: type: string format: date-time + x-twilio: + shortDescription: Only include calls that started on this date + ignoreFormat: true + examples: + readEmptyDatesGreater: + value: '2008-01-02' - name: EndTime in: query description: 'Only include calls that ended on this date. Specify a date as @@ -12420,6 +14345,11 @@ paths: schema: type: string format: date-time + examples: + readFullPage1: + value: '2009-01-02' + readFullPage2: + value: '2009-01-02' - name: EndTime< in: query description: 'Only include calls that ended on this date. Specify a date as @@ -12430,6 +14360,14 @@ paths: schema: type: string format: date-time + x-twilio: + shortDescription: Only include calls that ended on this date + ignoreFormat: true + examples: + readEmptyDatesLess: + value: '2009-01-02' + readEmptyDateFunDateFormats: + value: '2019-06-11 22:05:25.000' - name: EndTime> in: query description: 'Only include calls that ended on this date. Specify a date as @@ -12440,6 +14378,12 @@ paths: schema: type: string format: date-time + x-twilio: + shortDescription: Only include calls that ended on this date + ignoreFormat: true + examples: + readEmptyDatesGreater: + value: '2009-01-02' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -12464,41 +14408,276 @@ paths: content: application/json: schema: - type: object - title: ListCallResponse - properties: - calls: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.call' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListCallResponse + properties: + calls: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.call' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Call") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Call")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Calls")' + 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 + readEmptyDateFunDateFormats: + value: + calls: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2019-06-11+22%3A05%3A25.000&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=2&Page=0 + next_page_uri: null + page: 0 + page_size: 2 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2019-06-11+22%3A05%3A25.000&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=2&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCall - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json: servers: - url: https://api.twilio.com @@ -12511,21 +14690,54 @@ paths: - to - status - start_time - pathType: instance dependentProperties: - recording: '{account_sid: account_sid, call_sid: sid}' - notification: '{account_sid: account_sid, call_sid: sid}' - feedback: '{account_sid: account_sid, call_sid: sid}' - event: '{account_sid: account_sid, call_sid: sid}' - payment: '{account_sid: account_sid, call_sid: sid}' - siprec: '{account_sid: account_sid, call_sid: sid}' - stream: '{account_sid: account_sid, call_sid: sid}' - user_defined_message_subscription: '{account_sid: account_sid, call_sid: sid}' - user_defined_message: '{account_sid: account_sid, call_sid: sid}' + recordings: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json + notifications: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Notifications.json + events: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Events.json + payments: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Payments.json + siprec: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json + streams: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Streams.json + user_defined_message_subscriptions: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/UserDefinedMessageSubscriptions.json + user_defined_messages: + mapping: + account_sid: account_sid + call_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/UserDefinedMessages.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. + tags: + - Api20100401Call parameters: - name: AccountSid in: path @@ -12553,10 +14765,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCall - x-maturity: - - GA get: description: Fetch the call specified by the provided Call SID + tags: + - Api20100401Call parameters: - name: AccountSid in: path @@ -12583,14 +14795,52 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: billingreferencetag + answered_by: machine_start + api_version: '2010-04-01' + caller_name: callerid + date_created: Fri, 18 Oct 2019 17:00:00 +0000 + date_updated: Fri, 18 Oct 2019 17:01:00 +0000 + direction: outbound-api + duration: '4' + end_time: Fri, 18 Oct 2019 17:03:00 +0000 + forwarded_from: calledvia + from: '+13051416799' + from_formatted: (305) 141-6799 + group_sid: GPdeadbeefdeadbeefdeadbeefdeadbeef + parent_call_sid: CAdeadbeefdeadbeefdeadbeefdeadbeef + phone_number_sid: PNdeadbeefdeadbeefdeadbeefdeadbeef + price: '-0.200' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Fri, 18 Oct 2019 17:02:00 +0000 + status: completed + subresource_uris: + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json + to: '+13051913581' + to_formatted: (305) 191-3581 + trunk_sid: TKdeadbeefdeadbeefdeadbeefdeadbeef + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + queue_time: '1000' description: OK security: - accountSid_authToken: [] operationId: FetchCall - x-maturity: - - GA post: description: Initiates a call redirect or terminates a call + tags: + - Api20100401Call parameters: - name: AccountSid in: path @@ -12618,12 +14868,159 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: null + answered_by: null + api_version: '2010-04-01' + caller_name: null + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + date_updated: Tue, 31 Aug 2010 20:36:44 +0000 + direction: inbound + duration: '15' + end_time: Tue, 31 Aug 2010 20:36:44 +0000 + forwarded_from: '+141586753093' + from: '+14158675308' + from_formatted: (415) 867-5308 + group_sid: null + parent_call_sid: null + phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + price: '-0.03000' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Tue, 31 Aug 2010 20:36:29 +0000 + status: completed + subresource_uris: + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + 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' description: OK security: - accountSid_authToken: [] operationId: UpdateCall - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -12712,6 +15109,38 @@ paths: type: integer description: The maximum duration of the call in seconds. Constraints depend on account and configuration. + examples: + update: + value: + FallbackMethod: GET + FallbackUrl: https://example.com + Method: GET + Status: completed + StatusCallback: https://example.com + StatusCallbackUrl: https://example.com + StatusCallbackMethod: GET + Url: https://example.com + cancel: + value: + FallbackMethod: GET + FallbackUrl: https://example.com + Method: GET + Status: canceled + StatusCallback: https://example.com + StatusCallbackMethod: GET + Url: https://example.com + posttwiml: + value: + FallbackMethod: GET + FallbackUrl: https://example.com + Method: GET + Status: canceled + StatusCallback: https://example.com + StatusCallbackMethod: GET + Twiml: Enjoy + updatetimelimit: + value: + TimeLimit: 600 /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Events.json: servers: - url: https://api.twilio.com @@ -12721,10 +15150,12 @@ paths: defaultOutputProperties: - request - response - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list get: description: Retrieve a list of all events for a call. + tags: + - Api20100401Event parameters: - name: AccountSid in: path @@ -12768,301 +15199,122 @@ paths: content: application/json: schema: - type: object - title: ListCallEventResponse - properties: - events: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.call.call_event' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListCallEventResponse + properties: + events: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.call.call_event' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Event") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Event")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Events")' + examples: + readFull: + value: + events: + - request: + method: POST + url: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + parameters: + status_callback_method: POST + twiml: Hi! + trim: trim-silence + timeout: '55' + method: POST + from: '+987654321' + to: '+123456789' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + machine_detection_timeout: '0' + response: + response_code: 201 + request_duration: 50 + content_type: application/json + response_body: '{"sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' + date_created: Tue, 11 Aug 2020 17:44:08 +0000 + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0 + readEmpty: + value: + events: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCallEvent - x-maturity: - - GA - /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Feedback.json: - servers: - - url: https://api.twilio.com - description: The call Feedback subresource describes the quality experienced during - a phone call. - x-twilio: - defaultOutputProperties: - - sid - - quality_score - - date_created - pathType: instance - parent: /Accounts/{AccountSid}/Calls/{Sid}.json - get: - description: Fetch a Feedback resource from a call - parameters: - - name: AccountSid - in: path - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) - responsible for this resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - required: true - - name: CallSid - in: path - description: The call sid that uniquely identifies the call - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^CA[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api.v2010.account.call.call_feedback' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchCallFeedback - x-maturity: - - GA - post: - description: Update a Feedback resource for a call - parameters: - - name: AccountSid - in: path - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) - responsible for this resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - required: true - - name: CallSid - in: path - description: The call sid that uniquely identifies the call - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api.v2010.account.call.call_feedback' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateCallFeedback - x-maturity: - - GA - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateCallFeedbackRequest - properties: - QualityScore: - type: integer - description: The call quality expressed as an integer from `1` to - `5` where `1` represents very poor call quality and `5` represents - a perfect call. - Issue: - type: array - items: - type: string - $ref: '#/components/schemas/call_feedback_enum_issues' - description: 'One or more issues experienced during the call. The - issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, - `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`, - or `one-way-audio`.' - /2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary.json: - servers: - - url: https://api.twilio.com - description: Call FeedbackSummary resources provide an idea of how your end user's - perceive the quality of their calls and the most common issues they have encountered - in the context of all your voice traffic during a specific time frame. - x-twilio: - defaultOutputProperties: - - sid - - call_feedback_count - - quality_score_average - - start_date - pathType: list - parent: /Accounts/{AccountSid}/Calls.json - mountName: feedback_summaries - post: - description: Create a FeedbackSummary resource for a call - parameters: - - name: AccountSid - in: path - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) - responsible for this resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/api.v2010.account.call.call_feedback_summary' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateCallFeedbackSummary - x-maturity: - - GA - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateCallFeedbackSummaryRequest - properties: - StartDate: - type: string - format: date - description: Only include feedback given on or after this date. - Format is `YYYY-MM-DD` and specified in UTC. - EndDate: - type: string - format: date - description: Only include feedback given on or before this date. - Format is `YYYY-MM-DD` and specified in UTC. - IncludeSubaccounts: - type: boolean - description: Whether to also include Feedback resources from all - subaccounts. `true` includes feedback from all subaccounts and - `false`, the default, includes feedback from only the specified - account. - StatusCallback: - type: string - format: uri - description: The URL that we will request when the feedback summary - is complete. - StatusCallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: The HTTP method (`GET` or `POST`) we use to make the - request to the `StatusCallback` URL. - required: - - StartDate - - EndDate - /2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary/{Sid}.json: - servers: - - url: https://api.twilio.com - description: Call FeedbackSummary resources provide an idea of how your end user's - perceive the quality of their calls and the most common issues they have encountered - in the context of all your voice traffic during a specific time frame. - x-twilio: - defaultOutputProperties: - - sid - - call_feedback_count - - quality_score_average - - start_date - pathType: instance - parent: /Accounts/{AccountSid}/Calls.json - mountName: feedback_summaries - get: - description: Fetch a FeedbackSummary resource from a call - parameters: - - name: AccountSid - in: path - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) - responsible for this resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - required: true - - name: Sid - in: path - description: A 34 character string that uniquely identifies this resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^FS[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api.v2010.account.call.call_feedback_summary' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchCallFeedbackSummary - x-maturity: - - GA - delete: - description: Delete a FeedbackSummary resource from a call - parameters: - - name: AccountSid - in: path - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) - responsible for this resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - required: true - - name: Sid - in: path - description: A 34 character string that uniquely identifies this resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^FS[0-9a-fA-F]{32}$ - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteCallFeedbackSummary - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications/{Sid}.json: servers: - url: https://api.twilio.com @@ -13073,10 +15325,12 @@ paths: - call_sid - error_code - message_date - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance get: description: '' + tags: + - Api20100401Notification parameters: - name: AccountSid in: path @@ -13114,12 +15368,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_notification-instance' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Tue, 18 Aug 2015 08:46:56 +0000 + date_updated: Tue, 18 Aug 2015 08:46:57 +0000 + error_code: '15003' + log: '1' + message_date: Tue, 18 Aug 2015 08:46:56 +0000 + message_text: statusCallback=http%3A%2F%2Fexample.com%2Ffoo.xml&ErrorCode=15003&LogLevel=WARN&Msg=Got+HTTP+404+response+to+http%3A%2F%2Fexample.com%2Ffoo.xml + more_info: https://www.twilio.com/docs/errors/15003 + request_method: null + request_url: '' + request_variables: '' + response_body: '' + response_headers: '' + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchCallNotification - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json: servers: - url: https://api.twilio.com @@ -13130,10 +15402,12 @@ paths: - call_sid - error_code - message_date - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list get: description: '' + tags: + - Api20100401Notification parameters: - name: AccountSid in: path @@ -13162,6 +15436,11 @@ paths: By default, all notifications are read.' schema: type: integer + examples: + readFull: + value: 1 + readEmpty: + value: 1 - name: MessageDate in: query description: Only show notifications for the specified date, formatted as @@ -13171,6 +15450,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: MessageDate< in: query description: Only show notifications for the specified date, formatted as @@ -13213,41 +15497,117 @@ paths: content: application/json: schema: - type: object - title: ListCallNotificationResponse - properties: - notifications: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.call.call_notification' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListCallNotificationResponse + properties: + notifications: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.call.call_notification' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Notification") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Notification")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Notifications")' + examples: + readFull: + value: + notifications: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Tue, 18 Aug 2015 08:46:56 +0000 + date_updated: Tue, 18 Aug 2015 08:46:57 +0000 + error_code: '15003' + log: '1' + message_date: Tue, 18 Aug 2015 08:46:56 +0000 + message_text: statusCallback=http%3A%2F%2Fexample.com%2Ffoo.xml&ErrorCode=15003&LogLevel=WARN&Msg=Got+HTTP+404+response+to+http%3A%2F%2Fexample.com%2Ffoo.xml + more_info: https://www.twilio.com/docs/errors/15003 + request_method: null + request_url: '' + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + page: 0 + page_size: 50 + previous_page_uri: null + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 + next_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + readEmpty: + value: + notifications: [] + page: 0 + page_size: 50 + previous_page_uri: null + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 + next_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json description: OK security: - accountSid_authToken: [] operationId: ListCallNotification - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json: servers: - url: https://api.twilio.com @@ -13260,10 +15620,12 @@ paths: - status - start_time - duration - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: Create a recording for the call + tags: + - Api20100401Recording parameters: - name: AccountSid in: path @@ -13291,12 +15653,31 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_recording' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: null + channels: 2 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:34 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: null + price_unit: null + duration: null + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartCallRecordingAPI + status: in-progress + error_code: null + encryption_details: null + track: both + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateCallRecording - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -13350,9 +15731,24 @@ paths: the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio.' + examples: + create: + value: + RecordingStatusCallbackEvent: + - in-progress completed failed + RecordingStatusCallback: https://example.com + RecordingStatusCallbackMethod: GET + Trim: do-not-trim + RecordingChannels: dual + RecordingTrack: both + PlayBeep: true + Transcribe: true + TranscriptionConfiguration: JVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of recordings belonging to the call used to make the request + tags: + - Api20100401Recording parameters: - name: AccountSid in: path @@ -13384,6 +15780,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: DateCreated< in: query description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the @@ -13394,6 +15795,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-01' + readEmpty: + value: '2008-01-01' - name: DateCreated> in: query description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the @@ -13404,6 +15810,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-03' + readEmpty: + value: '2008-01-03' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -13428,41 +15839,124 @@ paths: content: application/json: schema: - type: object - title: ListCallRecordingResponse - properties: - recordings: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.call.call_recording' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListCallRecordingResponse + properties: + recordings: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.call.call_recording' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Recording") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Recording")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recordings")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: null + channels: 2 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '-0.0025' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + source: StartCallRecordingAPI + status: completed + track: both + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + recordings: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCallRecording - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json: servers: - url: https://api.twilio.com @@ -13475,12 +15969,14 @@ paths: - status - start_time - duration - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance post: description: 'Changes the status of the recording to paused, stopped, or in-progress. Note: Pass `Twilio.CURRENT` instead of recording sid to reference current active recording.' + tags: + - Api20100401Recording parameters: - name: AccountSid in: path @@ -13515,12 +16011,31 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_recording' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: null + channels: 2 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:36 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: null + price_unit: null + duration: null + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartCallRecordingAPI + status: paused + error_code: null + encryption_details: null + track: both + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateCallRecording - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -13542,8 +16057,16 @@ paths: only applies when setting `status` is set to `paused`.' required: - Status + examples: + update: + value: + Status: paused + PauseBehavior: skip + PlayBeep: true get: description: Fetch an instance of a recording for a call + tags: + - Api20100401Recording parameters: - name: AccountSid in: path @@ -13581,14 +16104,38 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: null + channels: 2 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '-0.0025' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + source: StartCallRecordingAPI + status: completed + error_code: null + track: both + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchCallRecording - x-maturity: - - GA delete: description: Delete a recording from your account + tags: + - Api20100401Recording parameters: - name: AccountSid in: path @@ -13626,8 +16173,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCallRecording - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json: servers: - url: https://api.twilio.com @@ -13637,13 +16182,23 @@ paths: - sid - friendly_name - status - pathType: instance dependentProperties: - participant: '{account_sid: account_sid, conference_sid: sid}' - recording: '{account_sid: account_sid, conference_sid: sid}' + participants: + mapping: + account_sid: account_sid + conference_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Conferences/{conference_sid}/Participants.json + recordings: + mapping: + account_sid: account_sid + conference_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a conference + tags: + - Api20100401Conference parameters: - name: AccountSid in: path @@ -13671,14 +16226,79 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference' + examples: + fetchValidMixerZone: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Fri, 18 Feb 2011 19:26:50 +0000 + date_updated: Fri, 18 Feb 2011 19:27:33 +0000 + friendly_name: AHH YEAH + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + region: us1 + status: completed + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: last-participant-left + call_sid_ending_conference: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchValidRegionInProgress: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Fri, 18 Feb 2011 19:26:50 +0000 + date_updated: Fri, 18 Feb 2011 19:27:33 +0000 + friendly_name: AHH YEAH + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + region: au1 + status: in-progress + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: null + call_sid_ending_conference: null + fetchWithoutMixerZoneIntegerStatus: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Fri, 18 Feb 2011 19:26:50 +0000 + date_updated: Fri, 18 Feb 2011 19:27:33 +0000 + friendly_name: AHH YEAH + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + region: us1 + status: completed + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: participant-with-end-conference-on-exit-left + call_sid_ending_conference: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchUnknownMixerZoneInitIntegerStatus: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Fri, 18 Feb 2011 19:26:50 +0000 + date_updated: Fri, 18 Feb 2011 19:27:33 +0000 + friendly_name: AHH YEAH + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + region: unknown + status: init + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: participant-with-end-conference-on-exit-left + call_sid_ending_conference: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConference - x-maturity: - - GA post: description: '' + tags: + - Api20100401Conference parameters: - name: AccountSid in: path @@ -13703,12 +16323,43 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference' + examples: + updateEndConference: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Mon, 22 Aug 2011 20:58:45 +0000 + date_updated: Mon, 22 Aug 2011 20:58:46 +0000 + friendly_name: null + region: us1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: conference-ended-via-api + call_sid_ending_conference: null + announceToConference: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Mon, 08 Feb 2021 20:58:45 +0000 + date_updated: Mon, 08 Feb 2021 20:58:46 +0000 + friendly_name: MyRoom + region: us1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: in-progress + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: null + call_sid_ending_conference: null description: OK security: - accountSid_authToken: [] operationId: UpdateConference - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -13741,6 +16392,13 @@ paths: - DELETE description: 'The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST`' + examples: + updateEndConference: + value: + Status: completed + announceToConference: + value: + AnnounceUrl: http://www.myapp.com/announce /2010-04-01/Accounts/{AccountSid}/Conferences.json: servers: - url: https://api.twilio.com @@ -13750,14 +16408,24 @@ paths: - sid - friendly_name - status - pathType: list dependentProperties: - participant: '{account_sid: account_sid, conference_sid: sid}' - recording: '{account_sid: account_sid, conference_sid: sid}' + participants: + mapping: + account_sid: account_sid + conference_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Conferences/{conference_sid}/Participants.json + recordings: + mapping: + account_sid: account_sid + conference_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of conferences belonging to the account used to make the request + tags: + - Api20100401Conference parameters: - name: AccountSid in: path @@ -13778,6 +16446,15 @@ paths: schema: type: string format: date + examples: + readEmpty: + value: '2008-01-03' + readNext: + value: '2008-01-03' + readPrevious: + value: '2008-01-03' + readDateCreatedEquals: + value: '2020-07-07' - name: DateCreated< in: query description: The `date_created` value, specified as `YYYY-MM-DD`, of the resources @@ -13787,6 +16464,16 @@ paths: schema: type: string format: date + x-twilio: + shortDescription: The `YYYY-MM-DD` value of the resources to read + ignoreFormat: true + examples: + readEmpty: + value: '2008-01-01' + readNext: + value: '2008-01-01' + readPrevious: + value: '2008-01-01' - name: DateCreated> in: query description: The `date_created` value, specified as `YYYY-MM-DD`, of the resources @@ -13796,6 +16483,18 @@ paths: schema: type: string format: date + x-twilio: + shortDescription: The `YYYY-MM-DD` value of the resources to read + ignoreFormat: true + examples: + readEmpty: + value: '2008-01-02' + readNext: + value: '2008-01-02' + readPrevious: + value: '2008-01-02' + readDateCreatedOnOrAfter: + value: '2021-01-01' - name: DateUpdated in: query description: The `date_updated` value, specified as `YYYY-MM-DD`, of the resources @@ -13805,6 +16504,13 @@ paths: schema: type: string format: date + examples: + readEmpty: + value: '2018-11-13' + readNext: + value: '2018-11-13' + readPrevious: + value: '2018-11-13' - name: DateUpdated< in: query description: The `date_updated` value, specified as `YYYY-MM-DD`, of the resources @@ -13814,6 +16520,16 @@ paths: schema: type: string format: date + x-twilio: + shortDescription: The `YYYY-MM-DD` value of the resources to read + ignoreFormat: true + examples: + readEmpty: + value: '2018-11-11' + readNext: + value: '2018-11-11' + readPrevious: + value: '2018-11-11' - name: DateUpdated> in: query description: The `date_updated` value, specified as `YYYY-MM-DD`, of the resources @@ -13823,11 +16539,30 @@ paths: schema: type: string format: date + x-twilio: + shortDescription: The `YYYY-MM-DD` value of the resources to read + ignoreFormat: true + examples: + readEmpty: + value: '2018-11-12' + readNext: + value: '2018-11-12' + readPrevious: + value: '2018-11-12' - name: FriendlyName in: query description: The string that identifies the Conference resources to read. schema: type: string + examples: + readEmpty: + value: friendly_name + readNext: + value: friendly_name + readPrevious: + value: friendly_name + readMyroom: + value: MyRoom - name: Status in: query description: 'The status of the resources to read. Can be: `init`, `in-progress`, @@ -13835,6 +16570,15 @@ paths: schema: type: string $ref: '#/components/schemas/conference_enum_status' + examples: + readEmpty: + value: init + readNext: + value: in-progress + readPrevious: + value: in-progress + readDateCreatedOnOrAfter: + value: in-progress - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -13859,41 +16603,635 @@ paths: content: application/json: schema: - type: object - title: ListConferenceResponse - properties: - conferences: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.conference' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListConferenceResponse + properties: + conferences: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.conference' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Conference") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Conference")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Conferences")' + examples: + readEmpty: + value: + conferences: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=init&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=50&Page=0 + next_page_uri: null + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=init&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=50&Page=0 + page: 0 + page_size: 50 + start: 0 + end: 0 + readNext: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFdddddddddddddddddddddddddddddddd + date_updated: Thu, 01 Jan 2015 10:23:45 +0000 + date_created: Thu, 01 Jan 2015 10:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: unknown + sid: CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + date_updated: Thu, 01 Jan 2015 09:23:45 +0000 + date_created: Thu, 01 Jan 2015 09:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: us1 + sid: CFffffffffffffffffffffffffffffffff + date_updated: Thu, 01 Jan 2015 08:23:45 +0000 + date_created: Thu, 01 Jan 2015 08:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=2&PageToken=PACFffffffffffffffffffffffffffffffff + previous_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0&PageToken=PBCFdddddddddddddddddddddddddddddddd + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc + page: 1 + page_size: 3 + start: 3 + end: 5 + readPrevious: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: Sat, 03 Jan 2015 11:23:45 +0000 + date_created: Sat, 03 Jan 2015 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: unknown + sid: CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_updated: Fri, 02 Jan 2015 11:23:45 +0000 + date_created: Fri, 02 Jan 2015 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: us1 + sid: CFcccccccccccccccccccccccccccccccc + date_updated: Thu, 01 Jan 2015 11:23:45 +0000 + date_created: Thu, 01 Jan 2015 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0&PageToken=PBCFdddddddddddddddddddddddddddddddd + page: 0 + page_size: 3 + start: 0 + end: 2 + readMyroom: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: Sun, 03 Jan 2021 11:23:45 +0000 + date_created: Sun, 03 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: completed + region: us1 + sid: CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_updated: Sat, 02 Jan 2021 11:23:45 +0000 + date_created: Sat, 02 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: last-participant-left + call_sid_ending_conference: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + - status: completed + region: ie1 + sid: CFcccccccccccccccccccccccccccccccc + date_updated: Fri, 01 Jan 2021 11:23:45 +0000 + date_created: Fri, 01 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: last-participant-left + call_sid_ending_conference: CAcccccccccccccccccccccccccccccccc + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0 + next_page_uri: null + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0 + page: 0 + page_size: 20 + start: 0 + end: 2 + readFull: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: Fri, 03 Jul 2020 11:23:45 +0000 + date_created: Fri, 03 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: de1 + sid: CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_updated: Thu, 02 Jul 2020 11:23:45 +0000 + date_created: Thu, 02 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: completed + region: br1 + sid: CFcccccccccccccccccccccccccccccccc + date_updated: Wed, 01 Jul 2020 11:23:45 +0000 + date_created: Wed, 01 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json + friendly_name: FRIEND + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: participant-with-end-conference-on-exit-left + call_sid_ending_conference: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=0 + page: 0 + page_size: 3 + start: 0 + end: 2 + readDateCreatedEquals: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: Tue, 07 Jul 2020 11:23:45 +0000 + date_created: Tue, 07 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: de1 + sid: CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_updated: Tue, 07 Jul 2020 11:23:45 +0000 + date_created: Tue, 07 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: completed + region: br1 + sid: CFcccccccccccccccccccccccccccccccc + date_updated: Tue, 07 Jul 2020 11:23:45 +0000 + date_created: Tue, 07 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json + friendly_name: FRIEND + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: participant-with-end-conference-on-exit-left + call_sid_ending_conference: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0 + page: 0 + page_size: 3 + start: 0 + end: 2 + readDateCreatedOnOrAfter: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: Fri, 01 Jan 2021 11:23:45 +0000 + date_created: Fri, 01 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: de1 + sid: CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_updated: Fri, 01 Jan 2021 11:23:45 +0000 + date_created: Fri, 01 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: br1 + sid: CFcccccccccccccccccccccccccccccccc + date_updated: Fri, 01 Jan 2021 11:23:45 +0000 + date_created: Fri, 01 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json + friendly_name: FRIEND + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0 + next_page_uri: null + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0 + page: 0 + page_size: 20 + start: 0 + end: 2 description: OK security: - accountSid_authToken: [] operationId: ListConference - x-maturity: - - GA + /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.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: + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListConferenceRecordingResponse + properties: + recordings: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Recording") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Recording")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recordings")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '-0.0025' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: completed + error_code: null + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + recordings: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + description: OK + security: + - accountSid_authToken: [] + operationId: ListConferenceRecording /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json: servers: - url: https://api.twilio.com @@ -13905,11 +17243,13 @@ paths: - status - start_time - duration - pathType: instance 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.' + tags: + - Api20100401Recording parameters: - name: AccountSid in: path @@ -13945,12 +17285,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:39 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: null + price_unit: null + duration: null + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: paused + error_code: null + encryption_details: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateConferenceRecording - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -13972,8 +17330,16 @@ paths: only applies when setting `status` is set to `paused`.' required: - Status + examples: + update: + value: + Status: paused + PauseBehavior: skip + PlayBeep: true get: description: Fetch an instance of a recording for a call + tags: + - Api20100401Recording parameters: - name: AccountSid in: path @@ -14011,14 +17377,37 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '-0.0025' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: completed + error_code: null + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchConferenceRecording - x-maturity: - - GA delete: description: Delete a recording from your account + tags: + - Api20100401Recording parameters: - name: AccountSid in: path @@ -14056,134 +17445,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConferenceRecording - x-maturity: - - GA - /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json: - servers: - - url: https://api.twilio.com - description: Recordings of conferences - x-twilio: - defaultOutputProperties: - - sid - - conference_sid - - status - - start_time - - duration - pathType: list - parent: /Accounts/{AccountSid}/Conferences/{Sid}.json - get: - description: Retrieve a list of recordings belonging to the call used to make - the request - parameters: - - name: AccountSid - in: path - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Conference Recording resources to read. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - required: true - - name: ConferenceSid - in: path - description: The Conference SID that identifies the conference associated - with the recording to read. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^CF[0-9a-fA-F]{32}$ - required: true - - name: DateCreated - in: query - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the - resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` - will return recordings generated at or before midnight on a given date, - and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight - on a date.' - schema: - type: string - format: date - - name: DateCreated< - in: query - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the - resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` - will return recordings generated at or before midnight on a given date, - and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight - on a date.' - schema: - type: string - format: date - - name: DateCreated> - in: query - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the - resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` - will return recordings generated at or before midnight on a given date, - and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight - on a date.' - schema: - type: string - format: date - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListConferenceRecordingResponse - properties: - recordings: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri - description: OK - security: - - accountSid_authToken: [] - operationId: ListConferenceRecording - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json: servers: - url: https://api.twilio.com @@ -14192,10 +17453,12 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a connect-app + tags: + - Api20100401ConnectApp parameters: - name: AccountSid in: path @@ -14223,14 +17486,28 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.connect_app' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + authorize_redirect_url: http://example.com/redirect + company_name: Twilio + deauthorize_callback_method: GET + deauthorize_callback_url: http://example.com/deauth + description: null + friendly_name: Connect app for deletion + homepage_url: http://example.com/home + permissions: [] + sid: CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchConnectApp - x-maturity: - - GA post: description: Update a connect-app with the specified parameters + tags: + - Api20100401ConnectApp parameters: - name: AccountSid in: path @@ -14258,12 +17535,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.connect_app' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + authorize_redirect_url: http://example.com/redirect + company_name: Twilio + deauthorize_callback_method: GET + deauthorize_callback_url: http://example.com/deauth + description: null + friendly_name: Connect app for deletion + homepage_url: http://example.com/home + permissions: [] + sid: CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateConnectApp - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -14315,8 +17604,22 @@ paths: description: 'A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: `get-all` and `post-all`.' + examples: + update: + value: + AuthorizeRedirectUrl: https://example.com + CompanyName: company_name + DeauthorizeCallbackMethod: GET + DeauthorizeCallbackUrl: https://example.com + Description: description + FriendlyName: friendly_name + HomepageUrl: https://example.com + Permissions: + - get-all delete: description: Delete an instance of a connect-app + tags: + - Api20100401ConnectApp parameters: - name: AccountSid in: path @@ -14344,8 +17647,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConnectApp - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/ConnectApps.json: servers: - url: https://api.twilio.com @@ -14354,11 +17655,13 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of connect-apps belonging to the account used to make the request + tags: + - Api20100401ConnectApp parameters: - name: AccountSid in: path @@ -14394,41 +17697,114 @@ paths: content: application/json: schema: - type: object - title: ListConnectAppResponse - properties: - connect_apps: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.connect_app' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListConnectAppResponse + properties: + connect_apps: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.connect_app' + x-field-extra-annotation: '@JacksonXmlProperty(localName="ConnectApp") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="ConnectApp")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ConnectApps")' + 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 + readEmpty: + value: + connect_apps: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=0&PageSize=50 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json description: OK security: - accountSid_authToken: [] operationId: ListConnectApp - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Addresses/{AddressSid}/DependentPhoneNumbers.json: servers: - url: https://api.twilio.com @@ -14438,10 +17814,12 @@ paths: - sid - phone_number - friendly_name - pathType: list parent: /Accounts/{AccountSid}/Addresses/{Sid}.json + pathType: list get: description: '' + tags: + - Api20100401DependentPhoneNumber parameters: - name: AccountSid in: path @@ -14486,41 +17864,128 @@ paths: content: application/json: schema: - type: object - title: ListDependentPhoneNumberResponse - properties: - dependent_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.address.dependent_phone_number' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListDependentPhoneNumberResponse + properties: + dependent_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.address.dependent_phone_number' + x-field-extra-annotation: '@JacksonXmlProperty(localName="DependentPhoneNumber") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="DependentPhoneNumber")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "DependentPhoneNumbers")' + examples: + readFull: + value: + dependent_phone_numbers: + - sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: '3197004499318' + phone_number: '+3197004499318' + voice_url: null + voice_method: POST + voice_fallback_url: null + voice_fallback_method: POST + voice_caller_id_lookup: false + date_created: Thu, 23 Feb 2017 10:26:31 -0800 + date_updated: Thu, 23 Feb 2017 10:26:31 -0800 + sms_url: '' + sms_method: POST + sms_fallback_url: '' + sms_fallback_method: POST + address_requirements: any + capabilities: + Voice: false + SMS: true + MMS: false + status_callback: '' + status_callback_method: POST + api_version: '2010-04-01' + voice_application_sid: null + sms_application_sid: '' + trunk_sid: null + emergency_status: Inactive + emergency_address_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json?Page=0&PageSize=50 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json + readEmpty: + value: + dependent_phone_numbers: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json?Page=0&PageSize=50 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json description: OK security: - accountSid_authToken: [] operationId: ListDependentPhoneNumber - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json: servers: - url: https://api.twilio.com @@ -14530,12 +17995,18 @@ paths: - sid - phone_number - friendly_name - pathType: instance dependentProperties: - assigned_add_on: '{account_sid: account_sid, resource_sid: sid}' + assigned_add_ons: + mapping: + account_sid: account_sid + resource_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers/{resource_sid}/AssignedAddOns.json parent: /Accounts/{Sid}.json + pathType: instance post: description: Update an incoming-phone-number instance. + tags: + - Api20100401IncomingPhoneNumber parameters: - name: AccountSid in: path @@ -14564,12 +18035,53 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Inactive + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: true + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + voice_receive_mode: voice + status: in-use + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + assigned_add_ons: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json description: OK security: - accountSid_authToken: [] operationId: UpdateIncomingPhoneNumber - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -14756,9 +18268,36 @@ paths: description: The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. + examples: + update: + value: + AccountSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ApiVersion: api_version + EmergencyStatus: Inactive + EmergencyAddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + IdentitySid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VoiceCallerIdLookup: 'true' + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + VoiceReceiveMode: voice + BundleSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Fetch an incoming-phone-number belonging to the account used to make the request. + tags: + - Api20100401IncomingPhoneNumber parameters: - name: AccountSid in: path @@ -14786,15 +18325,58 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + voice_receive_mode: voice + status: in-use + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + assigned_add_ons: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json description: OK security: - accountSid_authToken: [] operationId: FetchIncomingPhoneNumber - x-maturity: - - GA delete: description: Delete a phone-numbers belonging to the account used to make the request. + tags: + - Api20100401IncomingPhoneNumber parameters: - name: AccountSid in: path @@ -14822,8 +18404,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteIncomingPhoneNumber - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json: servers: - url: https://api.twilio.com @@ -14833,13 +18413,19 @@ paths: - sid - phone_number - friendly_name - pathType: list dependentProperties: - assigned_add_on: '{account_sid: account_sid, resource_sid: sid}' + assigned_add_ons: + mapping: + account_sid: account_sid + resource_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers/{resource_sid}/AssignedAddOns.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. + tags: + - Api20100401IncomingPhoneNumber parameters: - name: AccountSid in: path @@ -14857,12 +18443,26 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: FriendlyName in: query description: A string that identifies the IncomingPhoneNumber resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -14870,6 +18470,11 @@ paths: schema: type: string format: phone-number + examples: + readFull: + value: '+19876543210' + readEmpty: + value: '+19876543210' - name: Origin in: query description: 'Whether to include phone numbers based on their origin. Can @@ -14900,43 +18505,147 @@ paths: content: application/json: schema: - type: object - title: ListIncomingPhoneNumberResponse - properties: - incoming_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListIncomingPhoneNumberResponse + properties: + incoming_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' + x-field-extra-annotation: '@JacksonXmlProperty(localName="IncomingPhoneNumber") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="IncomingPhoneNumber")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IncomingPhoneNumbers")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: null + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use + subresource_uris: + assigned_add_ons: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumber - x-maturity: - - GA post: description: Purchase a phone-number for the account. + tags: + - Api20100401IncomingPhoneNumber parameters: - name: AccountSid in: path @@ -14954,12 +18663,53 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: friendly_name + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: https://example.com + sms_method: GET + sms_url: https://example.com + status_callback: https://example.com + status_callback_method: GET + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_caller_id_lookup: false + voice_fallback_method: GET + voice_fallback_url: https://example.com + voice_method: GET + voice_url: https://example.com + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use + subresource_uris: + assigned_add_ons: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json description: Created security: - accountSid_authToken: [] operationId: CreateIncomingPhoneNumber - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -15153,6 +18903,31 @@ paths: an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only). + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ApiVersion: api_version + AreaCode: area_code + EmergencyStatus: Active + EmergencyAddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + IdentitySid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + PhoneNumber: '+18089255327' + SmsApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VoiceCallerIdLookup: 'true' + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + BundleSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa x-twilio: conditional: - - phone_number @@ -15160,21 +18935,27 @@ paths: /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - description - pathType: instance dependentProperties: - assigned_add_on_extension: '{account_sid: account_sid, resource_sid: resource_sid, - assigned_add_on_sid: sid}' + extensions: + mapping: + account_sid: account_sid + resource_sid: resource_sid + assigned_add_on_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers/{resource_sid}/AssignedAddOns/{assigned_add_on_sid}/Extensions.json parent: /Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json + pathType: instance get: description: Fetch an instance of an Add-on installation currently assigned to this Number. + tags: + - Api20100401AssignedAddOn parameters: - name: AccountSid in: path @@ -15211,15 +18992,31 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' + examples: + fetch: + value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: Thu, 07 Apr 2016 23:52:28 +0000 + date_updated: Thu, 07 Apr 2016 23:52:28 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + extensions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json description: OK security: - accountSid_authToken: [] operationId: FetchIncomingPhoneNumberAssignedAddOn - x-maturity: - - Beta delete: description: Remove the assignment of an Add-on installation from the Number specified. + tags: + - Api20100401AssignedAddOn parameters: - name: AccountSid in: path @@ -15256,26 +19053,30 @@ paths: security: - accountSid_authToken: [] operationId: DeleteIncomingPhoneNumberAssignedAddOn - x-maturity: - - Beta /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - description - pathType: list dependentProperties: - assigned_add_on_extension: '{account_sid: account_sid, resource_sid: resource_sid, - assigned_add_on_sid: sid}' + extensions: + mapping: + account_sid: account_sid + resource_sid: resource_sid + assigned_add_on_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers/{resource_sid}/AssignedAddOns/{assigned_add_on_sid}/Extensions.json parent: /Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json + pathType: list get: description: Retrieve a list of Add-on installations currently assigned to this Number. + tags: + - Api20100401AssignedAddOn parameters: - name: AccountSid in: path @@ -15318,45 +19119,122 @@ paths: responses: '200': content: - application/json: - schema: - type: object - title: ListIncomingPhoneNumberAssignedAddOnResponse - properties: - assigned_add_ons: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + application/json: + schema: + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListIncomingPhoneNumberAssignedAddOnResponse + properties: + assigned_add_ons: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AssignedAddOn") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AssignedAddOn")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AssignedAddOns")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + assigned_add_ons: + - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: Thu, 07 Apr 2016 23:52:28 +0000 + date_updated: Thu, 07 Apr 2016 23:52:28 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + extensions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + assigned_add_ons: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumberAssignedAddOn - x-maturity: - - Beta post: description: Assign an Add-on installation to the Number specified. + tags: + - Api20100401AssignedAddOn parameters: - name: AccountSid in: path @@ -15383,12 +19261,26 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' + examples: + create: + value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: Thu, 07 Apr 2016 23:52:28 +0000 + date_updated: Thu, 07 Apr 2016 23:52:28 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + extensions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json description: Created security: - accountSid_authToken: [] operationId: CreateIncomingPhoneNumberAssignedAddOn - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -15404,21 +19296,27 @@ paths: description: The SID that identifies the Add-on installation. required: - InstalledAddOnSid + examples: + create: + value: + InstalledAddOnSid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ? /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions/{Sid}.json : servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - product_name - pathType: instance parent: /Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json className: assigned_add_on_extension + pathType: instance get: description: Fetch an instance of an Extension for the Assigned Add-on. + tags: + - Api20100401AssignedAddOnExtension parameters: - name: AccountSid in: path @@ -15464,27 +19362,39 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension' + examples: + fetch: + value: + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assigned_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + enabled: true description: OK security: - accountSid_authToken: [] operationId: FetchIncomingPhoneNumberAssignedAddOnExtension - x-maturity: - - Beta /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - product_name - pathType: list parent: /Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json className: assigned_add_on_extension + pathType: list get: description: Retrieve a list of Extensions for the Assigned Add-on. + tags: + - Api20100401AssignedAddOnExtension parameters: - name: AccountSid in: path @@ -15538,41 +19448,112 @@ paths: content: application/json: schema: - type: object - title: ListIncomingPhoneNumberAssignedAddOnExtensionResponse - properties: - extensions: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListIncomingPhoneNumberAssignedAddOnExtensionResponse + properties: + extensions: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AssignedAddOnExtension") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AssignedAddOnExtension")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Extensions")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + extensions: + - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assigned_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: true + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + extensions: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumberAssignedAddOnExtension - x-maturity: - - Beta /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json: servers: - url: https://api.twilio.com @@ -15582,10 +19563,12 @@ paths: - sid - phone_number - friendly_name - pathType: list parent: /Accounts/{AccountSid}/IncomingPhoneNumbers.json + pathType: list get: description: '' + tags: + - Api20100401Local parameters: - name: AccountSid in: path @@ -15603,11 +19586,25 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: FriendlyName in: query description: A string that identifies the resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -15615,6 +19612,11 @@ paths: schema: type: string format: phone-number + examples: + readFull: + value: '+19876543210' + readEmpty: + value: '+19876543210' - name: Origin in: query description: 'Whether to include phone numbers based on their origin. Can @@ -15645,43 +19647,144 @@ paths: content: application/json: schema: - type: object - title: ListIncomingPhoneNumberLocalResponse - properties: - incoming_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListIncomingPhoneNumberLocalResponse + properties: + incoming_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Local") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Local")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IncomingPhoneNumbers")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: null + capabilities: + mms: true + sms: false + voice: true + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumberLocal - x-maturity: - - GA post: description: '' + tags: + - Api20100401Local parameters: - name: AccountSid in: path @@ -15699,12 +19802,51 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: friendly_name + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: https://example.com + sms_method: GET + sms_url: https://example.com + status_callback: https://example.com + status_callback_method: GET + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_caller_id_lookup: true + voice_fallback_method: GET + voice_fallback_url: https://example.com + voice_method: GET + voice_url: https://example.com + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use description: Created security: - accountSid_authToken: [] operationId: CreateIncomingPhoneNumberLocal - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -15893,6 +20035,31 @@ paths: Regulations. required: - PhoneNumber + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ApiVersion: api_version + AreaCode: area_code + EmergencyStatus: Active + EmergencyAddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + IdentitySid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + PhoneNumber: '+18089255327' + SmsApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VoiceCallerIdLookup: 'true' + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + BundleSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Mobile.json: servers: - url: https://api.twilio.com @@ -15902,10 +20069,12 @@ paths: - sid - phone_number - friendly_name - pathType: list parent: /Accounts/{AccountSid}/IncomingPhoneNumbers.json + pathType: list get: description: '' + tags: + - Api20100401Mobile parameters: - name: AccountSid in: path @@ -15923,11 +20092,25 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: FriendlyName in: query description: A string that identifies the resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -15935,6 +20118,11 @@ paths: schema: type: string format: phone-number + examples: + readFull: + value: '+19876543210' + readEmpty: + value: '+19876543210' - name: Origin in: query description: 'Whether to include phone numbers based on their origin. Can @@ -15965,43 +20153,144 @@ paths: content: application/json: schema: - type: object - title: ListIncomingPhoneNumberMobileResponse - properties: - incoming_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListIncomingPhoneNumberMobileResponse + properties: + incoming_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Mobile") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Mobile")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IncomingPhoneNumbers")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: null + capabilities: + mms: true + sms: false + voice: true + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumberMobile - x-maturity: - - GA post: description: '' + tags: + - Api20100401Mobile parameters: - name: AccountSid in: path @@ -16019,12 +20308,51 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: friendly_name + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: https://example.com + sms_method: GET + sms_url: https://example.com + status_callback: https://example.com + status_callback_method: GET + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_caller_id_lookup: true + voice_fallback_method: GET + voice_fallback_url: https://example.com + voice_method: GET + voice_url: https://example.com + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use description: Created security: - accountSid_authToken: [] operationId: CreateIncomingPhoneNumberMobile - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -16212,6 +20540,31 @@ paths: Regulations. required: - PhoneNumber + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ApiVersion: api_version + AreaCode: area_code + EmergencyStatus: Active + EmergencyAddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + IdentitySid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + PhoneNumber: '+18089255327' + SmsApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VoiceCallerIdLookup: 'true' + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + BundleSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json: servers: - url: https://api.twilio.com @@ -16221,10 +20574,12 @@ paths: - sid - phone_number - friendly_name - pathType: list parent: /Accounts/{AccountSid}/IncomingPhoneNumbers.json + pathType: list get: description: '' + tags: + - Api20100401TollFree parameters: - name: AccountSid in: path @@ -16242,11 +20597,25 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: FriendlyName in: query description: A string that identifies the resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -16254,6 +20623,11 @@ paths: schema: type: string format: phone-number + examples: + readFull: + value: '+19876543210' + readEmpty: + value: '+19876543210' - name: Origin in: query description: 'Whether to include phone numbers based on their origin. Can @@ -16284,43 +20658,144 @@ paths: content: application/json: schema: - type: object - title: ListIncomingPhoneNumberTollFreeResponse - properties: - incoming_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListIncomingPhoneNumberTollFreeResponse + properties: + incoming_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free' + x-field-extra-annotation: '@JacksonXmlProperty(localName="TollFree") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="TollFree")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IncomingPhoneNumbers")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: null + capabilities: + mms: true + sms: false + voice: true + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumberTollFree - x-maturity: - - GA post: description: '' + tags: + - Api20100401TollFree parameters: - name: AccountSid in: path @@ -16338,12 +20813,51 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: friendly_name + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: https://example.com + sms_method: GET + sms_url: https://example.com + status_callback: https://example.com + status_callback_method: GET + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_caller_id_lookup: true + voice_fallback_method: GET + voice_fallback_url: https://example.com + voice_method: GET + voice_url: https://example.com + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use description: Created security: - accountSid_authToken: [] operationId: CreateIncomingPhoneNumberTollFree - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -16531,6 +21045,31 @@ paths: Regulations. required: - PhoneNumber + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ApiVersion: api_version + AreaCode: area_code + EmergencyStatus: Active + EmergencyAddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + IdentitySid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + PhoneNumber: '+18089255327' + SmsApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VoiceCallerIdLookup: 'true' + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + BundleSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json: servers: - url: https://api.twilio.com @@ -16540,10 +21079,12 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: '' + tags: + - Api20100401Key parameters: - name: AccountSid in: path @@ -16571,14 +21112,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.key' + examples: + fetch: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 description: OK security: - accountSid_authToken: [] operationId: FetchKey - x-maturity: - - GA post: description: '' + tags: + - Api20100401Key parameters: - name: AccountSid in: path @@ -16606,12 +21154,17 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.key' + examples: + update: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 description: OK security: - accountSid_authToken: [] operationId: UpdateKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -16623,8 +21176,14 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + update: + value: + FriendlyName: foo delete: description: '' + tags: + - Api20100401Key parameters: - name: AccountSid in: path @@ -16652,8 +21211,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteKey - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Keys.json: servers: - url: https://api.twilio.com @@ -16663,10 +21220,12 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: '' + tags: + - Api20100401Key parameters: - name: AccountSid in: path @@ -16702,43 +21261,111 @@ paths: content: application/json: schema: - type: object - title: ListKeyResponse - properties: - keys: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.key' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListKeyResponse + properties: + keys: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.key' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Key") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Key")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Keys")' + examples: + readFull: + value: + keys: + - sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readEmpty: + value: + keys: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListKey - x-maturity: - - GA post: description: '' + tags: + - Api20100401NewKey parameters: - name: AccountSid in: path @@ -16756,12 +21383,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.new_key' + examples: + create: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 + secret: foobar description: Created security: - accountSid_authToken: [] operationId: CreateNewKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -16773,28 +21406,33 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + create: + value: + FriendlyName: foo x-twilio: mountName: new_keys /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{Sid}.json: servers: - url: https://api.twilio.com - description: The Media resource represents a piece of media, such as an image, - that is associated with a message. + description: The Media subresource of a Message resource represents a piece of + media, such as an image, that is associated with the Message. x-twilio: defaultOutputProperties: - sid - parent_sid - content_type - pathType: instance parent: /Accounts/{AccountSid}/Messages/{Sid}.json + pathType: instance delete: - description: Delete media from your account. Once delete, you will no longer - be billed + description: Delete the Media resource. + tags: + - Api20100401Media parameters: - name: AccountSid in: path description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Media resource(s) to delete. + that is associated with the Media resource. schema: type: string minLength: 34 @@ -16803,8 +21441,8 @@ paths: required: true - name: MessageSid in: path - description: The SID of the Message resource that this Media resource belongs - to. + description: The SID of the Message resource that is associated with the Media + resource. schema: type: string minLength: 34 @@ -16813,8 +21451,7 @@ paths: required: true - name: Sid in: path - description: The Twilio-provided string that uniquely identifies the Media - resource to delete + description: The unique identifier of the to-be-deleted Media resource. schema: type: string minLength: 34 @@ -16827,16 +21464,16 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMedia - x-maturity: - - GA get: - description: Fetch a single media instance belonging to the account used to - make the request + description: Fetch a single Media resource associated with a specific Message + resource + tags: + - Api20100401Media parameters: - name: AccountSid in: path description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Media resource(s) to fetch. + associated with the Media resource. schema: type: string minLength: 34 @@ -16845,8 +21482,8 @@ paths: required: true - name: MessageSid in: path - description: The SID of the Message resource that this Media resource belongs - to. + description: The SID of the Message resource that is associated with the Media + resource. schema: type: string minLength: 34 @@ -16856,7 +21493,7 @@ paths: - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Media - resource to fetch + resource to fetch. schema: type: string minLength: 34 @@ -16869,32 +21506,42 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message.media' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + content_type: image/jpeg + date_created: Sun, 16 Aug 2015 15:53:54 +0000 + date_updated: Sun, 16 Aug 2015 15:53:55 +0000 + parent_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media/MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchMedia - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media.json: servers: - url: https://api.twilio.com - description: The Media resource represents a piece of media, such as an image, - that is associated with a message. + description: The Media subresource of a Message resource represents a piece of + media, such as an image, that is associated with the Message. x-twilio: defaultOutputProperties: - sid - parent_sid - content_type - pathType: list parent: /Accounts/{AccountSid}/Messages/{Sid}.json + pathType: list get: - description: Retrieve a list of Media resources belonging to the account used - to make the request + description: Read a list of Media resources associated with a specific Message + resource + tags: + - Api20100401Media parameters: - name: AccountSid in: path description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Media resource(s) to read. + that is associated with the Media resources. schema: type: string minLength: 34 @@ -16903,8 +21550,8 @@ paths: required: true - name: MessageSid in: path - description: The SID of the Message resource that this Media resource belongs - to. + description: The SID of the Message resource that is associated with the Media + resources. schema: type: string minLength: 34 @@ -16913,34 +21560,52 @@ paths: required: true - name: DateCreated in: query - description: 'Only include media that was created on this date. Specify a - date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that - was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, - to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` - to read media that was created on or after midnight of this date.' + description: 'Only include Media resources that were created on this date. + Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read + Media that were created on this date. You can also specify an inequality, + such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before + midnight of this date, and `StartTime>=YYYY-MM-DD` to read Media that were + created on or after midnight of this date.' schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: DateCreated< in: query - description: 'Only include media that was created on this date. Specify a - date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that - was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, - to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` - to read media that was created on or after midnight of this date.' + description: 'Only include Media resources that were created on this date. + Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read + Media that were created on this date. You can also specify an inequality, + such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before + midnight of this date, and `StartTime>=YYYY-MM-DD` to read Media that were + created on or after midnight of this date.' schema: type: string format: date-time + examples: + readFull: + value: '2008-01-01' + readEmpty: + value: '2008-01-01' - name: DateCreated> in: query - description: 'Only include media that was created on this date. Specify a - date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that - was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, - to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` - to read media that was created on or after midnight of this date.' + description: 'Only include Media resources that were created on this date. + Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read + Media that were created on this date. You can also specify an inequality, + such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before + midnight of this date, and `StartTime>=YYYY-MM-DD` to read Media that were + created on or after midnight of this date.' schema: type: string format: date-time + examples: + readFull: + value: '2008-01-03' + readEmpty: + value: '2008-01-03' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -16965,41 +21630,116 @@ paths: content: application/json: schema: - type: object - title: ListMediaResponse - properties: - media_list: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.message.media' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListMediaResponse + properties: + media_list: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.message.media' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Media") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Media")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "MediaList")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 + media_list: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + content_type: image/jpeg + date_created: Sun, 16 Aug 2015 15:53:54 +0000 + date_updated: Sun, 16 Aug 2015 15:53:55 +0000 + parent_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media/MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 + media_list: [] + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListMedia - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json: servers: - url: https://api.twilio.com @@ -17010,10 +21750,12 @@ paths: - date_enqueued - position - wait_time - pathType: instance parent: /Accounts/{AccountSid}/Queues/{Sid}.json + pathType: instance get: description: Fetch a specific member from the queue + tags: + - Api20100401Member parameters: - name: AccountSid in: path @@ -17047,15 +21789,32 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue.member' + examples: + fetch: + value: + queue_sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_enqueued: Tue, 07 Aug 2012 22:57:41 +0000 + position: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + wait_time: 143 + fetchFront: + value: + queue_sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_enqueued: Tue, 07 Aug 2012 22:57:41 +0000 + position: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + wait_time: 143 description: OK security: - accountSid_authToken: [] operationId: FetchMember - x-maturity: - - GA post: description: Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL + tags: + - Api20100401Member parameters: - name: AccountSid in: path @@ -17089,12 +21848,27 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue.member' + examples: + update: + value: + queue_sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_enqueued: Thu, 06 Dec 2018 18:42:47 +0000 + position: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + wait_time: 143 + dequeueFront: + value: + queue_sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_enqueued: Tue, 07 Aug 2012 22:57:41 +0000 + position: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + wait_time: 143 description: OK security: - accountSid_authToken: [] operationId: UpdateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -17121,6 +21895,15 @@ paths: form data and `GET` sends the data as query parameters. required: - Url + examples: + update: + value: + Method: GET + Url: https://example.com + dequeueFront: + value: + Method: GET + Url: https://example.com /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members.json: servers: - url: https://api.twilio.com @@ -17131,10 +21914,12 @@ paths: - date_enqueued - position - wait_time - pathType: list parent: /Accounts/{AccountSid}/Queues/{Sid}.json + pathType: list get: description: Retrieve the members of the queue + tags: + - Api20100401Member parameters: - name: AccountSid in: path @@ -17179,41 +21964,109 @@ paths: content: application/json: schema: - type: object - title: ListMemberResponse - properties: - queue_members: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.queue.member' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListMemberResponse + properties: + queue_members: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.queue.member' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Member") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Member")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "QueueMembers")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + queue_members: + - queue_sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_enqueued: Mon, 17 Dec 2018 18:36:39 +0000 + position: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + wait_time: 124 + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?Page=0&PageSize=50 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + queue_members: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json description: OK security: - accountSid_authToken: [] operationId: ListMember - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Messages.json: servers: - url: https://api.twilio.com @@ -17226,18 +22079,28 @@ paths: - status - direction - date_sent - pathType: list dependentProperties: - media: '{account_sid: account_sid, message_sid: sid}' - feedback: '{account_sid: account_sid, message_sid: sid}' + media: + mapping: + account_sid: account_sid + message_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Messages/{message_sid}/Media.json + feedback: + mapping: + account_sid: account_sid + message_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Messages/{message_sid}/Feedback.json parent: /Accounts/{Sid}.json + pathType: list post: - description: Send a message from the account used to make the request + description: Send a message + tags: + - Api20100401Message parameters: - name: AccountSid in: path description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that will create the resource. + creating the Message resource. schema: type: string minLength: 34 @@ -17250,12 +22113,181 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: "Hello! \U0001F44D" + date_created: Thu, 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! \U0001F44D" + date_created: Thu, 30 Jul 2015 20:12:31 +0000 + date_sent: Thu, 30 Jul 2015 20:12:33 +0000 + date_updated: Thu, 30 Jul 2015 20:12:33 +0000 + direction: outbound-api + error_code: null + error_message: null + from: '+14155552345' + messaging_service_sid: null + num_media: '0' + num_segments: '1' + price: null + price_unit: null + sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: 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! \U0001F44D" + date_created: Thu, 30 Jul 2015 20:12:31 +0000 + date_sent: Thu, 30 Jul 2015 20:12:33 +0000 + date_updated: Thu, 30 Jul 2015 20:12:33 +0000 + direction: outbound-api + error_code: null + error_message: null + from: null + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + num_media: '0' + num_segments: '1' + price: null + price_unit: null + sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: 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! \U0001F44D" + date_created: Thu, 30 Jul 2015 20:12:31 +0000 + date_sent: Thu, 30 Jul 2015 20:12:33 +0000 + date_updated: Thu, 30 Jul 2015 20:12:33 +0000 + direction: outbound-api + error_code: null + error_message: null + from: '+14155552345' + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + num_media: '0' + num_segments: '1' + price: null + price_unit: null + sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json + tags: null + to: '+14155552345' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createScheduledMessageSms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: "Hello! \U0001F44D" + date_created: Mon, 29 Nov 2021 22:40:10 +0000 + date_sent: null + date_updated: Mon, 29 Nov 2021 22:40:10 +0000 + direction: outbound-api + error_code: null + error_message: null + from: null + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + num_media: '0' + num_segments: '0' + price: null + price_unit: null + sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: 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! \U0001F44D" + date_created: Mon, 29 Nov 2021 22:40:10 +0000 + date_sent: null + date_updated: Mon, 29 Nov 2021 22:40:10 +0000 + direction: outbound-api + error_code: null + error_message: null + from: null + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + num_media: '1' + num_segments: '1' + price: null + price_unit: null + sid: MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: 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! \U0001F44D" + date_created: Mon, 29 Nov 2021 22:40:10 +0000 + date_sent: null + date_updated: Mon, 29 Nov 2021 22:40:10 +0000 + direction: outbound-api + error_code: null + error_message: null + from: null + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + num_media: '0' + num_segments: '0' + price: null + price_unit: null + sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: scheduled + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json + tags: null + to: whatsapp:+15558675310 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -17266,62 +22298,51 @@ paths: To: type: string format: phone-number - description: The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) - format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) - for other 3rd-party channels. + description: The recipient's phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) + format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/messaging/channels), + e.g. `whatsapp:+15552229999`. StatusCallback: type: string format: uri - description: 'The URL we should call using the `status_callback_method` - to send status information to your application. If specified, - we POST these message status changes to the URL: `queued`, `failed`, - `sent`, `delivered`, or `undelivered`. Twilio will POST its [standard - request parameters](https://www.twilio.com/docs/sms/twiml#request-parameters) - as well as some additional parameters including `MessageSid`, - `MessageStatus`, and `ErrorCode`. If you include this parameter - with the `messaging_service_sid`, we use this URL instead of the - Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/sms/services/api). - URLs must contain a valid hostname and underscores are not allowed.' + description: 'The URL of the endpoint to which Twilio sends [Message + status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). + URL must contain a valid hostname and underscores are not allowed. + If you include this parameter with the `messaging_service_sid`, + Twilio uses this URL instead of the Status Callback URL of the + [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource). ' ApplicationSid: type: string minLength: 34 maxLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ - description: The SID of the application that should receive message - status. We POST a `message_sid` parameter and a `message_status` - parameter with a value of `sent` or `failed` to the [application](https://www.twilio.com/docs/usage/api/applications)'s - `message_status_callback`. If a `status_callback` parameter is - also passed, it will be ignored and the application's `message_status_callback` - parameter will be used. + description: The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). + [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) + are sent to the TwiML App's `message_status_callback` URL. Note + that the `status_callback` parameter of a request takes priority + over the `application_sid` parameter; if both are included `application_sid` + is ignored. MaxPrice: type: number - description: The maximum total price in US dollars that you will - pay for the message to be delivered. Can be a decimal value that - has up to 4 decimal places. All messages are queued for delivery - and the message cost is checked before the message is sent. If - the cost exceeds `max_price`, the message will fail and a status - of `Failed` is sent to the status callback. If `MaxPrice` is not - set, the message cost is not checked. + description: '[DEPRECATED] This parameter will no longer have any + effect as of 2024-06-03.' ProvideFeedback: type: boolean - description: Whether to confirm delivery of the message. Set this - value to `true` if you are sending messages that have a trackable - user action and you intend to confirm delivery of the message - using the [Message Feedback API](https://www.twilio.com/docs/sms/api/message-feedback-resource). - This parameter is `false` by default. + description: Boolean indicating whether or not you intend to provide + delivery confirmation feedback to Twilio (used in conjunction + with the [Message Feedback subresource](https://www.twilio.com/docs/sms/api/message-feedback-resource)). + Default value is `false`. Attempt: type: integer - description: Total number of attempts made ( including this ) to - send out the message regardless of the provider used + description: Total number of attempts made (including this request) + to send the message regardless of the provider used ValidityPeriod: type: integer - description: How long in seconds the message can remain in our outgoing - message queue. After this period elapses, the message fails and - we call your status callback. Can be between 1 and the default - value of 14,400 seconds. After a message has been accepted by - a carrier, however, we cannot guarantee that the message will - not be queued after this period. We recommend that this value - be at least 5 seconds. + description: The maximum length in seconds that the Message can + remain in Twilio's outgoing message queue. If a queued Message + exceeds the `validity_period`, the Message is not sent. Accepted + values are integers from `1` to `14400`. Default value is `14400`. + A `validity_period` greater than `5` is recommended. [Learn more + about the validity period](https://www.twilio.com/blog/take-more-control-of-outbound-messages-using-validity-period-html) ForceDelivery: type: boolean description: Reserved @@ -17343,21 +22364,21 @@ paths: type: array items: type: string - description: Rich actions for Channels Messages. + description: Rich actions for non-SMS/MMS channels. Used for [sending + location in WhatsApp messages](https://www.twilio.com/docs/whatsapp/message-features#location-messages-with-whatsapp). ShortenUrls: type: boolean - description: Determines the usage of Click Tracking. Setting it - to `true` will instruct Twilio to replace all links in the Message - with a shortened version based on the associated Domain Sid and - track clicks on them. If this parameter is not set on an API call, - we will use the value set on the Messaging Service. If this parameter - is not set and the value is not configured on the Messaging Service - used this will default to `false`. + description: 'For Messaging Services with [Link Shortening configured](https://www.twilio.com/docs/messaging/features/link-shortening) + only: A Boolean indicating whether or not Twilio should shorten + links in the `body` of the Message. Default value is `false`. + If `true`, the `messaging_service_sid` parameter must also be + provided.' ScheduleType: type: string $ref: '#/components/schemas/message_enum_schedule_type' - description: Indicates your intent to schedule a message. Pass the - value `fixed` to schedule a message at a fixed time. + description: 'For Messaging Services only: Include this parameter + with a value of `fixed` in conjuction with the `send_time` parameter + in order to [schedule a Message](https://www.twilio.com/docs/messaging/features/message-scheduling).' SendAt: type: string format: date-time @@ -17365,78 +22386,170 @@ paths: in ISO 8601 format. SendAsMms: type: boolean - description: If set to True, Twilio will deliver the message as - a single MMS message, regardless of the presence of media. - ContentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^HX[0-9a-fA-F]{32}$ - description: The SID of the Content object returned at Content API - content create time (https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template). - If this parameter is not specified, then the Content API will - not be utilized. + description: If set to `true`, Twilio delivers the message as a + single MMS message, regardless of the presence of media. ContentVariables: type: string - description: Key-value pairs of variable names to substitution values, - used alongside a content_sid. If not specified, Content API will - default to the default variables defined at create time. + description: 'For [Content Editor/API](https://www.twilio.com/docs/content) + only: Key-value pairs of [Template variables](https://www.twilio.com/docs/content/using-variables-with-content-api) + and their substitution values. `content_sid` parameter must also + be provided. If values are not defined in the `content_variables` + parameter, the [Template''s default placeholder values](https://www.twilio.com/docs/content/content-api-resources#create-templates) + are used.' + RiskCheck: + type: string + $ref: '#/components/schemas/message_enum_risk_check' + description: 'For SMS pumping protection feature only: Include this + parameter with a value of `disable` to skip any kind of risk check + on the respective message request.' From: type: string format: phone-number - description: A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) - format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), - or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) - that is enabled for the type of message you want to send. Phone - numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) - purchased from Twilio also work here. You cannot, for example, - spoof messages from a private cell phone number. If you are using - `messaging_service_sid`, this parameter must be empty. + description: The sender's Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) + format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), + [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), + [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), + or [channel address](https://www.twilio.com/docs/messaging/channels) + (e.g., `whatsapp:+15554449999`). The value of the `from` parameter + must be a sender that is hosted within Twilio and belongs to the + Account creating the Message. If you are using `messaging_service_sid`, + this parameter can be empty (Twilio assigns a `from` value from + the Messaging Service's Sender Pool) or you can provide a specific + sender from your Sender Pool. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) - you want to associate with the Message. Set this parameter to - use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) - you have configured and leave the `from` parameter empty. When - only this parameter is set, Twilio will use your enabled Copilot - Features to select the `from` phone number for delivery. + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services) + you want to associate with the Message. When this parameter is + provided and the `from` parameter is omitted, Twilio selects the + optimal sender from the Messaging Service's Sender Pool. You may + also provide a `from` parameter if you want to use a specific + Sender from the Sender Pool. Body: type: string - description: The text of the message you want to send. Can be up - to 1,600 characters in length. + description: 'The text content of the outgoing message. Can be up + to 1,600 characters in length. SMS only: If the `body` contains + more than 160 [GSM-7](https://www.twilio.com/docs/glossary/what-is-gsm-7-character-encoding) + characters (or 70 [UCS-2](https://www.twilio.com/docs/glossary/what-is-ucs-2-character-encoding) + characters), the message is segmented and charged accordingly. + For long `body` text, consider using the [send_as_mms parameter](https://www.twilio.com/blog/mms-for-long-text-messages).' MediaUrl: type: array items: type: string format: uri - description: The URL of the media to send with the message. The - media can be of type `gif`, `png`, and `jpeg` and will be formatted - correctly on the recipient's device. The media size limit is 5MB - for supported file types (JPEG, PNG, GIF) and 500KB for [other - types](https://www.twilio.com/docs/sms/accepted-mime-types) of - accepted media. To send more than one image in the message body, + description: The URL of media to include in the Message content. + `jpeg`, `jpg`, `gif`, and `png` file types are fully supported + by Twilio and content is formatted for delivery on destination + devices. The media size limit is 5 MB for supported file types + (`jpeg`, `jpg`, `png`, `gif`) and 500 KB for [other types](https://www.twilio.com/docs/messaging/guides/accepted-mime-types) + of accepted media. To send more than one image in the message, provide multiple `media_url` parameters in the POST request. You - can include up to 10 `media_url` parameters per message. You can - send images in an SMS message in only the US and Canada. + can include up to ten `media_url` parameters per message. [International](https://support.twilio.com/hc/en-us/articles/223179808-Sending-and-receiving-MMS-messages) + and [carrier](https://support.twilio.com/hc/en-us/articles/223133707-Is-MMS-supported-for-all-carriers-in-US-and-Canada-) + limits apply. + ContentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + description: 'For [Content Editor/API](https://www.twilio.com/docs/content) + only: The SID of the Content Template to be used with the Message, + e.g., `HXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`. If this parameter is not + provided, a Content Template is not used. Find the SID in the + Console on the Content Editor page. For Content API users, the + SID is found in Twilio''s response when [creating the Template](https://www.twilio.com/docs/content/content-api-resources#create-templates) + or by [fetching your Templates](https://www.twilio.com/docs/content/content-api-resources#fetch-all-content-resources).' required: - To + examples: + create: + value: + ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Body: "Hello! \U0001F44D" + From: '+14155552345' + MediaUrl: + - https://c1.staticflickr.com/3/2899/14341091933_1e92e62d12_b.jpg + PersistentAction: + - mailto:test@example.com + StatusCallback: https://example.com + To: '+14155552345' + Tags: '{"campaign_name": "Spring Sale 2022","message_type": "cart_abandoned"}' + createWoService: + value: + ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Body: "Hello! \U0001F44D" + From: '+14155552345' + MediaUrl: + - https://example.com + PersistentAction: + - mailto:test@example.com + StatusCallback: https://example.com + To: '+14155552345' + createWithMessagingService: + value: + ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Body: "Hello! \U0001F44D" + 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! \U0001F44D" + From: '+14155552345' + MediaUrl: + - https://example.com + PersistentAction: + - mailto:test@example.com + StatusCallback: https://example.com + To: '+14155552345' + createScheduledMessageSms: + value: + Body: "Hello! \U0001F44D" + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ScheduleType: fixed + StatusCallback: https://example.com + To: '+15558675310' + createScheduledMessageMms: + value: + Body: "Hello! \U0001F44D" + MediaUrl: + - https://example.com + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ScheduleType: fixed + StatusCallback: https://example.com + To: '+15558675310' + createScheduledMessageWhatsapp: + value: + Body: "Hello! \U0001F44D" + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ScheduleType: fixed + StatusCallback: https://example.com + To: 94287277+15558675310 x-twilio: conditional: - - from - messaging_service_sid - - body - media_url + - content_sid get: - description: Retrieve a list of messages belonging to the account used to make - the request + description: Retrieve a list of Message resources associated with a Twilio Account + tags: + - Api20100401Message parameters: - name: AccountSid in: path description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Message resources to read. + associated with the Message resources. schema: type: string minLength: 34 @@ -17445,47 +22558,111 @@ paths: required: true - name: To in: query - description: Read messages sent to only this phone number. + description: 'Filter by recipient. For example: Set this `to` parameter to + `+15558881111` to retrieve a list of Message resources with `to` properties + of `+15558881111`' schema: type: string format: phone-number + x-twilio: + pii: + 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' - name: From in: query - description: Read messages sent from only this phone number or alphanumeric - sender ID. + description: 'Filter by sender. For example: Set this `from` parameter to + `+15552229999` to retrieve a list of Message resources with `from` properties + of `+15552229999`' schema: type: string format: phone-number + x-twilio: + pii: + 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' - name: DateSent in: query - description: 'The date of the messages to show. Specify a date as `YYYY-MM-DD` - in GMT to read only messages sent on this date. For example: `2009-07-06`. - You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read - messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` - to read messages sent on or after midnight on a date.' + description: 'Filter by Message `sent_date`. Accepts GMT dates in the following + formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` + (to find Messages with `sent_date`s on and before a specific date), and + `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific + date).' schema: type: string format: date-time + examples: + readEmptySentdateEquals: + value: '2008-01-02' - name: DateSent< in: query - description: 'The date of the messages to show. Specify a date as `YYYY-MM-DD` - in GMT to read only messages sent on this date. For example: `2009-07-06`. - You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read - messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` - to read messages sent on or after midnight on a date.' + description: 'Filter by Message `sent_date`. Accepts GMT dates in the following + formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` + (to find Messages with `sent_date`s on and before a specific date), and + `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific + date).' schema: type: string format: date-time + x-twilio: + shortDescription: Filter by Message `sent_date` + ignoreFormat: true + examples: + readEmptySentdateLess: + value: '2008-01-02' - name: DateSent> in: query - description: 'The date of the messages to show. Specify a date as `YYYY-MM-DD` - in GMT to read only messages sent on this date. For example: `2009-07-06`. - You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read - messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` - to read messages sent on or after midnight on a date.' + description: 'Filter by Message `sent_date`. Accepts GMT dates in the following + formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` + (to find Messages with `sent_date`s on and before a specific date), and + `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific + date).' schema: type: string format: date-time + x-twilio: + shortDescription: Filter by Message `sent_date` + ignoreFormat: true + examples: + readFullPage1: + value: '2008-01-02' + readEmptySentdateGreater: + value: '2008-01-02' + readEmptySentdateGreaterFormat1: + value: 06/11/2019 22:05:25 MST + readEmptySentdateGreaterFormat2: + value: '2019-06-11 22:05:25.000' + readEmptySentdateGreaterFormat3: + value: Wed, 19 Jun 2019 22:04:00 -0000 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -17510,41 +22687,208 @@ paths: content: application/json: schema: - type: object - title: ListMessageResponse - properties: - messages: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.message' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListMessageResponse + properties: + messages: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.message' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Message") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Message")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Messages")' + examples: + readFullPage1: + value: + end: 1 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=1&PageToken=PAMMc26223853f8c46b4ab7dfaa6abba0a26 + page: 0 + page_size: 2 + previous_page_uri: null + messages: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: testing + date_created: Fri, 24 May 2019 17:44:46 +0000 + date_sent: Fri, 24 May 2019 17:44:50 +0000 + date_updated: Fri, 24 May 2019 17:44:50 +0000 + direction: outbound-api + error_code: null + error_message: null + from: '+12019235161' + messaging_service_sid: null + num_media: '0' + num_segments: '1' + price: '-0.00750' + price_unit: USD + sid: SMded05904ccb347238880ca9264e8fe1c + status: sent + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c/Media.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c/Feedback.json + tags: + campaign_name: Spring Sale 2022 + message_type: cart_abandoned + to: '+18182008801' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c.json + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: look mom I have media! + date_created: Fri, 24 May 2019 17:44:46 +0000 + date_sent: Fri, 24 May 2019 17:44:49 +0000 + date_updated: Fri, 24 May 2019 17:44:49 +0000 + direction: inbound + error_code: 30004 + error_message: Message blocked + from: '+12019235161' + messaging_service_sid: null + num_media: '3' + num_segments: '1' + price: '-0.00750' + price_unit: USD + sid: MMc26223853f8c46b4ab7dfaa6abba0a26 + status: received + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26/Media.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26/Feedback.json + tags: + campaign_name: Spring Sale 2022 + message_type: cart_abandoned + to: '+18182008801' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=0 + readEmptySentdateLess: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3C=2008-01-02&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3C=2008-01-02&PageSize=25&Page=0 + readEmptySentdateEquals: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent=2008-01-02&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent=2008-01-02&PageSize=25&Page=0 + readEmptySentdateGreater: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=25&Page=0 + readEmptySentdateGreaterFormat1: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=25&Page=0 + readEmptySentdateGreaterFormat2: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2019-06-11+22%3A05%3A25.000&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2019-06-11+22%3A05%3A25.000&PageSize=25&Page=0 + readEmptySentdateGreaterFormat3: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=Wed%2C+19+Jun+2019+22%3A04%3A00+-0000&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=Wed%2C+19+Jun+2019+22%3A04%3A00+-0000&PageSize=25&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListMessage - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json: servers: - url: https://api.twilio.com @@ -17557,18 +22901,28 @@ paths: - status - direction - date_sent - pathType: instance dependentProperties: - media: '{account_sid: account_sid, message_sid: sid}' - feedback: '{account_sid: account_sid, message_sid: sid}' + media: + mapping: + account_sid: account_sid + message_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Messages/{message_sid}/Media.json + feedback: + mapping: + account_sid: account_sid + message_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Messages/{message_sid}/Feedback.json parent: /Accounts/{Sid}.json + pathType: instance delete: - description: Deletes a message record from your account + description: Deletes a Message resource from your account + tags: + - Api20100401Message parameters: - name: AccountSid in: path description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Message resources to delete. + associated with the Message resource schema: type: string minLength: 34 @@ -17577,8 +22931,7 @@ paths: required: true - name: Sid in: path - description: The Twilio-provided string that uniquely identifies the Message - resource to delete. + description: The SID of the Message resource you wish to delete schema: type: string minLength: 34 @@ -17591,15 +22944,15 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessage - x-maturity: - - GA get: - description: Fetch a message belonging to the account used to make the request + description: Fetch a specific Message + tags: + - Api20100401Message parameters: - name: AccountSid in: path description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Message resource to fetch. + associated with the Message resource schema: type: string minLength: 34 @@ -17608,8 +22961,7 @@ paths: required: true - name: Sid in: path - description: The Twilio-provided string that uniquely identifies the Message - resource to fetch. + description: The SID of the Message resource to be fetched schema: type: string minLength: 34 @@ -17622,15 +22974,43 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: testing + date_created: Fri, 24 May 2019 17:18:27 +0000 + date_sent: Fri, 24 May 2019 17:18:28 +0000 + date_updated: Fri, 24 May 2019 17:18:28 +0000 + direction: outbound-api + error_code: 30007 + error_message: Carrier violation + from: '+12019235161' + messaging_service_sid: MGdeadbeefdeadbeefdeadbeefdeadbeef + num_media: '0' + num_segments: '1' + price: '-0.00750' + price_unit: USD + sid: SMb7c0a2ce80504485a6f653a7110836f5 + status: sent + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json + tags: + campaign_name: Spring Sale 2022 + message_type: cart_abandoned + to: '+18182008801' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json description: OK security: - accountSid_authToken: [] operationId: FetchMessage - x-maturity: - - GA post: - description: To redact a message-body from a post-flight message record, post - to the message instance resource with an empty body + description: Update a Message resource (used to redact Message `body` text and + to cancel not-yet-sent messages) + tags: + - Api20100401Message parameters: - name: AccountSid in: path @@ -17644,8 +23024,7 @@ paths: required: true - name: Sid in: path - description: The Twilio-provided string that uniquely identifies the Message - resource to update. + description: The SID of the Message resource to be updated schema: type: string minLength: 34 @@ -17658,12 +23037,61 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message' + examples: + redactBody: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: '' + date_created: Fri, 24 May 2019 17:18:27 +0000 + date_sent: Fri, 24 May 2019 17:18:28 +0000 + date_updated: Fri, 24 May 2019 17:18:28 +0000 + direction: outbound-api + error_code: null + error_message: null + from: '+12019235161' + messaging_service_sid: MGdeadbeefdeadbeefdeadbeefdeadbeef + num_media: '0' + num_segments: '1' + price: null + price_unit: USD + sid: SMb7c0a2ce80504485a6f653a7110836f5 + status: sent + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json + tags: {} + to: '+18182008801' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json + cancelMessage: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: Hello World! + date_created: Fri, 24 May 2019 17:18:27 +0000 + date_sent: null + date_updated: Fri, 24 May 2019 18:18:28 +0000 + direction: outbound-api + error_code: null + error_message: null + from: null + messaging_service_sid: MGdeadbeefdeadbeefdeadbeefdeadbeef + num_media: '0' + num_segments: '1' + price: null + price_unit: USD + sid: SMb7c0a2ce80504485a6f653a7110836f5 + status: canceled + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json + tags: {} + to: '+18182008801' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json description: OK security: - accountSid_authToken: [] operationId: UpdateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -17673,31 +23101,45 @@ paths: properties: Body: type: string - description: The text of the message you want to send. Can be up - to 1,600 characters long. + description: The new `body` of the Message resource. To redact the + text content of a Message, this parameter's value must be an empty + string Status: type: string $ref: '#/components/schemas/message_enum_update_status' - description: When set as `canceled`, allows a message cancelation - request if a message has not yet been sent. + 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 /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Feedback.json: servers: - url: https://api.twilio.com - description: Customer-provided feedback on delivery confirmation + description: The MessageFeedback subresource of a Message resource. MessageFeedback + contains the reported outcome of whether the Message recipient performed a tracked + user action. x-twilio: defaultOutputProperties: - message_sid - outcome - date_created - pathType: list parent: /Accounts/{AccountSid}/Messages/{Sid}.json + pathType: list post: - description: '' + description: Create Message Feedback to confirm a tracked user action was performed + by the recipient of the associated Message + tags: + - Api20100401Feedback parameters: - name: AccountSid in: path description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that will create the resource. + associated with the Message resource for which to create MessageFeedback. schema: type: string minLength: 34 @@ -17706,7 +23148,7 @@ paths: required: true - name: MessageSid in: path - description: The SID of the Message resource for which the feedback was provided. + description: The SID of the Message resource for which to create MessageFeedback. schema: type: string minLength: 34 @@ -17719,12 +23161,19 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message.message_feedback' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + message_sid: MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + outcome: confirmed + uri: uri description: Created security: - accountSid_authToken: [] operationId: CreateMessageFeedback - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -17735,11 +23184,16 @@ paths: Outcome: type: string $ref: '#/components/schemas/message_feedback_enum_outcome' - description: 'Whether the feedback has arrived. Can be: `unconfirmed` - or `confirmed`. If `provide_feedback`=`true` in [the initial HTTP - POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), - the initial value of this property is `unconfirmed`. After the - message arrives, update the value to `confirmed`.' + 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 /2010-04-01/Accounts/{AccountSid}/SigningKeys.json: servers: - url: https://api.twilio.com @@ -17749,10 +23203,12 @@ paths: - sid - friendly_name - secret - pathType: list parent: /Accounts/{Sid}.json + pathType: list post: description: Create a new Signing Key for the account making the request. + tags: + - Api20100401NewSigningKey parameters: - name: AccountSid in: path @@ -17770,12 +23226,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.new_signing_key' + examples: + create: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 + secret: foobar description: Created security: - accountSid_authToken: [] operationId: CreateNewSigningKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -17787,10 +23249,16 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + create: + value: + FriendlyName: foo x-twilio: mountName: new_signing_keys get: description: '' + tags: + - Api20100401SigningKey parameters: - name: AccountSid in: path @@ -17825,41 +23293,107 @@ paths: content: application/json: schema: - type: object - title: ListSigningKeyResponse - properties: - signing_keys: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.signing_key' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListSigningKeyResponse + properties: + signing_keys: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.signing_key' + x-field-extra-annotation: '@JacksonXmlProperty(localName="SigningKey") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="SigningKey")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "SigningKeys")' + examples: + readFull: + value: + signing_keys: + - sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readEmpty: + value: + signing_keys: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListSigningKey - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Notifications/{Sid}.json: servers: - url: https://api.twilio.com @@ -17870,11 +23404,13 @@ paths: - call_sid - error_code - message_date - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch a notification belonging to the account used to make the request + tags: + - Api20100401Notification parameters: - name: AccountSid in: path @@ -17902,12 +23438,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.notification-instance' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Mon, 13 Sep 2010 20:02:01 +0000 + date_updated: Mon, 13 Sep 2010 20:02:01 +0000 + error_code: '11200' + log: '0' + message_date: Mon, 13 Sep 2010 20:02:00 +0000 + message_text: EmailNotification=false&LogLevel=ERROR&sourceComponent=12000&Msg=&httpResponse=500&ErrorCode=11200&url=http%3A%2F%2Fvoiceforms4000.appspot.com%2Ftwiml + more_info: http://www.twilio.com/docs/errors/11200 + request_method: get + request_url: https://voiceforms4000.appspot.com/twiml/9436/question/0 + request_variables: AccountSid=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&CallStatus=in-progress&ToZip=94937&ToCity=INVERNESS&ToState=CA&Called=%2B14156694923&To=%2B14156694923&ToCountry=US&CalledZip=94937&Direction=inbound&ApiVersion=2010-04-01&Caller=%2B17378742833&CalledCity=INVERNESS&CalledCountry=US&CallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&CalledState=CA&From=%2B17378742833 + response_body: Response body from your webhook URL as a string. + response_headers: Date=Mon%2C+13+Sep+2010+20%3A02%3A00+GMT&Content-Length=466&Connection=close&Content-Type=text%2Fhtml%3B+charset%3DUTF-8&Server=Google+Frontend + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchNotification - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Notifications.json: servers: - url: https://api.twilio.com @@ -17918,11 +23472,13 @@ paths: - call_sid - error_code - message_date - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of notifications belonging to the account used to make the request + tags: + - Api20100401Notification parameters: - name: AccountSid in: path @@ -17941,6 +23497,11 @@ paths: By default, all notifications are read.' schema: type: integer + examples: + readFull: + value: 1 + readEmpty: + value: 1 - name: MessageDate in: query description: Only show notifications for the specified date, formatted as @@ -17950,6 +23511,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: MessageDate< in: query description: Only show notifications for the specified date, formatted as @@ -17992,41 +23558,117 @@ paths: content: application/json: schema: - type: object - title: ListNotificationResponse - properties: - notifications: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.notification' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListNotificationResponse + properties: + notifications: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.notification' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Notification") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Notification")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Notifications")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 + previous_page_uri: null + next_page_uri: null + notifications: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Apr 2015 16:47:33 +0000 + date_updated: Thu, 30 Apr 2015 16:47:35 +0000 + error_code: '21609' + log: '1' + message_date: Thu, 30 Apr 2015 16:47:32 +0000 + message_text: LogLevel=WARN&invalidStatusCallbackUrl=&Msg=Invalid+Url+for+callSid%3A+CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa+invalid+statusCallbackUrl%3A+&ErrorCode=21609 + more_info: https://www.twilio.com/docs/errors/21609 + request_method: null + request_url: '' + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + page: 0 + page_size: 1 + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 + next_page_uri: null + notifications: [] + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListNotification - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json: servers: - url: https://api.twilio.com @@ -18038,11 +23680,13 @@ paths: - sid - phone_number - friendly_name - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an outgoing-caller-id belonging to the account used to make the request + tags: + - Api20100401OutgoingCallerId parameters: - name: AccountSid in: path @@ -18070,14 +23714,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' + examples: + fetch: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: (415) 867-5309 + phone_number: '+141586753096' + date_created: Fri, 21 Aug 2009 00:11:24 +0000 + date_updated: Fri, 21 Aug 2009 00:11:24 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchOutgoingCallerId - x-maturity: - - GA post: description: Updates the caller-id + tags: + - Api20100401OutgoingCallerId parameters: - name: AccountSid in: path @@ -18105,12 +23759,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 21 Aug 2009 00:11:24 +0000 + date_updated: Fri, 21 Aug 2009 00:11:24 +0000 + friendly_name: friendly_name + phone_number: '+141586753096' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateOutgoingCallerId - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -18122,8 +23784,14 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + update: + value: + FriendlyName: friendly_name delete: description: Delete the caller-id specified from the account + tags: + - Api20100401OutgoingCallerId parameters: - name: AccountSid in: path @@ -18151,8 +23819,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteOutgoingCallerId - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json: servers: - url: https://api.twilio.com @@ -18164,11 +23830,13 @@ paths: - sid - phone_number - friendly_name - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of outgoing-caller-ids belonging to the account used to make the request + tags: + - Api20100401OutgoingCallerId parameters: - name: AccountSid in: path @@ -18186,12 +23854,20 @@ paths: schema: type: string format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: FriendlyName in: query description: The string that identifies the OutgoingCallerId resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -18216,43 +23892,114 @@ paths: content: application/json: schema: - type: object - title: ListOutgoingCallerIdResponse - properties: - outgoing_caller_ids: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListOutgoingCallerIdResponse + properties: + outgoing_caller_ids: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' + x-field-extra-annotation: '@JacksonXmlProperty(localName="OutgoingCallerId") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="OutgoingCallerId")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "OutgoingCallerIds")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0 + next_page_uri: null + outgoing_caller_ids: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 21 Aug 2009 00:11:24 +0000 + date_updated: Fri, 21 Aug 2009 00:11:24 +0000 + friendly_name: (415) 867-5309 + phone_number: '+141586753096' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0 + next_page_uri: null + outgoing_caller_ids: [] + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListOutgoingCallerId - x-maturity: - - GA post: description: '' + tags: + - Api20100401ValidationRequest parameters: - name: AccountSid in: path @@ -18270,12 +24017,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.validation_request' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + phone_number: '+18001234567' + validation_code: '111111' description: Created security: - accountSid_authToken: [] operationId: CreateValidationRequest - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -18323,6 +24076,15 @@ paths: Can be: `GET` or `POST`, and the default is `POST`.' required: - PhoneNumber + examples: + create: + value: + CallDelay: 100 + Extension: extension + FriendlyName: friendly_name + PhoneNumber: '+18001234567' + StatusCallback: http://www.example.com + StatusCallbackMethod: GET x-twilio: mountName: validation_requests /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json: @@ -18336,10 +24098,12 @@ paths: - status - muted - hold - pathType: instance parent: /Accounts/{AccountSid}/Conferences/{Sid}.json + pathType: instance get: description: Fetch an instance of a participant + tags: + - Api20100401Participant parameters: - name: AccountSid in: path @@ -18375,14 +24139,47 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.participant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: connected + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + fetchByLabel: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: connected + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchParticipant - x-maturity: - - GA post: description: Update the properties of the participant + tags: + - Api20100401Participant parameters: - name: AccountSid in: path @@ -18418,12 +24215,107 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.participant' + examples: + muteParticipant: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + muteParticipantByLabel: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + holdParticipantWithMusic: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: true + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + announceToParticipant: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + modifyParticipant: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: complete + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + modifyParticipantByLabel: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: complete + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -18524,8 +24416,32 @@ paths: description: The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`. + examples: + muteParticipant: + value: + Muted: 'true' + muteParticipantByLabel: + value: + Muted: 'true' + holdParticipantWithMusic: + value: + Hold: 'true' + HoldUrl: http://www.myapp.com/hold + announceToParticipant: + value: + AnnounceUrl: http://www.myapp.com/announce + modifyParticipant: + value: + Coaching: true + CallSidToCoach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + modifyParticipantByLabel: + value: + Coaching: true + CallSidToCoach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb delete: description: Kick a participant from a given conference + tags: + - Api20100401Participant parameters: - name: AccountSid in: path @@ -18561,8 +24477,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteParticipant - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json: servers: - url: https://api.twilio.com @@ -18574,10 +24488,12 @@ paths: - status - muted - hold - pathType: list parent: /Accounts/{AccountSid}/Conferences/{Sid}.json + pathType: list post: description: '' + tags: + - Api20100401Participant parameters: - name: AccountSid in: path @@ -18601,12 +24517,187 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.participant' + examples: + createWithSid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyName: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithSidAsCoach: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithNonE164Number: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyNameJitterBufferSize: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyNameByoc: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyNameCallerId: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + label: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyNameReason: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyNameRecordingTrack: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFromToClient: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFromToSip: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -18891,9 +24982,8 @@ paths: fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if - you would like to leave a message on an answering machine. If - `send_digits` is provided, this parameter is ignored. For more - information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection).' + you would like to leave a message on an answering machine. For + more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection).' MachineDetectionTimeout: type: integer description: The number of seconds that we should attempt to detect @@ -18939,12 +25029,189 @@ paths: description: 'Whether to trim any leading and trailing silence from the participant recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`.' + CallToken: + type: string + description: A token string needed to invoke a forwarded call. A + call_token is generated when an incoming call is received on a + Twilio number. Pass an incoming call's call_token value to a forwarded + call via the call_token parameter when creating a new call. A + forwarded call should bear the same CallerID of the original incoming + call. required: - From - To + examples: + createWithSid: + value: + From: '+17736774757' + To: '+14157663747' + Label: customer + EarlyMedia: true + Beep: onEnter + Muted: false + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + Trim: do-not-trim + TimeLimit: 3600 + 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 get: description: Retrieve a list of participants belonging to the account used to make the request + tags: + - Api20100401Participant parameters: - name: AccountSid in: path @@ -18971,12 +25238,22 @@ paths: `true` or `false`.' schema: type: boolean + examples: + readFull: + value: 'true' + readNext: + value: 'true' + readPrevious: + value: 'true' - name: Hold in: query description: 'Whether to return only participants that are on hold. Can be: `true` or `false`.' schema: type: boolean + examples: + readEmpty: + value: true - name: Coaching in: query description: 'Whether to return only participants who are coaching another @@ -19007,41 +25284,209 @@ paths: content: application/json: schema: - type: object - title: ListParticipantResponse - properties: - participants: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.conference.participant' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListParticipantResponse + properties: + participants: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.conference.participant' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Participant") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Participant")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Participants")' + examples: + readEmpty: + value: + participants: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0 + next_page_uri: null + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0 + page: 0 + page_size: 50 + end: 0 + start: 0 + readFull: + value: + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Sat, 19 Feb 2011 21:07:19 +0000 + date_updated: Sat, 19 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Sat, 19 Feb 2011 21:07:19 +0000 + date_updated: Sat, 19 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0 + page: 0 + page_size: 2 + start: 0 + end: 1 + readNext: + value: + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAcccccccccccccccccccccccccccccccc + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 17 Feb 2011 21:07:19 +0000 + date_updated: Thu, 17 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAcccccccccccccccccccccccccccccccc.json + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAdddddddddddddddddddddddddddddddd + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 16 Feb 2011 21:07:19 +0000 + date_updated: Wed, 16 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAdddddddddddddddddddddddddddddddd.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=2&PageToken=PACPdddddddddddddddddddddddddddddddd + previous_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0&PageToken=PBCPcccccccccccccccccccccccccccccccc + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + page: 1 + page_size: 2 + start: 2 + end: 3 + readPrevious: + value: + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Sat, 19 Feb 2011 21:07:19 +0000 + date_updated: Sat, 19 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0&PageToken=PBCPcccccccccccccccccccccccccccccccc + page: 0 + page_size: 2 + start: 0 + end: 1 description: OK security: - accountSid_authToken: [] operationId: ListParticipant - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json: servers: - url: https://api.twilio.com @@ -19050,11 +25495,13 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: create an instance of payments. This will start a new payments session + tags: + - Api20100401Payment parameters: - name: AccountSid in: path @@ -19082,12 +25529,19 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.payments' + examples: + startPaymentSessionSuccess: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 + date_updated: Wed, 18 Dec 2019 20:02:01 +0000 + sid: PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreatePayments - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -19186,6 +25640,21 @@ paths: required: - IdempotencyKey - StatusCallback + examples: + startPaymentSessionSuccess: + value: + ChargeAmount: '12.00' + Currency: USD + Description: api testing + IdempotencyKey: abcd + Input: dtmf + Parameter: '{''name'':''foobar''}' + PaymentConnector: stripe_connector + PaymentMethod: credit-card + PostalCode: true + SecurityCode: true + StatusCallback: https://myapp.com/payments + ValidCardTypes: visa amex /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments/{Sid}.json: servers: - url: https://api.twilio.com @@ -19194,11 +25663,13 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance post: description: update an instance of payments with different phases of payment flows. + tags: + - Api20100401Payment parameters: - name: AccountSid in: path @@ -19235,12 +25706,35 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.payments' + examples: + collectCreditCardNumber: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 + date_updated: Wed, 18 Dec 2019 20:02:01 +0000 + sid: PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + collectCreditCardExpiryDate: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 + date_updated: Wed, 18 Dec 2019 20:02:01 +0000 + sid: PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + completePayment: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 + date_updated: Wed, 18 Dec 2019 20:02:01 +0000 + sid: PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Accepted security: - accountSid_authToken: [] operationId: UpdatePayments - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -19277,6 +25771,22 @@ paths: required: - IdempotencyKey - StatusCallback + examples: + collectCreditCardNumber: + value: + Capture: payment-card-number + IdempotencyKey: abcd + StatusCallback: https://myapp.com/payments + collectCreditCardExpiryDate: + value: + Capture: expiration-date + IdempotencyKey: abcd + StatusCallback: https://myapp.com/payments + completePayment: + value: + IdempotencyKey: abcd + Status: complete + StatusCallback: https://myapp.com/payments /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json: servers: - url: https://api.twilio.com @@ -19287,12 +25797,18 @@ paths: - friendly_name - current_size - average_wait_time - pathType: instance dependentProperties: - member: '{account_sid: account_sid, queue_sid: sid}' + members: + mapping: + account_sid: account_sid + queue_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Queues/{queue_sid}/Members.json parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a queue identified by the QueueSid + tags: + - Api20100401Queue parameters: - name: AccountSid in: path @@ -19320,14 +25836,28 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + average_wait_time: 0 + current_size: 0 + date_created: Tue, 04 Aug 2015 18:39:09 +0000 + date_updated: Tue, 04 Aug 2015 18:39:09 +0000 + friendly_name: '0.361280134646222' + max_size: 100 + sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + members: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json description: OK security: - accountSid_authToken: [] operationId: FetchQueue - x-maturity: - - GA post: description: Update the queue with the new parameters + tags: + - Api20100401Queue parameters: - name: AccountSid in: path @@ -19355,12 +25885,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + average_wait_time: 0 + current_size: 0 + date_created: Tue, 04 Aug 2015 18:39:09 +0000 + date_updated: Tue, 04 Aug 2015 18:39:09 +0000 + friendly_name: '0.361280134646222' + max_size: 100 + sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + members: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json description: OK security: - accountSid_authToken: [] operationId: UpdateQueue - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -19376,8 +25918,15 @@ paths: type: integer description: The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000. + examples: + update: + value: + FriendlyName: friendly_name + MaxSize: 1 delete: description: Remove an empty queue + tags: + - Api20100401Queue parameters: - name: AccountSid in: path @@ -19405,8 +25954,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteQueue - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Queues.json: servers: - url: https://api.twilio.com @@ -19417,13 +25964,19 @@ paths: - friendly_name - current_size - average_wait_time - pathType: list dependentProperties: - member: '{account_sid: account_sid, queue_sid: sid}' + members: + mapping: + account_sid: account_sid + queue_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Queues/{queue_sid}/Members.json parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of queues belonging to the account used to make the request + tags: + - Api20100401Queue parameters: - name: AccountSid in: path @@ -19459,43 +26012,118 @@ paths: content: application/json: schema: - type: object - title: ListQueueResponse - properties: - queues: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.queue' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListQueueResponse + properties: + queues: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.queue' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Queue") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Queue")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Queues")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0 + next_page_uri: null + page: 0 + page_size: 1 + previous_page_uri: null + queues: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + average_wait_time: 0 + current_size: 0 + date_created: Tue, 04 Aug 2015 18:39:09 +0000 + date_updated: Tue, 04 Aug 2015 18:39:09 +0000 + friendly_name: '0.361280134646222' + max_size: 100 + sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + members: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0 + next_page_uri: null + page: 0 + page_size: 1 + previous_page_uri: null + queues: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListQueue - x-maturity: - - GA post: description: Create a queue + tags: + - Api20100401Queue parameters: - name: AccountSid in: path @@ -19513,12 +26141,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + average_wait_time: 0 + current_size: 0 + date_created: Tue, 04 Aug 2015 18:39:09 +0000 + date_updated: Tue, 04 Aug 2015 18:39:09 +0000 + friendly_name: '0.361280134646222' + max_size: 100 + sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + members: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json description: Created security: - accountSid_authToken: [] operationId: CreateQueue - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -19536,6 +26176,11 @@ paths: The default is 1000. The maximum is 5000. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name + MaxSize: 1 /2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json: servers: - url: https://api.twilio.com @@ -19547,13 +26192,23 @@ paths: - status - start_time - duration - pathType: instance dependentProperties: - transcription: '{account_sid: account_sid, recording_sid: sid}' - add_on_result: '{account_sid: account_sid, reference_sid: sid}' + transcriptions: + mapping: + account_sid: account_sid + recording_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{recording_sid}/Transcriptions.json + add_on_results: + mapping: + account_sid: account_sid + reference_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults.json parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a recording + tags: + - Api20100401Recording parameters: - name: AccountSid in: path @@ -19582,20 +26237,76 @@ paths: period of 40 days. schema: type: boolean + examples: + fetchIncludeSoftDeleted: + value: 'true' responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '-0.00250' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: completed + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + add_on_results: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + media_url: http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchIncludeSoftDeleted: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Mon, 14 Feb 2022 22:23:00 +0100 + date_updated: Mon, 14 Feb 2022 22:23:00 +0100 + start_time: Mon, 14 Feb 2022 22:23:00 +0100 + price: '-0.00250' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: deleted + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + add_on_results: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + media_url: http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRecording - x-maturity: - - GA delete: description: Delete a recording from your account + tags: + - Api20100401Recording parameters: - name: AccountSid in: path @@ -19623,8 +26334,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRecording - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings.json: servers: - url: https://api.twilio.com @@ -19636,14 +26345,24 @@ paths: - status - start_time - duration - pathType: list dependentProperties: - transcription: '{account_sid: account_sid, recording_sid: sid}' - add_on_result: '{account_sid: account_sid, reference_sid: sid}' + transcriptions: + mapping: + account_sid: account_sid + recording_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{recording_sid}/Transcriptions.json + add_on_results: + mapping: + account_sid: account_sid + reference_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults.json parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of recordings belonging to the account used to make the request + tags: + - Api20100401Recording parameters: - name: AccountSid in: path @@ -19666,6 +26385,13 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' + readIncludeSoftDeleted: + value: '2008-01-02' - name: DateCreated< in: query description: 'Only include recordings that were created on this date. Specify @@ -19677,6 +26403,13 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-01' + readEmpty: + value: '2008-01-01' + readIncludeSoftDeleted: + value: '2008-01-01' - name: DateCreated> in: query description: 'Only include recordings that were created on this date. Specify @@ -19688,6 +26421,13 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-03' + readEmpty: + value: '2008-01-03' + readIncludeSoftDeleted: + value: '2008-01-03' - name: CallSid in: query description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) @@ -19713,6 +26453,9 @@ paths: period of 40 days. schema: type: boolean + examples: + readIncludeSoftDeleted: + value: 'True' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -19737,41 +26480,186 @@ paths: content: application/json: schema: - type: object - title: ListRecordingResponse - properties: - recordings: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.recording' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListRecordingResponse + properties: + recordings: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.recording' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Recording") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Recording")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recordings")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0 + next_page_uri: null + page: 0 + page_size: 1 + previous_page_uri: null + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '0.04' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: completed + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + add_on_results: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + media_url: http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0 + next_page_uri: null + page: 0 + page_size: 1 + previous_page_uri: null + recordings: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0 + readIncludeSoftDeleted: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0 + next_page_uri: null + page: 0 + page_size: 2 + previous_page_uri: null + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 2 + date_created: Mon, 14 Feb 2022 22:23:00 +0100 + date_updated: Mon, 14 Feb 2022 22:23:00 +0100 + start_time: Mon, 14 Feb 2022 22:23:00 +0100 + price: '0.04' + price_unit: USD + duration: '6' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: OutboundAPI + status: deleted + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + add_on_results: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + media_url: http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + channels: 2 + date_created: Mon, 14 Feb 2022 22:23:00 +0100 + date_updated: Mon, 14 Feb 2022 22:23:00 +0100 + start_time: Mon, 14 Feb 2022 22:23:00 +0000 + price: '0.04' + price_unit: USD + duration: '6' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + source: OutboundAPI + status: completed + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab.json + subresource_uris: + add_on_results: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/AddOnResults.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Transcriptions.json + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + media_url: http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListRecording - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json: servers: - url: https://api.twilio.com @@ -19782,13 +26670,19 @@ paths: - status - add_on_sid - date_created - pathType: instance dependentProperties: - payload: '{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: - sid}' + payloads: + mapping: + account_sid: account_sid + reference_sid: reference_sid + add_on_result_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads.json parent: /Accounts/{AccountSid}/Recordings/{Sid}.json + pathType: instance get: description: Fetch an instance of an AddOnResult + tags: + - Api20100401AddOnResult parameters: - name: AccountSid in: path @@ -19825,14 +26719,28 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result' + examples: + fetch: + value: + sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 01 Sep 2010 15:15:41 +0000 + date_updated: Wed, 01 Sep 2010 15:15:41 +0000 + date_completed: Wed, 01 Sep 2010 15:15:41 +0000 + subresource_uris: + payloads: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json description: OK security: - accountSid_authToken: [] operationId: FetchRecordingAddOnResult - x-maturity: - - GA delete: description: Delete a result and purge all associated Payloads + tags: + - Api20100401AddOnResult parameters: - name: AccountSid in: path @@ -19869,8 +26777,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRecordingAddOnResult - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json: servers: - url: https://api.twilio.com @@ -19881,13 +26787,19 @@ paths: - status - add_on_sid - date_created - pathType: list dependentProperties: - payload: '{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: - sid}' + payloads: + mapping: + account_sid: account_sid + reference_sid: reference_sid + add_on_result_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads.json parent: /Accounts/{AccountSid}/Recordings/{Sid}.json + pathType: list get: description: Retrieve a list of results belonging to the recording + tags: + - Api20100401AddOnResult parameters: - name: AccountSid in: path @@ -19932,41 +26844,114 @@ paths: content: application/json: schema: - type: object - title: ListRecordingAddOnResultResponse - properties: - add_on_results: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListRecordingAddOnResultResponse + properties: + add_on_results: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AddOnResult") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AddOnResult")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AddOnResults")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + add_on_results: + - sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 01 Sep 2010 15:15:41 +0000 + date_updated: Wed, 01 Sep 2010 15:15:41 +0000 + date_completed: Wed, 01 Sep 2010 15:15:41 +0000 + subresource_uris: + payloads: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + add_on_results: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListRecordingAddOnResult - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json: servers: - url: https://api.twilio.com @@ -19976,14 +26961,20 @@ paths: - sid - label - content_type - pathType: instance dependentProperties: - api/v2010/recording_add_on_result_payload_data: '{account_sid: account_sid, - reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: - sid}' + data: + mapping: + account_sid: account_sid + reference_sid: reference_sid + add_on_result_sid: add_on_result_sid + payload_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json parent: /Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json + pathType: instance get: description: Fetch an instance of a result payload + tags: + - Api20100401Payload parameters: - name: AccountSid in: path @@ -20030,14 +27021,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' + examples: + fetch: + value: + sid: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_result_sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + content_type: application/json + date_created: Wed, 01 Sep 2010 15:15:41 +0000 + date_updated: Wed, 01 Sep 2010 15:15:41 +0000 + subresource_uris: + data: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json description: OK security: - accountSid_authToken: [] operationId: FetchRecordingAddOnResultPayload - x-maturity: - - GA delete: description: Delete a payload from the result along with all associated Data + tags: + - Api20100401Payload parameters: - name: AccountSid in: path @@ -20084,8 +27090,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRecordingAddOnResultPayload - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json: servers: - url: https://api.twilio.com @@ -20095,14 +27099,20 @@ paths: - sid - label - content_type - pathType: list dependentProperties: - api/v2010/recording_add_on_result_payload_data: '{account_sid: account_sid, - reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: - sid}' + data: + mapping: + account_sid: account_sid + reference_sid: reference_sid + add_on_result_sid: add_on_result_sid + payload_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json parent: /Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json + pathType: list get: description: Retrieve a list of payloads belonging to the AddOnResult + tags: + - Api20100401Payload parameters: - name: AccountSid in: path @@ -20157,41 +27167,115 @@ paths: content: application/json: schema: - type: object - title: ListRecordingAddOnResultPayloadResponse - properties: - payloads: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListRecordingAddOnResultPayloadResponse + properties: + payloads: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Payload") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Payload")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Payloads")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + payloads: + - sid: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_result_sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + content_type: application/json + date_created: Wed, 01 Sep 2010 15:15:41 +0000 + date_updated: Wed, 01 Sep 2010 15:15:41 +0000 + subresource_uris: + data: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + payloads: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListRecordingAddOnResultPayload - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json: servers: - url: https://api.twilio.com @@ -20202,10 +27286,12 @@ paths: - type - status - duration - pathType: instance parent: /Accounts/{AccountSid}/Recordings/{Sid}.json + pathType: instance get: description: '' + tags: + - Api20100401Transcription parameters: - name: AccountSid in: path @@ -20243,14 +27329,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording.recording_transcription' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + date_created: Mon, 22 Aug 2011 20:58:44 +0000 + date_updated: Mon, 22 Aug 2011 20:58:44 +0000 + duration: '10' + price: '0.00000' + price_unit: USD + recording_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: in-progress + transcription_text: THIS IS A TEST + type: fast + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchRecordingTranscription - x-maturity: - - GA delete: description: '' + tags: + - Api20100401Transcription parameters: - name: AccountSid in: path @@ -20288,8 +27390,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRecordingTranscription - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions.json: servers: - url: https://api.twilio.com @@ -20300,10 +27400,12 @@ paths: - type - status - duration - pathType: list parent: /Accounts/{AccountSid}/Recordings/{Sid}.json + pathType: list get: description: '' + tags: + - Api20100401Transcription parameters: - name: AccountSid in: path @@ -20349,41 +27451,122 @@ paths: content: application/json: schema: - type: object - title: ListRecordingTranscriptionResponse - properties: - transcriptions: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.recording.recording_transcription' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListRecordingTranscriptionResponse + properties: + transcriptions: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.recording.recording_transcription' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Transcription") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Transcription")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Transcriptions")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + transcriptions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + date_created: Mon, 22 Aug 2011 20:58:44 +0000 + date_updated: Mon, 22 Aug 2011 20:58:44 +0000 + duration: '10' + price: '0.00000' + price_unit: USD + recording_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: in-progress + transcription_text: THIS IS A TEST + type: fast + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + transcriptions: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListRecordingTranscription - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json: servers: - url: https://api.twilio.com @@ -20393,10 +27576,12 @@ paths: - sid - short_code - friendly_name - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a short code + tags: + - Api20100401ShortCode parameters: - name: AccountSid in: path @@ -20424,14 +27609,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.short_code' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: null + date_updated: null + friendly_name: API_CLUSTER_TEST_SHORT_CODE + short_code: '99990' + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: POST + sms_fallback_url: null + sms_method: POST + sms_url: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchShortCode - x-maturity: - - GA post: description: Update a short code with the following parameters + tags: + - Api20100401ShortCode parameters: - name: AccountSid in: path @@ -20459,12 +27659,25 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.short_code' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: null + date_updated: null + friendly_name: API_CLUSTER_TEST_SHORT_CODE + short_code: '99990' + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: POST + sms_fallback_url: null + sms_method: POST + sms_url: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateShortCode - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -20515,6 +27728,15 @@ paths: - DELETE description: 'The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`.' + examples: + update: + value: + ApiVersion: api_version + FriendlyName: friendly_name + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com /2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes.json: servers: - url: https://api.twilio.com @@ -20524,11 +27746,13 @@ paths: - sid - short_code - friendly_name - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of short-codes belonging to the account used to make the request + tags: + - Api20100401ShortCode parameters: - name: AccountSid in: path @@ -20545,12 +27769,22 @@ paths: description: The string that identifies the ShortCode resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: ShortCode in: query description: Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit. schema: type: string + examples: + readFull: + value: short_code + readEmpty: + value: short_code - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -20575,53 +27809,135 @@ paths: content: application/json: schema: - type: object - title: ListShortCodeResponse - properties: - short_codes: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.short_code' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListShortCodeResponse + properties: + short_codes: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.short_code' + x-field-extra-annotation: '@JacksonXmlProperty(localName="ShortCode") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="ShortCode")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ShortCodes")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + short_codes: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: null + date_updated: null + friendly_name: API_CLUSTER_TEST_SHORT_CODE + short_code: '99990' + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: POST + sms_fallback_url: null + sms_method: POST + sms_url: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + short_codes: [] + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json description: OK security: - accountSid_authToken: [] operationId: ListShortCode - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SigningKeys/{Sid}.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: '' + tags: + - Api20100401SigningKey parameters: - name: AccountSid in: path @@ -20647,14 +27963,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.signing_key' + examples: + fetch: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 description: OK security: - accountSid_authToken: [] operationId: FetchSigningKey - x-maturity: - - GA post: description: '' + tags: + - Api20100401SigningKey parameters: - name: AccountSid in: path @@ -20680,12 +28003,17 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.signing_key' + examples: + update: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 description: OK security: - accountSid_authToken: [] operationId: UpdateSigningKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -20696,8 +28024,14 @@ paths: FriendlyName: type: string description: '' + examples: + update: + value: + FriendlyName: foo delete: description: '' + tags: + - Api20100401SigningKey parameters: - name: AccountSid in: path @@ -20723,34 +28057,32 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSigningKey - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Accounts/{Sid}.json + pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{Sid}.json className: auth_types + pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json className: auth_type_calls + pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json: servers: - url: https://api.twilio.com @@ -20759,11 +28091,13 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json className: auth_calls_credential_list_mapping + pathType: list post: description: Create a new credential list mapping resource + tags: + - Api20100401AuthCallsCredentialListMapping parameters: - name: AccountSid in: path @@ -20790,12 +28124,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSipAuthCallsCredentialListMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -20812,9 +28152,15 @@ paths: SIP domain. required: - CredentialListSid + examples: + create: + value: + CredentialListSid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of credential list mappings belonging to the domain used in the request + tags: + - Api20100401AuthCallsCredentialListMapping parameters: - name: AccountSid in: path @@ -20859,41 +28205,108 @@ paths: content: application/json: schema: - type: object - title: ListSipAuthCallsCredentialListMappingResponse - properties: - contents: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListSipAuthCallsCredentialListMappingResponse + properties: + contents: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AuthCallsCredentialListMapping") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AuthCallsCredentialListMapping")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Contents")' + examples: + readEmpty: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readFull: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListSipAuthCallsCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json: servers: - url: https://api.twilio.com @@ -20902,11 +28315,13 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json className: auth_calls_credential_list_mapping + pathType: instance get: description: Fetch a specific instance of a credential list mapping + tags: + - Api20100401AuthCallsCredentialListMapping parameters: - name: AccountSid in: path @@ -20943,14 +28358,22 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSipAuthCallsCredentialListMapping - x-maturity: - - GA delete: description: Delete a credential list mapping from the requested domain + tags: + - Api20100401AuthCallsCredentialListMapping parameters: - name: AccountSid in: path @@ -20987,8 +28410,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipAuthCallsCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings.json: servers: - url: https://api.twilio.com @@ -20997,11 +28418,13 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json className: auth_calls_ip_access_control_list_mapping + pathType: list post: description: Create a new IP Access Control List mapping + tags: + - Api20100401AuthCallsIpAccessControlListMapping parameters: - name: AccountSid in: path @@ -21028,12 +28451,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSipAuthCallsIpAccessControlListMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21050,9 +28479,15 @@ paths: to the SIP domain. required: - IpAccessControlListSid + examples: + create: + value: + IpAccessControlListSid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of IP Access Control List mappings belonging to the domain used in the request + tags: + - Api20100401AuthCallsIpAccessControlListMapping parameters: - name: AccountSid in: path @@ -21097,41 +28532,108 @@ paths: content: application/json: schema: - type: object - title: ListSipAuthCallsIpAccessControlListMappingResponse - properties: - contents: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListSipAuthCallsIpAccessControlListMappingResponse + properties: + contents: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AuthCallsIpAccessControlListMapping") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AuthCallsIpAccessControlListMapping")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Contents")' + examples: + readEmpty: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readFull: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListSipAuthCallsIpAccessControlListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings/{Sid}.json: servers: - url: https://api.twilio.com @@ -21140,11 +28642,13 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json className: auth_calls_ip_access_control_list_mapping + pathType: instance get: description: Fetch a specific instance of an IP Access Control List mapping + tags: + - Api20100401AuthCallsIpAccessControlListMapping parameters: - name: AccountSid in: path @@ -21181,14 +28685,22 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSipAuthCallsIpAccessControlListMapping - x-maturity: - - GA delete: description: Delete an IP Access Control List mapping from the requested domain + tags: + - Api20100401AuthCallsIpAccessControlListMapping parameters: - name: AccountSid in: path @@ -21225,17 +28737,15 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipAuthCallsIpAccessControlListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json className: auth_type_registrations + pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings.json: servers: - url: https://api.twilio.com @@ -21244,11 +28754,13 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations.json className: auth_registrations_credential_list_mapping + pathType: list post: description: Create a new credential list mapping resource + tags: + - Api20100401AuthRegistrationsCredentialListMapping parameters: - name: AccountSid in: path @@ -21275,12 +28787,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSipAuthRegistrationsCredentialListMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21297,9 +28815,15 @@ paths: SIP domain. required: - CredentialListSid + examples: + create: + value: + CredentialListSid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of credential list mappings belonging to the domain used in the request + tags: + - Api20100401AuthRegistrationsCredentialListMapping parameters: - name: AccountSid in: path @@ -21344,41 +28868,108 @@ paths: content: application/json: schema: - type: object - title: ListSipAuthRegistrationsCredentialListMappingResponse - properties: - contents: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListSipAuthRegistrationsCredentialListMappingResponse + properties: + contents: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AuthRegistrationsCredentialListMapping") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AuthRegistrationsCredentialListMapping")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Contents")' + examples: + readEmpty: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readFull: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListSipAuthRegistrationsCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings/{Sid}.json: servers: - url: https://api.twilio.com @@ -21387,11 +28978,13 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations.json className: auth_registrations_credential_list_mapping + pathType: instance get: description: Fetch a specific instance of a credential list mapping + tags: + - Api20100401AuthRegistrationsCredentialListMapping parameters: - name: AccountSid in: path @@ -21428,14 +29021,22 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSipAuthRegistrationsCredentialListMapping - x-maturity: - - GA delete: description: Delete a credential list mapping from the requested domain + tags: + - Api20100401AuthRegistrationsCredentialListMapping parameters: - name: AccountSid in: path @@ -21472,8 +29073,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipAuthRegistrationsCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json: servers: - url: https://api.twilio.com @@ -21483,10 +29082,12 @@ paths: - sid - username - credential_list_sid - pathType: list parent: /Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json + pathType: list get: description: Retrieve a list of credentials. + tags: + - Api20100401Credential parameters: - name: AccountSid in: path @@ -21531,43 +29132,114 @@ paths: content: application/json: schema: - type: object - title: ListSipCredentialResponse - properties: - credentials: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListSipCredentialResponse + properties: + credentials: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Credential") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Credential")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Credentials")' + examples: + readFull: + value: + credentials: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + credential_list_sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 19 Aug 2015 19:48:45 +0000 + date_updated: Wed, 19 Aug 2015 19:48:45 +0000 + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + username: '1440013725.28' + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0 + readEmpty: + value: + credentials: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipCredential - x-maturity: - - GA post: description: Create a new credential resource. + tags: + - Api20100401Credential parameters: - name: AccountSid in: path @@ -21594,12 +29266,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + credential_list_sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 19 Aug 2015 19:48:45 +0000 + date_updated: Wed, 19 Aug 2015 19:48:45 +0000 + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + username: '1440013725.28' description: Created security: - accountSid_authToken: [] operationId: CreateSipCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21621,6 +29301,11 @@ paths: required: - Username - Password + examples: + create: + value: + Password: password + Username: username /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json: servers: - url: https://api.twilio.com @@ -21630,10 +29315,12 @@ paths: - sid - username - credential_list_sid - pathType: instance parent: /Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json + pathType: instance get: description: Fetch a single credential. + tags: + - Api20100401Credential parameters: - name: AccountSid in: path @@ -21669,14 +29356,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + credential_list_sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 19 Aug 2015 19:48:45 +0000 + date_updated: Wed, 19 Aug 2015 19:48:45 +0000 + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + username: '1440013725.28' description: OK security: - accountSid_authToken: [] operationId: FetchSipCredential - x-maturity: - - GA post: description: Update a credential resource. + tags: + - Api20100401Credential parameters: - name: AccountSid in: path @@ -21712,12 +29409,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + credential_list_sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 19 Aug 2015 19:48:45 +0000 + date_updated: Wed, 19 Aug 2015 19:48:45 +0000 + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + username: username description: OK security: - accountSid_authToken: [] operationId: UpdateSipCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21730,8 +29435,14 @@ paths: description: The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`) + examples: + update: + value: + Password: password delete: description: Delete a credential resource. + tags: + - Api20100401Credential parameters: - name: AccountSid in: path @@ -21767,8 +29478,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipCredential - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json: servers: - url: https://api.twilio.com @@ -21777,12 +29486,18 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list dependentProperties: - credential: '{account_sid: account_sid, credential_list_sid: sid}' + credentials: + mapping: + account_sid: account_sid + credential_list_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP/CredentialLists/{credential_list_sid}/Credentials.json parent: /Accounts/{AccountSid}/SIP.json + pathType: list get: description: Get All Credential Lists + tags: + - Api20100401CredentialList parameters: - name: AccountSid in: path @@ -21817,43 +29532,115 @@ paths: content: application/json: schema: - type: object - title: ListSipCredentialListResponse - properties: - credential_lists: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListSipCredentialListResponse + properties: + credential_lists: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' + x-field-extra-annotation: '@JacksonXmlProperty(localName="CredentialList") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="CredentialList")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "CredentialLists")' + examples: + readFull: + value: + credential_lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Low Rises + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credentials: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0 + next_page_uri: null + start: 0 + end: 0 + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0 + readEmpty: + value: + credential_lists: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0 + next_page_uri: null + start: 0 + end: 0 + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipCredentialList - x-maturity: - - GA post: description: Create a Credential List + tags: + - Api20100401CredentialList parameters: - name: AccountSid in: path @@ -21870,12 +29657,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Low Rises + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credentials: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSipCredentialList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21889,6 +29685,10 @@ paths: CredentialList, up to 64 characters long. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json: servers: - url: https://api.twilio.com @@ -21897,12 +29697,18 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance dependentProperties: - credential: '{account_sid: account_sid, credential_list_sid: sid}' + credentials: + mapping: + account_sid: account_sid + credential_list_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP/CredentialLists/{credential_list_sid}/Credentials.json parent: /Accounts/{AccountSid}/SIP.json + pathType: instance get: description: Get a Credential List + tags: + - Api20100401CredentialList parameters: - name: AccountSid in: path @@ -21928,14 +29734,25 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Low Rises + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credentials: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchSipCredentialList - x-maturity: - - GA post: description: Update a Credential List + tags: + - Api20100401CredentialList parameters: - name: AccountSid in: path @@ -21961,12 +29778,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Low Rises + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credentials: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateSipCredentialList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21980,8 +29806,14 @@ paths: up to 64 characters long. required: - FriendlyName + examples: + update: + value: + FriendlyName: friendly_name delete: description: Delete a Credential List + tags: + - Api20100401CredentialList parameters: - name: AccountSid in: path @@ -22007,8 +29839,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipCredentialList - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings.json: servers: - url: https://api.twilio.com @@ -22017,10 +29847,12 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{Sid}.json + pathType: list post: description: Create a CredentialListMapping resource for an account. + tags: + - Api20100401CredentialListMapping parameters: - name: AccountSid in: path @@ -22048,12 +29880,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Production Gateways IP Address - Scranton + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSipCredentialListMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -22070,8 +29910,14 @@ paths: CredentialList resource to map to the SIP domain. required: - CredentialListSid + examples: + create: + value: + CredentialListSid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Read multiple CredentialListMapping resources from an account. + tags: + - Api20100401CredentialListMapping parameters: - name: AccountSid in: path @@ -22117,41 +29963,110 @@ paths: content: application/json: schema: - type: object - title: ListSipCredentialListMappingResponse - properties: - credential_list_mappings: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListSipCredentialListMappingResponse + properties: + credential_list_mappings: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' + x-field-extra-annotation: '@JacksonXmlProperty(localName="CredentialListMapping") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="CredentialListMapping")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "CredentialListMappings")' + examples: + readFull: + value: + credential_list_mappings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Production Gateways IP Address - Scranton + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0 + next_page_uri: null + start: 0 + end: 0 + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0 + readEmpty: + value: + credential_list_mappings: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0 + next_page_uri: null + start: 0 + end: 0 + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings/{Sid}.json: servers: - url: https://api.twilio.com @@ -22160,10 +30075,12 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/Domains/{Sid}.json + pathType: instance get: description: Fetch a single CredentialListMapping resource from an account. + tags: + - Api20100401CredentialListMapping parameters: - name: AccountSid in: path @@ -22201,14 +30118,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Production Gateways IP Address - Scranton + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchSipCredentialListMapping - x-maturity: - - GA delete: description: Delete a CredentialListMapping resource from an account. + tags: + - Api20100401CredentialListMapping parameters: - name: AccountSid in: path @@ -22246,8 +30173,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains.json: servers: - url: https://api.twilio.com @@ -22257,15 +30182,29 @@ paths: - sid - domain_name - friendly_name - pathType: list dependentProperties: - ip_access_control_list_mapping: '{account_sid: account_sid, domain_sid: sid}' - credential_list_mapping: '{account_sid: account_sid, domain_sid: sid}' - auth_types: '{account_sid: account_sid, domain_sid: sid}' + ip_access_control_list_mappings: + mapping: + account_sid: account_sid + domain_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/IpAccessControlListMappings.json + credential_list_mappings: + mapping: + account_sid: account_sid + domain_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/CredentialListMappings.json + auth: + mapping: + account_sid: account_sid + domain_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/Auth.json parent: /Accounts/{AccountSid}/SIP.json + pathType: list get: description: Retrieve a list of domains belonging to the account used to make the request + tags: + - Api20100401Domain parameters: - name: AccountSid in: path @@ -22301,43 +30240,130 @@ paths: content: application/json: schema: - type: object - title: ListSipDomainResponse - properties: - domains: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListSipDomainResponse + properties: + domains: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Domain") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Domain")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Domains")' + examples: + readFull: + value: + domains: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + auth_type: IP_ACL + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + domain_name: dunder-mifflin-scranton.sip.twilio.com + friendly_name: Scranton Office + sip_registration: true + sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credential_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json + ip_access_control_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_status_callback_method: POST + voice_status_callback_url: null + voice_url: https://dundermifflin.example.com/twilio/app.php + emergency_calling_enabled: true + secure: true + byoc_trunk_sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_caller_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start: 0 + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0 + readEmpty: + value: + domains: [] + start: 0 + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipDomain - x-maturity: - - GA post: description: Create a new Domain + tags: + - Api20100401Domain parameters: - name: AccountSid in: path @@ -22355,12 +30381,36 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + auth_type: IP_ACL + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + domain_name: dunder-mifflin-scranton.sip.twilio.com + friendly_name: Scranton Office + sip_registration: true + sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credential_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json + ip_access_control_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_status_callback_method: POST + voice_status_callback_url: null + voice_url: https://dundermifflin.example.com/twilio/app.php + emergency_calling_enabled: true + secure: true + byoc_trunk_sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_caller_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSipDomain - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -22460,6 +30510,22 @@ paths: for the emergency call. required: - DomainName + examples: + create: + value: + DomainName: dunder-mifflin-scranton.sip.twilio.com + FriendlyName: Scranton Office + VoiceFallbackMethod: POST + VoiceFallbackUrl: '' + VoiceMethod: POST + VoiceStatusCallbackMethod: POST + VoiceStatusCallbackUrl: '' + VoiceUrl: https://dundermifflin.example.com/twilio/app.php + SipRegistration: true + EmergencyCallingEnabled: true + Secure: true + ByocTrunkSid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + EmergencyCallerSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json: servers: - url: https://api.twilio.com @@ -22469,14 +30535,28 @@ paths: - sid - domain_name - friendly_name - pathType: instance dependentProperties: - ip_access_control_list_mapping: '{account_sid: account_sid, domain_sid: sid}' - credential_list_mapping: '{account_sid: account_sid, domain_sid: sid}' - auth_types: '{account_sid: account_sid, domain_sid: sid}' + ip_access_control_list_mappings: + mapping: + account_sid: account_sid + domain_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/IpAccessControlListMappings.json + credential_list_mappings: + mapping: + account_sid: account_sid + domain_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/CredentialListMappings.json + auth: + mapping: + account_sid: account_sid + domain_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/Auth.json parent: /Accounts/{AccountSid}/SIP.json + pathType: instance get: description: Fetch an instance of a Domain + tags: + - Api20100401Domain parameters: - name: AccountSid in: path @@ -22504,14 +30584,40 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + auth_type: IP_ACL + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + domain_name: dunder-mifflin-scranton.sip.twilio.com + friendly_name: Scranton Office + sip_registration: true + sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credential_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json + ip_access_control_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_status_callback_method: POST + voice_status_callback_url: null + voice_url: https://dundermifflin.example.com/twilio/app.php + emergency_calling_enabled: true + secure: true + byoc_trunk_sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_caller_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSipDomain - x-maturity: - - GA post: description: Update the attributes of a domain + tags: + - Api20100401Domain parameters: - name: AccountSid in: path @@ -22539,12 +30645,36 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + auth_type: IP_ACL + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + domain_name: dunder-mifflin-scranton.sip.twilio.com + friendly_name: Scranton Office + sip_registration: true + sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credential_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json + ip_access_control_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_status_callback_method: POST + voice_status_callback_url: null + voice_url: https://dundermifflin.example.com/twilio/app.php + emergency_calling_enabled: true + secure: true + byoc_trunk_sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_caller_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSipDomain - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -22641,8 +30771,26 @@ paths: description: Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call. + examples: + update: + value: + DomainName: dunder-mifflin-scranton.sip.twilio.com + FriendlyName: Scranton Office + VoiceFallbackMethod: POST + VoiceFallbackUrl: '' + VoiceMethod: POST + VoiceStatusCallbackMethod: POST + VoiceStatusCallbackUrl: '' + VoiceUrl: https://dundermifflin.example.com/twilio/app.php + SipRegistration: true + EmergencyCallingEnabled: true + Secure: true + ByocTrunkSid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + EmergencyCallerSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: Delete an instance of a Domain + tags: + - Api20100401Domain parameters: - name: AccountSid in: path @@ -22670,8 +30818,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipDomain - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists.json: servers: - url: https://api.twilio.com @@ -22680,13 +30826,19 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list dependentProperties: - ip_address: '{account_sid: account_sid, ip_access_control_list_sid: sid}' + ip_addresses: + mapping: + account_sid: account_sid + ip_access_control_list_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP/IpAccessControlLists/{ip_access_control_list_sid}/IpAddresses.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 + tags: + - Api20100401IpAccessControlList parameters: - name: AccountSid in: path @@ -22722,43 +30874,115 @@ paths: content: application/json: schema: - type: object - title: ListSipIpAccessControlListResponse - properties: - ip_access_control_lists: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListSipIpAccessControlListResponse + properties: + ip_access_control_lists: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' + x-field-extra-annotation: '@JacksonXmlProperty(localName="IpAccessControlList") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="IpAccessControlList")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAccessControlLists")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0 + ip_access_control_lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + ip_addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0 + ip_access_control_lists: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipIpAccessControlList - x-maturity: - - GA post: description: Create a new IpAccessControlList resource + tags: + - Api20100401IpAccessControlList parameters: - name: AccountSid in: path @@ -22776,12 +31000,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + ip_addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSipIpAccessControlList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -22795,6 +31028,10 @@ paths: IpAccessControlList, up to 255 characters long. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json: servers: - url: https://api.twilio.com @@ -22803,12 +31040,18 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance dependentProperties: - ip_address: '{account_sid: account_sid, ip_access_control_list_sid: sid}' + ip_addresses: + mapping: + account_sid: account_sid + ip_access_control_list_sid: sid + resource_url: /2010-04-01/Accounts/{account_sid}/SIP/IpAccessControlLists/{ip_access_control_list_sid}/IpAddresses.json parent: /Accounts/{AccountSid}/SIP.json + pathType: instance get: description: Fetch a specific instance of an IpAccessControlList + tags: + - Api20100401IpAccessControlList parameters: - name: AccountSid in: path @@ -22836,14 +31079,25 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + ip_addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchSipIpAccessControlList - x-maturity: - - GA post: description: Rename an IpAccessControlList + tags: + - Api20100401IpAccessControlList parameters: - name: AccountSid in: path @@ -22871,12 +31125,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + ip_addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateSipIpAccessControlList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -22890,8 +31153,14 @@ paths: long. required: - FriendlyName + examples: + update: + value: + FriendlyName: friendly_name delete: description: Delete an IpAccessControlList from the requested account + tags: + - Api20100401IpAccessControlList parameters: - name: AccountSid in: path @@ -22919,8 +31188,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipIpAccessControlList - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings/{Sid}.json: servers: - url: https://api.twilio.com @@ -22929,10 +31196,12 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/Domains/{Sid}.json + pathType: instance get: description: Fetch an IpAccessControlListMapping resource. + tags: + - Api20100401IpAccessControlListMapping parameters: - name: AccountSid in: path @@ -22968,14 +31237,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchSipIpAccessControlListMapping - x-maturity: - - GA delete: description: Delete an IpAccessControlListMapping resource. + tags: + - Api20100401IpAccessControlListMapping parameters: - name: AccountSid in: path @@ -23011,8 +31290,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipIpAccessControlListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings.json: servers: - url: https://api.twilio.com @@ -23021,10 +31298,12 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{Sid}.json + pathType: list post: description: Create a new IpAccessControlListMapping resource. + tags: + - Api20100401IpAccessControlListMapping parameters: - name: AccountSid in: path @@ -23050,12 +31329,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSipIpAccessControlListMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -23072,8 +31359,14 @@ paths: to the SIP domain. required: - IpAccessControlListSid + examples: + create: + value: + IpAccessControlListSid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of IpAccessControlListMapping resources. + tags: + - Api20100401IpAccessControlListMapping parameters: - name: AccountSid in: path @@ -23117,41 +31410,110 @@ paths: content: application/json: schema: - type: object - title: ListSipIpAccessControlListMappingResponse - properties: - ip_access_control_list_mappings: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListSipIpAccessControlListMappingResponse + properties: + ip_access_control_list_mappings: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' + x-field-extra-annotation: '@JacksonXmlProperty(localName="IpAccessControlListMapping") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="IpAccessControlListMapping")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAccessControlListMappings")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0 + ip_access_control_list_mappings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0 + ip_access_control_list_mappings: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipIpAccessControlListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json: servers: - url: https://api.twilio.com @@ -23161,10 +31523,12 @@ paths: - sid - ip_address - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json + pathType: list get: description: Read multiple IpAddress resources. + tags: + - Api20100401IpAddress parameters: - name: AccountSid in: path @@ -23210,43 +31574,116 @@ paths: content: application/json: schema: - type: object - title: ListSipIpAddressResponse - properties: - ip_addresses: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListSipIpAddressResponse + properties: + ip_addresses: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' + x-field-extra-annotation: '@JacksonXmlProperty(localName="IpAddress") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="IpAddress")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAddresses")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0 + ip_addresses: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + friendly_name: friendly_name + ip_access_control_list_sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.1 + cidr_prefix_length: 32 + sid: IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0 + ip_addresses: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipIpAddress - x-maturity: - - GA post: description: Create a new IpAddress resource. + tags: + - Api20100401IpAddress parameters: - name: AccountSid in: path @@ -23274,12 +31711,22 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + friendly_name: friendly_name + ip_access_control_list_sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.1 + cidr_prefix_length: 32 + sid: IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSipIpAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -23304,6 +31751,12 @@ paths: required: - FriendlyName - IpAddress + examples: + create: + value: + FriendlyName: friendly_name + IpAddress: 192.168.1.1 + CidrPrefixLength: 32 /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json: servers: - url: https://api.twilio.com @@ -23313,10 +31766,12 @@ paths: - sid - ip_address - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json + pathType: instance get: description: Read one IpAddress resource. + tags: + - Api20100401IpAddress parameters: - name: AccountSid in: path @@ -23354,14 +31809,26 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + friendly_name: friendly_name + ip_access_control_list_sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.1 + cidr_prefix_length: 32 + sid: IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchSipIpAddress - x-maturity: - - GA post: description: Update an IpAddress resource. + tags: + - Api20100401IpAddress parameters: - name: AccountSid in: path @@ -23399,12 +31866,22 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + friendly_name: friendly_name + ip_access_control_list_sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.1 + cidr_prefix_length: 32 + sid: IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateSipIpAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -23426,8 +31903,16 @@ paths: description: An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used. + examples: + update: + value: + FriendlyName: friendly_name + IpAddress: 192.168.1.1 + CidrPrefixLength: 32 delete: description: Delete an IpAddress resource. + tags: + - Api20100401IpAddress parameters: - name: AccountSid in: path @@ -23465,8 +31950,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipIpAddress - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec.json: servers: - url: https://api.twilio.com @@ -23475,10 +31958,12 @@ paths: defaultOutputProperties: - call_sid - name - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: Create a Siprec + tags: + - Api20100401Siprec parameters: - name: AccountSid in: path @@ -23506,12 +31991,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.siprec' + examples: + createNoArgs: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: null + status: in-progress + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithArgs: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: myName + status: in-progress + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSiprec - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -24142,6 +32644,22 @@ paths: Parameter99.Value: type: string description: Parameter value + examples: + createNoArgs: + value: {} + createWithArgs: + value: + Name: myName + ConnectorName: myConnectorName + Track: inbound_track + StatusCallback: http://statuscallback.com + StatusCallbackMethod: PUT + Parameter1.Name: name1 + Parameter1.Value: value1 + Parameter2.Name: name2 + Parameter2.Value: value2 + Parameter3.Name: name3 + Parameter3.Value: value3 /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec/{Sid}.json: servers: - url: https://api.twilio.com @@ -24150,11 +32668,13 @@ paths: defaultOutputProperties: - call_sid - name - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance post: description: Stop a Siprec using either the SID of the Siprec resource or the `name` used when creating the resource + tags: + - Api20100401Siprec parameters: - name: AccountSid in: path @@ -24189,12 +32709,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.siprec' + examples: + updateBySid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: null + status: stopped + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + updateByName: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: mySiprec + status: stopped + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateSiprec - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -24208,6 +32745,13 @@ paths: description: The status. Must have the value `stopped` required: - Status + examples: + updateBySid: + value: + Status: stopped + updateByName: + value: + Status: stopped /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams.json: servers: - url: https://api.twilio.com @@ -24217,10 +32761,12 @@ paths: defaultOutputProperties: - call_sid - name - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: Create a Stream + tags: + - Api20100401Stream parameters: - name: AccountSid in: path @@ -24248,12 +32794,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.stream' + examples: + createNoArgs: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: null + status: in-progress + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithArgs: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: myName + status: in-progress + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateStream - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -24887,6 +33450,23 @@ paths: description: Parameter value required: - Url + examples: + createNoArgs: + value: + Url: myUrl + createWithArgs: + value: + Name: myName + Url: myUrl + Track: inbound_track + StatusCallback: http://statuscallback.com + StatusCallbackMethod: PUT + Parameter1.Name: name1 + Parameter1.Value: value1 + Parameter2.Name: name2 + Parameter2.Value: value2 + Parameter3.Name: name3 + Parameter3.Value: value3 /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams/{Sid}.json: servers: - url: https://api.twilio.com @@ -24896,11 +33476,13 @@ paths: defaultOutputProperties: - call_sid - name - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance post: description: Stop a Stream using either the SID of the Stream resource or the `name` used when creating the resource + tags: + - Api20100401Stream parameters: - name: AccountSid in: path @@ -24935,12 +33517,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.stream' + examples: + updateBySid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: null + status: stopped + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + updateByName: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: myStream + status: stopped + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateStream - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -24954,6 +33553,13 @@ paths: description: The status. Must have the value `stopped` required: - Status + examples: + updateBySid: + value: + Status: stopped + updateByName: + value: + Status: stopped /2010-04-01/Accounts/{AccountSid}/Tokens.json: servers: - url: https://api.twilio.com @@ -24962,10 +33568,12 @@ paths: defaultOutputProperties: - username - ice_servers - pathType: list parent: /Accounts/{Sid}.json + pathType: list post: description: Create a new token for ICE servers + tags: + - Api20100401Token parameters: - name: AccountSid in: path @@ -24983,12 +33591,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.token' + examples: + create: + value: + username: dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269 + ice_servers: + - urls: stun:global.stun.twilio.com:3478 + - username: dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269 + credential: tE2DajzSJwnsSbc123 + urls: turn:global.turn.twilio.com:3478?transport=udp + - username: dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269 + credential: tE2DajzSJwnsSbc123 + urls: turn:global.turn.twilio.com:3478?transport=tcp + - username: dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269 + credential: tE2DajzSJwnsSbc123 + urls: turn:global.turn.twilio.com:443?transport=tcp + date_updated: Fri, 01 May 2020 01:42:57 +0000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ttl: '86400' + date_created: Fri, 01 May 2020 01:42:57 +0000 + password: tE2DajzSJwnsSbc123 description: Created security: - accountSid_authToken: [] operationId: CreateToken - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -25000,6 +33626,10 @@ paths: type: integer description: The duration in seconds for which the generated credentials are valid. The default value is 86400 (24 hours). + examples: + create: + value: + Ttl: 1 /2010-04-01/Accounts/{AccountSid}/Transcriptions/{Sid}.json: servers: - url: https://api.twilio.com @@ -25010,10 +33640,12 @@ paths: - type - status - duration - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a Transcription + tags: + - Api20100401Transcription parameters: - name: AccountSid in: path @@ -25041,14 +33673,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.transcription' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + date_created: Sun, 13 Feb 2011 02:12:08 +0000 + date_updated: Sun, 13 Feb 2011 02:30:01 +0000 + duration: '1' + price: '-0.05000' + price_unit: USD + recording_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + transcription_text: (blank) + type: fast + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchTranscription - x-maturity: - - GA delete: description: Delete a transcription from the account used to make the request + tags: + - Api20100401Transcription parameters: - name: AccountSid in: path @@ -25076,8 +33724,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTranscription - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Transcriptions.json: servers: - url: https://api.twilio.com @@ -25088,11 +33734,13 @@ paths: - type - status - duration - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of transcriptions belonging to the account used to make the request + tags: + - Api20100401Transcription parameters: - name: AccountSid in: path @@ -25128,49 +33776,130 @@ paths: content: application/json: schema: - type: object - title: ListTranscriptionResponse - properties: - transcriptions: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.transcription' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListTranscriptionResponse + properties: + transcriptions: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.transcription' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Transcription") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Transcription")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Transcriptions")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=3 + next_page_uri: null + num_pages: 4 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 4 + transcriptions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + date_created: Thu, 25 Aug 2011 20:59:45 +0000 + date_updated: Thu, 25 Aug 2011 20:59:45 +0000 + duration: '10' + price: '0.00000' + price_unit: USD + recording_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + transcription_text: null + type: fast + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=3 + next_page_uri: null + num_pages: 4 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 4 + transcriptions: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListTranscription - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Accounts/{Sid}.json + pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Records.json: servers: - url: https://api.twilio.com @@ -25182,11 +33911,13 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage.json + pathType: list get: description: Retrieve a list of usage-records belonging to the account used to make the request + tags: + - Api20100401Record parameters: - name: AccountSid in: path @@ -25206,6 +33937,11 @@ paths: schema: type: string $ref: '#/components/schemas/usage_record_enum_category' + examples: + readFull: + value: calleridlookups + readEmpty: + value: calleridlookups - name: StartDate in: query description: 'Only include usage that has occurred on or after this date. @@ -25215,6 +33951,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: EndDate in: query description: 'Only include usage that occurred on or before this date. Specify @@ -25224,6 +33965,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: IncludeSubaccounts in: query description: 'Whether to include usage from the master account and all its @@ -25256,41 +34002,132 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListUsageRecordResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Record") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Record")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: totalprice + count: null + count_unit: '' + description: Total Price + end_date: '2015-09-04' + price: '2192.84855' + price_unit: usd + start_date: '2011-08-23' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=totalprice + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=totalprice + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=totalprice + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=totalprice + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=totalprice + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=totalprice + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=totalprice + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=totalprice + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice&StartDate=2011-08-23&EndDate=2015-09-04 + usage: '2192.84855' + usage_unit: usd + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecord - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/AllTime.json: servers: - url: https://api.twilio.com @@ -25302,10 +34139,12 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' + tags: + - Api20100401AllTime parameters: - name: AccountSid in: path @@ -25375,41 +34214,132 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordAllTimeResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListUsageRecordAllTimeResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AllTime") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AllTime")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-04' + price: '0' + price_unit: usd + start_date: '2011-08-23' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Category=sms-inbound-shortcode&StartDate=2011-08-23&EndDate=2015-09-04 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordAllTime - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/Daily.json: servers: - url: https://api.twilio.com @@ -25421,10 +34351,12 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' + tags: + - Api20100401Daily parameters: - name: AccountSid in: path @@ -25494,41 +34426,132 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordDailyResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListUsageRecordDailyResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Daily") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Daily")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=101843&PageSize=1 + next_page_uri: null + num_pages: 101844 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 101844 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-06' + price: '0' + price_unit: usd + start_date: '2015-09-06' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Category=sms-inbound-shortcode&StartDate=2015-09-06&EndDate=2015-09-06 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=101843&PageSize=1 + next_page_uri: null + num_pages: 101844 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 101844 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordDaily - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/LastMonth.json: servers: - url: https://api.twilio.com @@ -25540,10 +34563,12 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' + tags: + - Api20100401LastMonth parameters: - name: AccountSid in: path @@ -25613,41 +34638,132 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordLastMonthResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListUsageRecordLastMonthResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month' + x-field-extra-annotation: '@JacksonXmlProperty(localName="LastMonth") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="LastMonth")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-08-31' + price: '0' + price_unit: usd + start_date: '2015-08-01' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Category=sms-inbound-shortcode&StartDate=2015-08-01&EndDate=2015-08-31 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordLastMonth - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json: servers: - url: https://api.twilio.com @@ -25659,10 +34775,12 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' + tags: + - Api20100401Monthly parameters: - name: AccountSid in: path @@ -25732,41 +34850,132 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordMonthlyResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListUsageRecordMonthlyResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Monthly") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Monthly")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=3449&PageSize=1 + next_page_uri: null + num_pages: 3450 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 3450 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-04' + price: '0' + price_unit: usd + start_date: '2015-09-01' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Category=sms-inbound-shortcode&StartDate=2015-09-01&EndDate=2015-09-04 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=3449&PageSize=1 + next_page_uri: null + num_pages: 3450 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 3450 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordMonthly - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/ThisMonth.json: servers: - url: https://api.twilio.com @@ -25778,10 +34987,12 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' + tags: + - Api20100401ThisMonth parameters: - name: AccountSid in: path @@ -25851,41 +35062,132 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordThisMonthResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListUsageRecordThisMonthResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month' + x-field-extra-annotation: '@JacksonXmlProperty(localName="ThisMonth") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="ThisMonth")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-04' + price: '0' + price_unit: usd + start_date: '2015-09-01' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Category=sms-inbound-shortcode&StartDate=2015-09-01&EndDate=2015-09-04 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordThisMonth - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/Today.json: servers: - url: https://api.twilio.com @@ -25897,10 +35199,12 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' + tags: + - Api20100401Today parameters: - name: AccountSid in: path @@ -25970,41 +35274,132 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordTodayResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListUsageRecordTodayResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Today") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Today")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-04' + price: '0' + price_unit: usd + start_date: '2015-09-04' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Category=sms-inbound-shortcode&StartDate=2015-09-04&EndDate=2015-09-04 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordToday - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/Yearly.json: servers: - url: https://api.twilio.com @@ -26016,10 +35411,12 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' + tags: + - Api20100401Yearly parameters: - name: AccountSid in: path @@ -26089,41 +35486,132 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordYearlyResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListUsageRecordYearlyResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Yearly") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Yearly")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=344&PageSize=1 + next_page_uri: null + num_pages: 345 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 345 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-04' + price: '0' + price_unit: usd + start_date: '2015-01-01' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Category=sms-inbound-shortcode&StartDate=2015-01-01&EndDate=2015-09-04 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=344&PageSize=1 + next_page_uri: null + num_pages: 345 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 345 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordYearly - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/Yesterday.json: servers: - url: https://api.twilio.com @@ -26135,10 +35623,12 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' + tags: + - Api20100401Yesterday parameters: - name: AccountSid in: path @@ -26208,41 +35698,132 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordYesterdayResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListUsageRecordYesterdayResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Yesterday") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Yesterday")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-03' + price: '0' + price_unit: usd + start_date: '2015-09-03' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Category=sms-inbound-shortcode&StartDate=2015-09-03&EndDate=2015-09-03 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordYesterday - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json: servers: - url: https://api.twilio.com @@ -26253,10 +35834,12 @@ paths: - friendly_name - usage_category - trigger_by - pathType: instance parent: /Accounts/{AccountSid}/Usage.json + pathType: instance get: description: Fetch and instance of a usage-trigger + tags: + - Api20100401Trigger parameters: - name: AccountSid in: path @@ -26284,14 +35867,33 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + callback_method: GET + callback_url: http://cap.com/streetfight + current_value: '0' + date_created: Sun, 06 Sep 2015 12:58:45 +0000 + date_fired: null + date_updated: Sun, 06 Sep 2015 12:58:45 +0000 + friendly_name: raphael-cluster-1441544325.86 + recurring: yearly + sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trigger_by: price + trigger_value: '50' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_category: totalprice + usage_record_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice description: OK security: - accountSid_authToken: [] operationId: FetchUsageTrigger - x-maturity: - - GA post: description: Update an instance of a usage trigger + tags: + - Api20100401Trigger parameters: - name: AccountSid in: path @@ -26319,12 +35921,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + callback_method: GET + callback_url: http://cap.com/streetfight + current_value: '0' + date_created: Sun, 06 Sep 2015 12:58:45 +0000 + date_fired: null + date_updated: Sun, 06 Sep 2015 12:58:45 +0000 + friendly_name: raphael-cluster-1441544325.86 + recurring: yearly + sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trigger_by: price + trigger_value: '50' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_category: totalprice + usage_record_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice description: OK security: - accountSid_authToken: [] operationId: UpdateUsageTrigger - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -26353,8 +35972,16 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + update: + value: + CallbackMethod: GET + CallbackUrl: https://example.com + FriendlyName: friendly_name delete: description: '' + tags: + - Api20100401Trigger parameters: - name: AccountSid in: path @@ -26382,8 +36009,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUsageTrigger - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json: servers: - url: https://api.twilio.com @@ -26394,10 +36019,12 @@ paths: - friendly_name - usage_category - trigger_by - pathType: list parent: /Accounts/{AccountSid}/Usage.json + pathType: list post: description: Create a new UsageTrigger + tags: + - Api20100401Trigger parameters: - name: AccountSid in: path @@ -26415,12 +36042,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + callback_method: GET + callback_url: http://cap.com/streetfight + current_value: '0' + date_created: Sun, 06 Sep 2015 12:58:45 +0000 + date_fired: null + date_updated: Sun, 06 Sep 2015 12:58:45 +0000 + friendly_name: raphael-cluster-1441544325.86 + recurring: yearly + sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trigger_by: price + trigger_value: '50' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_category: totalprice + usage_record_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice description: Created security: - accountSid_authToken: [] operationId: CreateUsageTrigger - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -26479,9 +36123,21 @@ paths: - CallbackUrl - TriggerValue - UsageCategory + examples: + create: + value: + CallbackMethod: GET + CallbackUrl: https://example.com + FriendlyName: friendly_name + Recurring: daily + TriggerBy: count + TriggerValue: trigger_value + UsageCategory: calleridlookups get: description: Retrieve a list of usage-triggers belonging to the account used to make the request + tags: + - Api20100401Trigger parameters: - name: AccountSid in: path @@ -26501,6 +36157,11 @@ paths: schema: type: string $ref: '#/components/schemas/usage_trigger_enum_recurring' + examples: + readFull: + value: daily + readEmpty: + value: daily - name: TriggerBy in: query description: 'The trigger field of the UsageTriggers to read. Can be: `count`, @@ -26508,6 +36169,11 @@ paths: schema: type: string $ref: '#/components/schemas/usage_trigger_enum_trigger_field' + examples: + readFull: + value: count + readEmpty: + value: count - name: UsageCategory in: query description: The usage category of the UsageTriggers to read. Must be a supported @@ -26515,6 +36181,11 @@ paths: schema: type: string $ref: '#/components/schemas/usage_trigger_enum_usage_category' + examples: + readFull: + value: calleridlookups + readEmpty: + value: calleridlookups - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -26539,41 +36210,125 @@ paths: content: application/json: schema: - type: object - title: ListUsageTriggerResponse - properties: - usage_triggers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' + first_page_uri: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' + next_page_uri: + format: uri + nullable: true + type: string + 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: + format: uri + nullable: true + type: string + 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: + format: uri + type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' + type: object + - type: object + title: ListUsageTriggerResponse + properties: + usage_triggers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Trigger") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Trigger")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageTriggers")' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=626 + next_page_uri: null + num_pages: 627 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 627 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers + usage_triggers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + callback_method: GET + callback_url: http://cap.com/streetfight + current_value: '0' + date_created: Sun, 06 Sep 2015 12:58:45 +0000 + date_fired: null + date_updated: Sun, 06 Sep 2015 12:58:45 +0000 + friendly_name: raphael-cluster-1441544325.86 + recurring: yearly + sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trigger_by: price + trigger_value: '50' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_category: totalprice + usage_record_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=626 + next_page_uri: null + num_pages: 627 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 627 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers + usage_triggers: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageTrigger - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessages.json: servers: - url: https://api.twilio.com @@ -26582,10 +36337,12 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: Create a new User Defined Message for the given Call SID. + tags: + - Api20100401UserDefinedMessage parameters: - name: AccountSid in: path @@ -26613,12 +36370,17 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.user_defined_message' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: KXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 description: Created security: - accountSid_authToken: [] operationId: CreateUserDefinedMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -26636,6 +36398,11 @@ paths: be a unique string value per API call and can be a randomly generated. required: - Content + examples: + create: + value: + Content: '{"key":"value"}' + IdempotencyKey: '1' /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessageSubscriptions.json: servers: - url: https://api.twilio.com @@ -26644,10 +36411,12 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: Subscribe to User Defined Messages for a given Call SID. + tags: + - Api20100401UserDefinedMessageSubscription parameters: - name: AccountSid in: path @@ -26676,12 +36445,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.user_defined_message_subscription' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ZYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions/ZYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateUserDefinedMessageSubscription - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -26713,6 +36488,12 @@ paths: above `Url`. Either `GET` or `POST`. Default is `POST`. required: - Callback + examples: + create: + value: + Callback: http://www.example.com + Method: POST + IdempotencyKey: '1' /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessageSubscriptions/{Sid}.json: servers: - url: https://api.twilio.com @@ -26721,10 +36502,12 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance delete: description: Delete a specific User Defined Message Subscription. + tags: + - Api20100401UserDefinedMessageSubscription parameters: - name: AccountSid in: path @@ -26762,17 +36545,78 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserDefinedMessageSubscription - x-maturity: - - GA servers: - url: https://api.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. +tags: +- name: Api20100401Account +- name: Api20100401AddOnResult +- name: Api20100401Address +- name: Api20100401AllTime +- name: Api20100401Application +- name: Api20100401AssignedAddOn +- name: Api20100401AssignedAddOnExtension +- name: Api20100401AuthCallsCredentialListMapping +- name: Api20100401AuthCallsIpAccessControlListMapping +- name: Api20100401AuthRegistrationsCredentialListMapping +- name: Api20100401AuthorizedConnectApp +- name: Api20100401AvailablePhoneNumberCountry +- name: Api20100401Balance +- name: Api20100401Call +- name: Api20100401Conference +- name: Api20100401ConnectApp +- name: Api20100401Credential +- name: Api20100401CredentialList +- name: Api20100401CredentialListMapping +- name: Api20100401Daily +- name: Api20100401Data +- name: Api20100401DependentPhoneNumber +- name: Api20100401Domain +- name: Api20100401Event +- name: Api20100401Feedback +- name: Api20100401HealthCheck +- name: Api20100401IncomingPhoneNumber +- name: Api20100401IpAccessControlList +- name: Api20100401IpAccessControlListMapping +- name: Api20100401IpAddress +- name: Api20100401Key +- name: Api20100401LastMonth +- name: Api20100401Local +- name: Api20100401MachineToMachine +- name: Api20100401Media +- name: Api20100401Member +- name: Api20100401Message +- name: Api20100401Mobile +- name: Api20100401Monthly +- name: Api20100401National +- name: Api20100401NewKey +- name: Api20100401NewSigningKey +- name: Api20100401Notification +- name: Api20100401OutgoingCallerId +- name: Api20100401Participant +- name: Api20100401Payload +- name: Api20100401Payment +- name: Api20100401Queue +- name: Api20100401Record +- name: Api20100401Recording +- name: Api20100401Region +- name: Api20100401SharedCost +- name: Api20100401ShortCode +- name: Api20100401SigningKey +- name: Api20100401Sip +- name: Api20100401Siprec +- name: Api20100401SmsMessage +- name: Api20100401Stream +- name: Api20100401ThisMonth +- name: Api20100401Today +- name: Api20100401Token +- name: Api20100401TollFree +- name: Api20100401Transcription +- name: Api20100401Trigger +- name: Api20100401UserDefinedMessage +- name: Api20100401UserDefinedMessageSubscription +- name: Api20100401ValidationRequest +- name: Api20100401Voip +- name: Api20100401Yearly +- name: Api20100401Yesterday +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_autopilot_v1.yaml b/spec/yaml/twilio_autopilot_v1.yaml deleted file mode 100644 index ab81d42f..00000000 --- a/spec/yaml/twilio_autopilot_v1.yaml +++ /dev/null @@ -1,3477 +0,0 @@ -components: - schemas: - autopilot.v1.assistant: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Assistant resource. - date_created: - type: string - format: date-time - nullable: true - description: The date and time in GMT when 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 when the resource was last updated - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - friendly_name: - type: string - nullable: true - description: The string that you assigned to describe the resource. It is - not unique and can be up to 255 characters long. - latest_model_build_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - nullable: true - description: Reserved. - links: - type: object - format: uri-map - nullable: true - description: A list of the URLs of the Assistant's related resources. - log_queries: - type: boolean - nullable: true - description: 'Whether queries should be logged and kept after training. - Can be: `true` or `false` and defaults to `true`. If `true`, queries are - stored for 30 days, and then deleted. If `false`, no queries are stored.' - development_stage: - type: string - nullable: true - description: A string describing the state of the assistant. - needs_model_build: - type: boolean - nullable: true - description: Whether model needs to be rebuilt. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the Assistant - resource. - unique_name: - type: string - nullable: true - description: An application-defined string that uniquely identifies the - resource. It can be used in place of the resource's `sid` in the URL to - address the resource. It can be up to 64 characters long. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the Assistant resource. - callback_url: - type: string - format: uri - nullable: true - description: Reserved. - callback_events: - type: string - nullable: true - description: Reserved. - autopilot.v1.assistant.defaults: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Defaults resource. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the Defaults resource. - data: - nullable: true - description: The JSON string that describes the default task links for the - `assistant_initiation`, `collect`, and `fallback` situations. - autopilot.v1.assistant.dialogue: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Dialogue resource. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UK[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the Dialogue - resource. - data: - nullable: true - description: The JSON string that describes the dialogue session object. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the Dialogue resource. - autopilot.v1.assistant.task.field: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Field resource. - date_created: - type: string - format: date-time - nullable: true - description: The date and time in GMT when 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 when the resource was last updated - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - field_type: - type: string - nullable: true - description: 'The Field Type of the field. Can be: a [Built-in Field Type](https://www.twilio.com/docs/autopilot/built-in-field-types), - the unique_name, or the SID of a custom Field Type.' - task_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - resource associated with this Field. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the resource. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UE[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the Field resource. - unique_name: - type: string - nullable: true - description: An application-defined string that uniquely identifies the - resource. It can be used in place of the resource's `sid` in the URL to - address the resource. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the Field resource. - autopilot.v1.assistant.field_type: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the FieldType resource. - date_created: - type: string - format: date-time - nullable: true - description: The date and time in GMT when 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 when the resource was last updated - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - friendly_name: - type: string - nullable: true - description: The string that you assigned to describe the resource. It is - not unique and can be up to 255 characters long. - links: - type: object - format: uri-map - nullable: true - description: A list of the URLs of related resources. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UB[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the FieldType - resource. - unique_name: - type: string - nullable: true - description: An application-defined string that uniquely identifies the - resource. It can be used in place of the resource's `sid` in the URL to - address the resource. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the FieldType resource. - autopilot.v1.assistant.field_type.field_value: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the FieldValue resource. - date_created: - type: string - format: date-time - nullable: true - description: The date and time in GMT when 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 when the resource was last updated - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - field_type_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UB[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the Field Type associated with the Field Value. - language: - type: string - nullable: true - description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) - tag that specifies the language of the value. Currently supported tags: - `en-US`' - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the FieldType associated with the resource. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UC[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the FieldValue - resource. - value: - type: string - nullable: true - description: The Field Value data. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the FieldValue resource. - synonym_of: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UC[0-9a-fA-F]{32}$ - nullable: true - description: The word for which the field value is a synonym of. - autopilot.v1.assistant.model_build: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the ModelBuild resource. - date_created: - type: string - format: date-time - nullable: true - description: The date and time in GMT when 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 when the resource was last updated - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the ModelBuild - resource. - status: - type: string - $ref: '#/components/schemas/model_build_enum_status' - nullable: true - description: 'The status of the model build process. Can be: `enqueued`, - `building`, `completed`, or `failed`' - unique_name: - type: string - nullable: true - description: An application-defined string that uniquely identifies the - resource. It can be used as an alternative to the `sid` in the URL path - to address the resource. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the ModelBuild resource. - build_duration: - type: integer - nullable: true - description: The time in seconds it took to build the model. - error_code: - type: integer - nullable: true - description: If the `status` for the model build is `failed`, this value - is a code to more information about the failure. This value will be null - for all other statuses. See [error code dictionary](https://www.twilio.com/docs/api/errors) - for a description of the error. - model_build_enum_status: - type: string - enum: - - enqueued - - building - - completed - - failed - - canceled - autopilot.v1.assistant.query: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Query resource. - date_created: - type: string - format: date-time - nullable: true - description: The date and time in GMT when 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 when the resource was last updated - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - results: - nullable: true - description: The natural language analysis results that include the [Task](https://www.twilio.com/docs/autopilot/api/task) - recognized and a list of identified [Fields](https://www.twilio.com/docs/autopilot/api/task-field). - language: - type: string - nullable: true - description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) - string that specifies the language used by the Query. For example: `en-US`.' - model_build_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) - queried. - query: - type: string - nullable: true - description: The end-user's natural language input. - sample_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - nullable: true - description: The SID of an optional reference to the [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) - created from the query. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UH[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the Query resource. - status: - type: string - nullable: true - description: 'The status of the Query. Can be: `pending-review`, `reviewed`, - or `discarded`' - url: - type: string - format: uri - nullable: true - description: The absolute URL of the Query resource. - source_channel: - type: string - nullable: true - description: The communication channel from where the end-user input came. - dialogue_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UK[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue). - autopilot.v1.restore_assistant: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Assistant resource. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the Assistant - resource. - date_created: - type: string - format: date-time - nullable: true - description: The date and time in GMT when 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 when the resource was last updated - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - unique_name: - type: string - nullable: true - description: An application-defined string that uniquely identifies the - resource. It can be used in place of the resource's `sid` in the URL to - address the resource. - friendly_name: - type: string - nullable: true - description: The string that you assigned to describe the resource. It is - not unique and can be up to 255 characters long. - needs_model_build: - type: boolean - nullable: true - description: Whether model needs to be rebuilt. - latest_model_build_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - nullable: true - description: Reserved. - log_queries: - type: boolean - nullable: true - description: 'Whether queries should be logged and kept after training. - Can be: `true` or `false` and defaults to `true`. If `true`, queries are - stored for 30 days, and then deleted. If `false`, no queries are stored.' - development_stage: - type: string - nullable: true - description: A string describing the state of the assistant. - callback_url: - type: string - format: uri - nullable: true - description: Reserved. - callback_events: - type: string - nullable: true - description: Reserved. - autopilot.v1.assistant.task.sample: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Sample resource. - date_created: - type: string - format: date-time - nullable: true - description: The date and time in GMT when 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 when the resource was last updated - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - task_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - associated with the resource. - language: - type: string - nullable: true - description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) - string that specifies the language used for the sample. For example: `en-US`.' - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the resource. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the Sample resource. - tagged_text: - type: string - nullable: true - description: The text example of how end users might express the task. The - sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging). - url: - type: string - format: uri - nullable: true - description: The absolute URL of the Sample resource. - source_channel: - type: string - nullable: true - description: 'The communication channel from which the sample was captured. - Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, - or null if not included.' - autopilot.v1.assistant.style_sheet: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the StyleSheet resource. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the StyleSheet resource. - data: - nullable: true - description: The JSON string that describes the style sheet object. - autopilot.v1.assistant.task: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Task resource. - date_created: - type: string - format: date-time - nullable: true - description: The date and time in GMT when 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 when the resource was last updated - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - friendly_name: - type: string - nullable: true - description: The string that you assigned to describe the resource. It is - not unique and can be up to 255 characters long. - links: - type: object - format: uri-map - nullable: true - description: A list of the URLs of related resources. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the Task resource. - unique_name: - type: string - nullable: true - description: An application-defined string that uniquely identifies the - resource. It can be used in place of the resource's `sid` in the URL to - address the resource. - actions_url: - type: string - format: uri - nullable: true - description: The URL from which the Assistant can fetch actions. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the Task resource. - autopilot.v1.assistant.task.task_actions: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the TaskActions resource. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the resource. - task_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - associated with the resource. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the TaskActions resource. - data: - nullable: true - description: The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) - that instruct the Assistant on how to perform the task. - autopilot.v1.assistant.task.task_statistics: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the TaskStatistics resource. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the resource. - task_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - for which the statistics were collected. - samples_count: - type: integer - nullable: true - description: The total number of [Samples](https://www.twilio.com/docs/autopilot/api/task-sample) - associated with the Task. - fields_count: - type: integer - nullable: true - description: The total number of [Fields](https://www.twilio.com/docs/autopilot/api/task-field) - associated with the Task. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the TaskStatistics resource. - autopilot.v1.assistant.webhook: - type: object - properties: - url: - type: string - format: uri - nullable: true - description: The absolute URL of the Webhook 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/iam/api/account) - that created the Webhook resource. - date_created: - type: string - format: date-time - nullable: true - description: The date and time in GMT when 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 when the resource was last updated - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UM[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the Webhook resource. - unique_name: - type: string - nullable: true - description: An application-defined string that uniquely identifies the - resource. It can be used in place of the resource's `sid` in the URL to - address the resource. - events: - type: string - nullable: true - description: The list of space-separated events that this Webhook is subscribed - to. - webhook_url: - type: string - format: uri - nullable: true - description: The URL associated with this Webhook. - webhook_method: - type: string - nullable: true - description: The method used when calling the webhook's URL. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic -info: - title: Twilio - Autopilot - description: This is the public Twilio REST API. - termsOfService: https://www.twilio.com/legal/tos - contact: - name: Twilio Support - url: https://support.twilio.com - email: support@twilio.com - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 -openapi: 3.0.1 -paths: - /v1/Assistants/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - pathType: instance - dependentProperties: - field_type: '{assistant_sid: sid}' - task: '{assistant_sid: sid}' - model_build: '{assistant_sid: sid}' - query: '{assistant_sid: sid}' - style_sheet: '{assistant_sid: sid}' - defaults: '{assistant_sid: sid}' - dialogue: '{assistant_sid: sid}' - webhook: '{assistant_sid: sid}' - get: - description: '' - parameters: - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Assistant - resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchAssistant - x-maturity: - - Preview - post: - description: '' - parameters: - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Assistant - resource to update. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateAssistant - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateAssistantRequest - properties: - FriendlyName: - type: string - description: A descriptive string that you create to describe the - resource. It is not unique and can be up to 255 characters long. - LogQueries: - type: boolean - description: 'Whether queries should be logged and kept after training. - Can be: `true` or `false` and defaults to `true`. If `true`, queries - are stored for 30 days, and then deleted. If `false`, no queries - are stored.' - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the resource. It can be used as an alternative to the `sid` in - the URL path to address the resource. The first 64 characters - must be unique. - CallbackUrl: - type: string - format: uri - description: Reserved. - CallbackEvents: - type: string - description: Reserved. - StyleSheet: - description: The JSON string that defines the Assistant's [style - sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet) - Defaults: - description: A JSON object that defines the Assistant's [default - tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) - for various scenarios, including initiation actions and fallback - tasks. - DevelopmentStage: - type: string - description: A string describing the state of the assistant. - delete: - description: '' - parameters: - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Assistant - resource to delete. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteAssistant - x-maturity: - - Preview - /v1/Assistants: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - pathType: list - dependentProperties: - field_type: '{assistant_sid: sid}' - task: '{assistant_sid: sid}' - model_build: '{assistant_sid: sid}' - query: '{assistant_sid: sid}' - style_sheet: '{assistant_sid: sid}' - defaults: '{assistant_sid: sid}' - dialogue: '{assistant_sid: sid}' - webhook: '{assistant_sid: sid}' - get: - description: '' - 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: ListAssistantResponse - properties: - assistants: - type: array - items: - $ref: '#/components/schemas/autopilot.v1.assistant' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListAssistant - x-maturity: - - Preview - post: - description: '' - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateAssistant - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateAssistantRequest - properties: - FriendlyName: - type: string - description: A descriptive string that you create to describe the - new resource. It is not unique and can be up to 255 characters - long. - LogQueries: - type: boolean - description: 'Whether queries should be logged and kept after training. - Can be: `true` or `false` and defaults to `true`. If `true`, queries - are stored for 30 days, and then deleted. If `false`, no queries - are stored.' - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the new resource. It can be used as an alternative to the `sid` - in the URL path to address the resource. The first 64 characters - must be unique. - CallbackUrl: - type: string - format: uri - description: Reserved. - CallbackEvents: - type: string - description: Reserved. - StyleSheet: - description: The JSON string that defines the Assistant's [style - sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet) - Defaults: - description: A JSON object that defines the Assistant's [default - tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) - for various scenarios, including initiation actions and fallback - tasks. - /v1/Assistants/{AssistantSid}/Defaults: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - data - pathType: instance - parent: /Assistants/{Sid} - className: defaults - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.defaults' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDefaults - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to update. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.defaults' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDefaults - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateDefaultsRequest - properties: - Defaults: - description: A JSON string that describes the default task links - for the `assistant_initiation`, `collect`, and `fallback` situations. - /v1/Assistants/{AssistantSid}/Dialogues/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - data - pathType: instance - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to fetch. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Dialogue - resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.dialogue' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDialogue - x-maturity: - - Preview - /v1/Assistants/{AssistantSid}/Dialogues: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - data - pathType: list - parent: /Assistants/{Sid} - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - field_type - pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the resource to fetch. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - resource associated with the Field resource to fetch. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Field - resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.task.field' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchField - x-maturity: - - Preview - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the resources to delete. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - resource associated with the Field resource to delete. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Field - resource to delete. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteField - x-maturity: - - Preview - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - field_type - pathType: list - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the resources to read. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - resource associated with the Field resources to read. - schema: - type: string - required: true - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListFieldResponse - properties: - fields: - type: array - items: - $ref: '#/components/schemas/autopilot.v1.assistant.task.field' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListField - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the new resource. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - resource associated with the new Field resource. - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.task.field' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateField - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateFieldRequest - properties: - FieldType: - type: string - description: 'The Field Type of the new field. Can be: a [Built-in - Field Type](https://www.twilio.com/docs/autopilot/built-in-field-types), - the `unique_name`, or the `sid` of a custom Field Type.' - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the new resource. This value must be a unique string of no more - than 64 characters. It can be used as an alternative to the `sid` - in the URL path to address the resource. - required: - - FieldType - - UniqueName - /v1/Assistants/{AssistantSid}/FieldTypes/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - pathType: instance - dependentProperties: - field_value: '{assistant_sid: assistant_sid, field_type_sid: sid}' - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to fetch. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the FieldType - resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.field_type' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchFieldType - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the to update. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the FieldType - resource to update. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.field_type' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateFieldType - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateFieldTypeRequest - properties: - FriendlyName: - type: string - description: A descriptive string that you create to describe the - resource. It is not unique and can be up to 255 characters long. - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the resource. It can be used as an alternative to the `sid` in - the URL path to address the resource. The first 64 characters - must be unique. - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resources to delete. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the FieldType - resource to delete. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteFieldType - x-maturity: - - Preview - /v1/Assistants/{AssistantSid}/FieldTypes: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - pathType: list - dependentProperties: - field_value: '{assistant_sid: assistant_sid, field_type_sid: sid}' - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resources to read. - schema: - type: string - required: true - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListFieldTypeResponse - properties: - field_types: - type: array - items: - $ref: '#/components/schemas/autopilot.v1.assistant.field_type' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListFieldType - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the new resource. - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.field_type' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateFieldType - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateFieldTypeRequest - properties: - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the new resource. It can be used as an alternative to the `sid` - in the URL path to address the resource. The first 64 characters - must be unique. - FriendlyName: - type: string - description: A descriptive string that you create to describe the - new resource. It is not unique and can be up to 255 characters - long. - required: - - UniqueName - /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - value - - language - pathType: instance - parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the FieldType associated with the resource to fetch. - schema: - type: string - required: true - - name: FieldTypeSid - in: path - description: The SID of the Field Type associated with the Field Value to - fetch. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the FieldValue - resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.field_type.field_value' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchFieldValue - x-maturity: - - Preview - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the FieldType associated with the resources to delete. - schema: - type: string - required: true - - name: FieldTypeSid - in: path - description: The SID of the Field Type associated with the Field Value to - delete. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the FieldValue - resource to delete. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteFieldValue - x-maturity: - - Preview - /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - value - - language - pathType: list - parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the FieldType associated with the resources to read. - schema: - type: string - required: true - - name: FieldTypeSid - in: path - description: The SID of the Field Type associated with the Field Value to - read. - schema: - type: string - required: true - - name: Language - in: query - description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) - tag that specifies the language of the value. Currently supported tags: - `en-US`' - schema: - type: string - - 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: ListFieldValueResponse - properties: - field_values: - type: array - items: - $ref: '#/components/schemas/autopilot.v1.assistant.field_type.field_value' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListFieldValue - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the FieldType associated with the new resource. - schema: - type: string - required: true - - name: FieldTypeSid - in: path - description: The SID of the Field Type associated with the Field Value. - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.field_type.field_value' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateFieldValue - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateFieldValueRequest - properties: - Language: - type: string - description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) - tag that specifies the language of the value. Currently supported - tags: `en-US`' - Value: - type: string - description: The Field Value data. - SynonymOf: - type: string - description: The string value that indicates which word the field - value is a synonym of. - required: - - Language - - Value - /v1/Assistants/{AssistantSid}/ModelBuilds/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - status - - date_created - pathType: instance - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to fetch. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the ModelBuild - resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.model_build' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchModelBuild - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to update. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the ModelBuild - resource to update. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.model_build' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateModelBuild - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateModelBuildRequest - properties: - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the resource. This value must be a unique string of no more than - 64 characters. It can be used as an alternative to the `sid` in - the URL path to address the resource. - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resources to delete. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the ModelBuild - resource to delete. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteModelBuild - x-maturity: - - Preview - /v1/Assistants/{AssistantSid}/ModelBuilds: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - status - - date_created - pathType: list - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resources to read. - schema: - type: string - required: true - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListModelBuildResponse - properties: - model_builds: - type: array - items: - $ref: '#/components/schemas/autopilot.v1.assistant.model_build' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListModelBuild - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the new resource. - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.model_build' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateModelBuild - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateModelBuildRequest - properties: - StatusCallback: - type: string - format: uri - description: The URL we should call using a POST method to send - status information to your application. - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the new resource. This value must be a unique string of no more - than 64 characters. It can be used as an alternative to the `sid` - in the URL path to address the resource. - /v1/Assistants/{AssistantSid}/Queries/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - query - - status - - language - pathType: instance - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to fetch. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Query - resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.query' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchQuery - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to update. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Query - resource to update. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.query' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateQuery - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateQueryRequest - properties: - SampleSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - description: The SID of an optional reference to the [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) - created from the query. - Status: - type: string - description: 'The new status of the resource. Can be: `pending-review`, - `reviewed`, or `discarded`' - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resources to delete. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Query - resource to delete. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteQuery - x-maturity: - - Preview - /v1/Assistants/{AssistantSid}/Queries: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - query - - status - - language - pathType: list - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resources to read. - schema: - type: string - required: true - - name: Language - in: query - description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) - string that specifies the language used by the Query resources to read. - For example: `en-US`.' - schema: - type: string - - name: ModelBuild - in: query - description: The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) - to be queried. - schema: - type: string - - name: Status - in: query - description: 'The status of the resources to read. Can be: `pending-review`, - `reviewed`, or `discarded`' - schema: - type: string - - name: DialogueSid - in: query - description: The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue). - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UK[0-9a-fA-F]{32}$ - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListQueryResponse - properties: - queries: - type: array - items: - $ref: '#/components/schemas/autopilot.v1.assistant.query' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListQuery - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the new resource. - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.query' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateQuery - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateQueryRequest - properties: - Language: - type: string - description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) - string that specifies the language used for the new query. For - example: `en-US`.' - Query: - type: string - description: The end-user's natural language input. It can be up - to 2048 characters long. - Tasks: - type: string - description: The list of tasks to limit the new query to. Tasks - are expressed as a comma-separated list of task `unique_name` - values. For example, `task-unique_name-1, task-unique_name-2`. - Listing specific tasks is useful to constrain the paths that a - user can take. - ModelBuild: - type: string - description: The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) - to be queried. - required: - - Language - - Query - /v1/Assistants/Restore: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - account_sid - - sid - - unique_name - - friendly_name - pathType: list - mountName: restore_assistant - post: - description: '' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.restore_assistant' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateRestoreAssistant - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateRestoreAssistantRequest - properties: - Assistant: - type: string - description: The Twilio-provided string that uniquely identifies - the Assistant resource to restore. - required: - - Assistant - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - tagged_text - - language - - source_channel - pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the resource to fetch. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - associated with the Sample resource to create. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Sample - resource to fetch. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchSample - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the resource to update. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - associated with the Sample resource to update. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Sample - resource to update. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateSample - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateSampleRequest - properties: - Language: - type: string - description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) - string that specifies the language used for the sample. For example: - `en-US`.' - TaggedText: - type: string - description: The text example of how end users might express the - task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging). - SourceChannel: - type: string - description: 'The communication channel from which the sample was - captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, - `slack`, or null if not included.' - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the resources to delete. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - associated with the Sample resource to delete. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Sample - resource to delete. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteSample - x-maturity: - - Preview - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - tagged_text - - language - - source_channel - pathType: list - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the resources to read. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - associated with the Sample resources to read. - schema: - type: string - required: true - - name: Language - in: query - description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) - string that specifies the language used for the sample. For example: `en-US`.' - schema: - type: string - - 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: ListSampleResponse - properties: - samples: - type: array - items: - $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListSample - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task associated with the new resource. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - associated with the Sample resource to create. - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSample - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSampleRequest - properties: - Language: - type: string - description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) - string that specifies the language used for the new sample. For - example: `en-US`.' - TaggedText: - type: string - description: The text example of how end users might express the - task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging). - SourceChannel: - type: string - description: 'The communication channel from which the new sample - was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, - `slack`, or null if not included.' - required: - - Language - - TaggedText - /v1/Assistants/{AssistantSid}/StyleSheet: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - data - pathType: instance - parent: /Assistants/{Sid} - get: - description: Returns Style sheet JSON object for the Assistant - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.style_sheet' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchStyleSheet - x-maturity: - - Preview - post: - description: Updates the style sheet for an Assistant identified by `assistant_sid`. - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to update. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.style_sheet' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateStyleSheet - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateStyleSheetRequest - properties: - StyleSheet: - description: The JSON string that describes the style sheet object. - /v1/Assistants/{AssistantSid}/Tasks/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - pathType: instance - dependentProperties: - field: '{assistant_sid: assistant_sid, task_sid: sid}' - sample: '{assistant_sid: assistant_sid, task_sid: sid}' - task_actions: '{assistant_sid: assistant_sid, task_sid: sid}' - task_statistics: '{assistant_sid: assistant_sid, task_sid: sid}' - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to fetch. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Task - resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.task' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchTask - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to update. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Task - resource to update. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.task' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateTask - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateTaskRequest - properties: - FriendlyName: - type: string - description: A descriptive string that you create to describe the - resource. It is not unique and can be up to 255 characters long. - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the resource. This value must be 64 characters or less in length - and be unique. It can be used as an alternative to the `sid` in - the URL path to address the resource. - Actions: - description: The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) - that instruct the Assistant on how to perform the task. - ActionsUrl: - type: string - format: uri - description: The URL from which the Assistant can fetch actions. - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resources to delete. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Task - resource to delete. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteTask - x-maturity: - - Preview - /v1/Assistants/{AssistantSid}/Tasks: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - pathType: list - dependentProperties: - field: '{assistant_sid: assistant_sid, task_sid: sid}' - sample: '{assistant_sid: assistant_sid, task_sid: sid}' - task_actions: '{assistant_sid: assistant_sid, task_sid: sid}' - task_statistics: '{assistant_sid: assistant_sid, task_sid: sid}' - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resources to read. - schema: - type: string - required: true - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListTaskResponse - properties: - tasks: - type: array - items: - $ref: '#/components/schemas/autopilot.v1.assistant.task' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListTask - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the new resource. - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.task' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateTask - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateTaskRequest - properties: - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the new resource. It can be used as an alternative to the `sid` - in the URL path to address the resource. This value must be unique - and 64 characters or less in length. - FriendlyName: - type: string - description: A descriptive string that you create to describe the - new resource. It is not unique and can be up to 255 characters - long. - Actions: - description: The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) - that instruct the Assistant on how to perform the task. It is - optional and not unique. - ActionsUrl: - type: string - format: uri - description: The URL from which the Assistant can fetch actions. - required: - - UniqueName - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - data - pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - mountName: task_actions - className: task_actions - get: - description: Returns JSON actions for the Task. - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task for which the task actions to fetch were - defined. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - for which the task actions to fetch were defined. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.task.task_actions' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchTaskActions - x-maturity: - - Preview - post: - description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the Task for which the task actions to update were - defined. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - for which the task actions to update were defined. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.task.task_actions' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateTaskActions - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateTaskActionsRequest - properties: - Actions: - description: The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) - that instruct the Assistant on how to perform the task. - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - samples_count - - fields_count - pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - className: task_statistics - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to fetch. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) - that is associated with the resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.task.task_statistics' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchTaskStatistics - x-maturity: - - Preview - /v1/Assistants/{AssistantSid}/Webhooks/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - events - - wehbook_url - - webhook_method - pathType: instance - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to fetch. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Webhook - resource to fetch. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.webhook' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchWebhook - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resource to update. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Webhook - resource to update. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.webhook' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateWebhook - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateWebhookRequest - properties: - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the new resource. It can be used as an alternative to the `sid` - in the URL path to address the resource. This value must be unique - and 64 characters or less in length. - Events: - type: string - description: The list of space-separated events that this Webhook - will subscribe to. - WebhookUrl: - type: string - format: uri - description: The URL associated with this Webhook. - WebhookMethod: - type: string - description: The method to be used when calling the webhook's URL. - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resources to delete. - schema: - type: string - required: true - - name: Sid - in: path - description: The Twilio-provided string that uniquely identifies the Webhook - resource to delete. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteWebhook - x-maturity: - - Preview - /v1/Assistants/{AssistantSid}/Webhooks: - servers: - - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - events - - wehbook_url - - webhook_method - pathType: list - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the resources to read. - schema: - type: string - required: true - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListWebhookResponse - properties: - webhooks: - type: array - items: - $ref: '#/components/schemas/autopilot.v1.assistant.webhook' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListWebhook - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) - that is the parent of the new resource. - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant.webhook' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateWebhook - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateWebhookRequest - properties: - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the new resource. It can be used as an alternative to the `sid` - in the URL path to address the resource. This value must be unique - and 64 characters or less in length. - Events: - type: string - description: The list of space-separated events that this Webhook - will subscribe to. - WebhookUrl: - type: string - format: uri - description: The URL associated with this Webhook. - WebhookMethod: - type: string - description: The method to be used when calling the webhook's URL. - required: - - UniqueName - - Events - - WebhookUrl -servers: -- url: https://autopilot.twilio.com -x-maturity: -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. diff --git a/spec/yaml/twilio_bulkexports_v1.yaml b/spec/yaml/twilio_bulkexports_v1.yaml index 53466cd7..3b2a134e 100644 --- a/spec/yaml/twilio_bulkexports_v1.yaml +++ b/spec/yaml/twilio_bulkexports_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: bulkexports.v1.export.day: type: object @@ -231,10 +235,6 @@ components: - Failed - RunningToBeDeleted - DeletedByUserRequest - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Bulkexports description: This is the public Twilio REST API. @@ -246,13 +246,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Exports/{ResourceType}/Days/{Day}: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - friendly_name @@ -261,10 +261,12 @@ paths: - resource_type - size - redirectTo - pathType: instance parent: /Exports/{ResourceType} + pathType: instance get: description: Fetch a specific Day. + tags: + - BulkexportsV1Day parameters: - name: ResourceType in: path @@ -286,16 +288,18 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export.day-instance' + examples: + fetch: + value: + redirect_to: https://documentation-example-twilio-bucket.s3.amazonaws.com/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Temporary Redirect security: - accountSid_authToken: [] operationId: FetchDay - x-maturity: - - GA /v1/Exports/{ResourceType}/Days: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - friendly_name @@ -304,10 +308,12 @@ paths: - resource_type - size - redirectTo - pathType: list parent: /Exports/{ResourceType} + pathType: list get: description: Retrieve a list of all Days for a resource. + tags: + - BulkexportsV1Day parameters: - name: ResourceType in: path @@ -348,46 +354,80 @@ paths: items: $ref: '#/components/schemas/bulkexports.v1.export.day' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + days: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0 + previous_page_url: null + url: https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0 + next_page_url: null + key: days + readFull: + value: + days: + - day: '2017-04-01' + size: 100 + resource_type: Messages + create_date: '2017-04-02' + friendly_name: friendly_name + meta: + page: 0 + page_size: 50 + first_page_url: https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0 + previous_page_url: null + url: https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0 + next_page_url: null + key: days description: OK security: - accountSid_authToken: [] operationId: ListDay - x-maturity: - - GA /v1/Exports/{ResourceType}: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: - day: '{resource_type: resource_type}' - export_custom_job: '{resource_type: resource_type}' + days: + mapping: + resource_type: resource_type + resource_url: /v1/Exports/{resource_type}/Days + export_custom_jobs: + mapping: + resource_type: resource_type + resource_url: /v1/Exports/{resource_type}/Jobs + pathType: instance get: description: Fetch a specific Export. + tags: + - BulkexportsV1Export parameters: - name: ResourceType in: path @@ -402,26 +442,37 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export' + examples: + fetch: + value: + resource_type: Messages + url: https://bulkexports.twilio.com/v1/Exports/Messages + links: + days: https://bulkexports.twilio.com/v1/Exports/Messages/Days description: OK security: - accountSid_authToken: [] operationId: FetchExport - x-maturity: - - GA /v1/Exports: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list dependentProperties: - day: '{resource_type: resource_type}' - export_custom_job: '{resource_type: resource_type}' + days: + mapping: + resource_type: resource_type + resource_url: /v1/Exports/{resource_type}/Days + export_custom_jobs: + mapping: + resource_type: resource_type + resource_url: /v1/Exports/{resource_type}/Jobs + pathType: list /v1/Exports/{ResourceType}/Configuration: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - enabled @@ -429,10 +480,12 @@ paths: - url - webhook_method - webhook_url - pathType: instance mountName: export_configuration + pathType: instance get: description: Fetch a specific Export Configuration. + tags: + - BulkexportsV1ExportConfiguration parameters: - name: ResourceType in: path @@ -447,14 +500,22 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export_configuration' + examples: + fetch: + value: + url: https://bulkexports.twilio.com/v1/Exports/Messages/Configuration + enabled: true + webhook_url: '' + webhook_method: '' + resource_type: Messages description: OK security: - accountSid_authToken: [] operationId: FetchExportConfiguration - x-maturity: - - GA post: description: Update a specific Export Configuration. + tags: + - BulkexportsV1ExportConfiguration parameters: - name: ResourceType in: path @@ -469,12 +530,18 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export_configuration' + examples: + update: + value: + url: https://bulkexports.twilio.com/v1/Exports/Messages/Configuration + enabled: true + webhook_url: '' + resource_type: Messages + webhook_method: '' description: OK security: - accountSid_authToken: [] operationId: UpdateExportConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -496,10 +563,14 @@ paths: description: Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url + examples: + update: + value: + Enabled: true /v1/Exports/{ResourceType}/Jobs: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - details @@ -513,11 +584,13 @@ paths: - start_day - webhook_method - webhook_url - pathType: list parent: /Exports/{ResourceType} mountName: export_custom_jobs + pathType: list get: description: '' + tags: + - BulkexportsV1ExportCustomJob parameters: - name: ResourceType in: path @@ -558,36 +631,70 @@ paths: items: $ref: '#/components/schemas/bulkexports.v1.export.export_custom_job' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + url: https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0 + page_size: 50 + key: jobs + first_page_url: https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0 + next_page_url: null + page: 0 + jobs: [] + readFull: + value: + meta: + previous_page_url: null + url: https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0 + page_size: 50 + key: jobs + first_page_url: https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0 + next_page_url: null + page: 0 + jobs: + - start_day: start_day + job_sid: JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + webhook_method: webhook_method + details: {} + end_day: end_day + webhook_url: webhook_url + email: email + resource_type: resource_type + job_queue_position: '1' + estimated_completion_time: '2021-03-15T20:20:14.547' description: OK security: - accountSid_authToken: [] operationId: ListExportCustomJob - x-maturity: - - GA post: description: '' + tags: + - BulkexportsV1ExportCustomJob parameters: - name: ResourceType in: path @@ -602,12 +709,24 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export.export_custom_job' + examples: + create: + value: + start_day: start_day + job_sid: JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + webhook_method: webhook_method + details: {} + end_day: end_day + webhook_url: webhook_url + email: email + resource_type: resource_type + job_queue_position: '1' + estimated_completion_time: '2021-03-15T20:20:14.547' description: Created security: - accountSid_authToken: [] operationId: CreateExportCustomJob - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -647,10 +766,19 @@ paths: - StartDay - EndDay - FriendlyName + examples: + create: + value: + EndDay: end_day_value + StartDay: start_day_value + WebhookUrl: webhook_url_value + WebhookMethod: webhook_method_value + FriendlyName: friendly_name_value + Email: email_value /v1/Exports/Jobs/{JobSid}: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - details @@ -664,10 +792,12 @@ paths: - start_day - webhook_method - webhook_url - pathType: instance parent: /Exports + pathType: instance get: description: '' + tags: + - BulkexportsV1Job parameters: - name: JobSid in: path @@ -685,14 +815,29 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export.job' + examples: + fetch: + value: + start_day: start_day + job_sid: JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://bulkexports.twilio.com/v1/Exports/Jobs/JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + end_day: end_day + details: {} + webhook_url: https://webhookexample.com + webhook_method: webhook_method + email: email + resource_type: resource_type + job_queue_position: '1' + estimated_completion_time: '2021-03-15T20:20:14.547' description: OK security: - accountSid_authToken: [] operationId: FetchJob - x-maturity: - - GA delete: description: '' + tags: + - BulkexportsV1Job parameters: - name: JobSid in: path @@ -710,12 +855,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteJob - x-maturity: - - GA /v1/Exports/Jobs: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - details @@ -729,10 +872,15 @@ paths: - start_day - webhook_method - webhook_url - pathType: list parent: /Exports + pathType: list servers: - url: https://bulkexports.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: BulkexportsV1Day +- name: BulkexportsV1Export +- name: BulkexportsV1ExportConfiguration +- name: BulkexportsV1ExportCustomJob +- name: BulkexportsV1Job +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml index 774e811b..8940f1e2 100644 --- a/spec/yaml/twilio_chat_v1.yaml +++ b/spec/yaml/twilio_chat_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: chat.v1.service.channel: type: object @@ -30,12 +34,20 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true @@ -43,6 +55,10 @@ components: If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string $ref: '#/components/schemas/channel_enum_channel_type' @@ -65,6 +81,10 @@ components: nullable: true description: The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 members_count: type: integer nullable: true @@ -114,6 +134,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/credential_enum_push_service' @@ -190,6 +214,10 @@ components: the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -261,6 +289,10 @@ components: the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -324,6 +356,10 @@ components: If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 service_sid: type: string minLength: 34 @@ -369,10 +405,18 @@ components: nullable: true description: The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the message's author. The default value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 body: type: string nullable: true description: The content of the message. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 index: type: integer nullable: true @@ -417,6 +461,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/role_enum_role_type' @@ -475,6 +523,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -622,10 +674,18 @@ components: If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 role_sid: type: string minLength: 34 @@ -641,6 +701,10 @@ components: resource's User within the [Service](https://www.twilio.com/docs/api/chat/rest/services). This value is often a username or an email address. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 is_online: type: boolean nullable: true @@ -756,10 +820,6 @@ components: - joined - invited - not_participating - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Chat description: This is the public Twilio REST API. @@ -771,7 +831,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Channels/{Sid}: @@ -783,14 +843,28 @@ paths: - sid - unique_name - friendly_name - pathType: instance dependentProperties: - member: '{service_sid: service_sid, channel_sid: sid}' - message: '{service_sid: service_sid, channel_sid: sid}' - invite: '{service_sid: service_sid, channel_sid: sid}' + members: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Members + messages: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Messages + invites: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Invites parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - ChatV1Channel parameters: - name: ServiceSid in: path @@ -815,14 +889,35 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: OK security: - accountSid_authToken: [] operationId: FetchChannel - x-maturity: - - GA delete: description: '' + tags: + - ChatV1Channel parameters: - name: ServiceSid in: path @@ -847,10 +942,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannel - x-maturity: - - GA post: description: '' + tags: + - ChatV1Channel parameters: - name: ServiceSid in: path @@ -875,12 +970,31 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: OK security: - accountSid_authToken: [] operationId: UpdateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -902,6 +1016,13 @@ paths: type: string description: A valid JSON string that contains application-specific data. + examples: + update: + value: + Type: channel + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' /v1/Services/{ServiceSid}/Channels: servers: - url: https://chat.twilio.com @@ -911,14 +1032,28 @@ paths: - sid - unique_name - friendly_name - pathType: list dependentProperties: - member: '{service_sid: service_sid, channel_sid: sid}' - message: '{service_sid: service_sid, channel_sid: sid}' - invite: '{service_sid: service_sid, channel_sid: sid}' + members: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Members + messages: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Messages + invites: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Invites parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - ChatV1Channel parameters: - name: ServiceSid in: path @@ -936,12 +1071,31 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: Created security: - accountSid_authToken: [] operationId: CreateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -968,8 +1122,17 @@ paths: $ref: '#/components/schemas/channel_enum_channel_type' description: 'The visibility of the channel. Can be: `public` or `private` and defaults to `public`.' + examples: + create: + value: + Type: public + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' get: description: '' + tags: + - ChatV1Channel parameters: - name: ServiceSid in: path @@ -1022,34 +1185,73 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + channels: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + readEmpty: + value: + channels: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels description: OK security: - accountSid_authToken: [] operationId: ListChannel - x-maturity: - - GA /v1/Credentials: servers: - url: https://chat.twilio.com @@ -1062,6 +1264,8 @@ paths: pathType: list get: description: '' + tags: + - ChatV1Credential parameters: - name: PageSize in: query @@ -1095,48 +1299,88 @@ paths: items: $ref: '#/components/schemas/chat.v1.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - GA post: description: '' + tags: + - ChatV1Credential responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v1.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1184,6 +1428,10 @@ paths: the Firebase console, found under Settings / Cloud messaging.' required: - Type + examples: + create: + value: + Type: apn /v1/Credentials/{Sid}: servers: - url: https://chat.twilio.com @@ -1196,6 +1444,8 @@ paths: pathType: instance get: description: '' + tags: + - ChatV1Credential parameters: - name: Sid in: path @@ -1213,14 +1463,25 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - GA post: description: '' + tags: + - ChatV1Credential parameters: - name: Sid in: path @@ -1238,12 +1499,21 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1284,8 +1554,14 @@ paths: type: string description: '[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.' + examples: + update: + value: + FriendlyName: Test slow create delete: description: '' + tags: + - ChatV1Credential parameters: - name: Sid in: path @@ -1303,8 +1579,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: servers: - url: https://chat.twilio.com @@ -1314,10 +1588,12 @@ paths: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - ChatV1Invite parameters: - name: ServiceSid in: path @@ -1352,14 +1628,27 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.invite' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchInvite - x-maturity: - - GA delete: description: '' + tags: + - ChatV1Invite parameters: - name: ServiceSid in: path @@ -1394,8 +1683,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInvite - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: servers: - url: https://chat.twilio.com @@ -1405,10 +1692,12 @@ paths: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - ChatV1Invite parameters: - name: ServiceSid in: path @@ -1433,12 +1722,23 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.invite' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInvite - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1462,8 +1762,15 @@ paths: assigned to the new member. required: - Identity + examples: + create: + value: + Identity: identity + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - ChatV1Invite parameters: - name: ServiceSid in: path @@ -1491,6 +1798,17 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: + - identity + readFull: + value: + - identity - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1523,34 +1841,65 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.channel.invite' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + invites: [] + meta: + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + readFull: + value: + invites: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListInvite - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: servers: - url: https://chat.twilio.com @@ -1560,10 +1909,12 @@ paths: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - ChatV1Member parameters: - name: ServiceSid in: path @@ -1599,14 +1950,28 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.member' + examples: + fetch: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMember - x-maturity: - - GA delete: description: '' + tags: + - ChatV1Member parameters: - name: ServiceSid in: path @@ -1641,10 +2006,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMember - x-maturity: - - GA post: description: '' + tags: + - ChatV1Member parameters: - name: ServiceSid in: path @@ -1680,12 +2045,37 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.member' + examples: + updateRoleSid: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: 666 + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1706,6 +2096,13 @@ paths: nullable: true description: The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member has read within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels). + examples: + updateRoleSid: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + LastConsumedMessageIndex: 666 /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members: servers: - url: https://chat.twilio.com @@ -1715,10 +2112,12 @@ paths: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - ChatV1Member parameters: - name: ServiceSid in: path @@ -1743,12 +2142,24 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.member' + examples: + create: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1773,8 +2184,14 @@ paths: on the [Service](https://www.twilio.com/docs/chat/api/services). required: - Identity + examples: + create: + value: + Identity: Twilio get: description: '' + tags: + - ChatV1Member parameters: - name: ServiceSid in: path @@ -1803,6 +2220,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1835,34 +2256,66 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.channel.member' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: + - sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: [] description: OK security: - accountSid_authToken: [] operationId: ListMember - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: servers: - url: https://chat.twilio.com @@ -1873,10 +2326,12 @@ paths: - from - to - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - ChatV1Message parameters: - name: ServiceSid in: path @@ -1914,14 +2369,30 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMessage - x-maturity: - - GA delete: description: '' + tags: + - ChatV1Message parameters: - name: ServiceSid in: path @@ -1960,10 +2431,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessage - x-maturity: - - GA post: description: '' + tags: + - ChatV1Message parameters: - name: ServiceSid in: path @@ -2001,12 +2472,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{"test": "test"}' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + body: Hello + index: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2024,6 +2509,10 @@ paths: type: string description: A valid JSON string that contains application-specific data. + examples: + update: + value: + Body: Hello /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: servers: - url: https://chat.twilio.com @@ -2034,10 +2523,12 @@ paths: - from - to - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - ChatV1Message parameters: - name: ServiceSid in: path @@ -2065,12 +2556,41 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + body: Hello + index: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithAttributes: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2094,8 +2614,18 @@ paths: data. required: - Body + examples: + create: + value: + Body: Hello + createWithAttributes: + value: + Body: Hello + Attributes: '{"test": "test"}' get: description: '' + tags: + - ChatV1Message parameters: - name: ServiceSid in: path @@ -2156,34 +2686,68 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.channel.message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: [] description: OK security: - accountSid_authToken: [] operationId: ListMessage - x-maturity: - - GA /v1/Services/{ServiceSid}/Roles/{Sid}: servers: - url: https://chat.twilio.com @@ -2193,10 +2757,12 @@ paths: - sid - friendly_name - type - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - ChatV1Role parameters: - name: ServiceSid in: path @@ -2224,14 +2790,30 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRole - x-maturity: - - GA delete: description: '' + tags: + - ChatV1Role parameters: - name: ServiceSid in: path @@ -2259,10 +2841,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRole - x-maturity: - - GA post: description: '' + tags: + - ChatV1Role parameters: - name: ServiceSid in: path @@ -2290,12 +2872,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2314,6 +2910,10 @@ paths: the documentation. required: - Permission + examples: + update: + value: + Permission: sendMessage /v1/Services/{ServiceSid}/Roles: servers: - url: https://chat.twilio.com @@ -2323,10 +2923,12 @@ paths: - sid - friendly_name - type - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - ChatV1Role parameters: - name: ServiceSid in: path @@ -2344,12 +2946,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2380,8 +2996,16 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: friendly_name + Type: channel + Permission: sendMessage get: description: '' + tags: + - ChatV1Role parameters: - name: ServiceSid in: path @@ -2425,34 +3049,68 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListRole - x-maturity: - - GA /v1/Services/{Sid}: servers: - url: https://chat.twilio.com @@ -2462,13 +3120,24 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: - channel: '{service_sid: sid}' - role: '{service_sid: sid}' - user: '{service_sid: sid}' + channels: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Channels + roles: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Roles + users: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Users + pathType: instance get: description: '' + tags: + - ChatV1Service parameters: - name: Sid in: path @@ -2486,14 +3155,44 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: {} description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: '' + tags: + - ChatV1Service parameters: - name: Sid in: path @@ -2511,10 +3210,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: '' + tags: + - ChatV1Service parameters: - name: Sid in: path @@ -2532,12 +3231,116 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 500 + user_channels: 600 + links: + channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: + added_to_channel: + enabled: false + template: notifications.added_to_channel.template + invited_to_channel: + enabled: false + template: notifications.invited_to_channel.template + new_message: + enabled: false + template: notifications.new_message.template + removed_from_channel: + enabled: false + template: notifications.removed_from_channel.template + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: + on_channel_add: + format: webhooks.on_channel_add.format + method: webhooks.on_channel_add.method + url: webhooks.on_channel_add.url + on_channel_added: + format: webhooks.on_channel_added.format + method: webhooks.on_channel_added.method + url: webhooks.on_channel_added.url + on_channel_destroy: + format: webhooks.on_channel_destroy.format + method: webhooks.on_channel_destroy.method + url: webhooks.on_channel_destroy.url + on_channel_destroyed: + format: webhooks.on_channel_destroyed.format + method: webhooks.on_channel_destroyed.method + url: webhooks.on_channel_destroyed.url + on_channel_update: + format: webhooks.on_channel_update.format + method: webhooks.on_channel_update.method + url: webhooks.on_channel_update.url + on_channel_updated: + format: webhooks.on_channel_updated.format + method: webhooks.on_channel_updated.method + url: webhooks.on_channel_updated.url + on_member_add: + format: webhooks.on_member_add.format + method: webhooks.on_member_add.method + url: webhooks.on_member_add.url + on_member_added: + format: webhooks.on_member_added.format + method: webhooks.on_member_added.method + url: webhooks.on_member_added.url + on_member_remove: + format: webhooks.on_member_remove.format + method: webhooks.on_member_remove.method + url: webhooks.on_member_remove.url + on_member_removed: + format: webhooks.on_member_removed.format + method: webhooks.on_member_removed.method + url: webhooks.on_member_removed.url + on_message_remove: + format: webhooks.on_message_remove.format + method: webhooks.on_message_remove.method + url: webhooks.on_message_remove.url + on_message_removed: + format: webhooks.on_message_removed.format + method: webhooks.on_message_removed.method + url: webhooks.on_message_removed.url + on_message_send: + format: webhooks.on_message_send.format + method: webhooks.on_message_send.method + url: webhooks.on_message_send.url + on_message_sent: + format: webhooks.on_message_sent.format + method: webhooks.on_message_sent.method + url: webhooks.on_message_sent.url + on_message_update: + format: webhooks.on_message_update.format + method: webhooks.on_message_update.method + url: webhooks.on_message_update.url + on_message_updated: + format: webhooks.on_message_updated.format + method: webhooks.on_message_updated.method + url: webhooks.on_message_updated.url description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2927,6 +3730,80 @@ paths: type: integer description: The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000. + examples: + update: + value: + ConsumptionReportInterval: 100 + DefaultChannelCreatorRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultChannelRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultServiceRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + Notifications.AddedToChannel.Enabled: false + Notifications.AddedToChannel.Template: notifications.added_to_channel.template + Notifications.InvitedToChannel.Enabled: false + Notifications.InvitedToChannel.Template: notifications.invited_to_channel.template + Notifications.NewMessage.Enabled: false + Notifications.NewMessage.Template: notifications.new_message.template + Notifications.RemovedFromChannel.Enabled: false + Notifications.RemovedFromChannel.Template: notifications.removed_from_channel.template + Limits.ChannelMembers: 600 + Limits.UserChannels: 500 + PostWebhookUrl: post_webhook_url + PreWebhookUrl: pre_webhook_url + ReachabilityEnabled: false + ReadStatusEnabled: false + TypingIndicatorTimeout: 100 + WebhookFilters: + - webhook_filters + WebhookMethod: webhook_method + Webhooks.OnChannelAdd.Format: webhooks.on_channel_add.format + Webhooks.OnChannelAdd.Method: webhooks.on_channel_add.method + Webhooks.OnChannelAdd.Url: webhooks.on_channel_add.url + Webhooks.OnChannelAdded.Format: webhooks.on_channel_added.format + Webhooks.OnChannelAdded.Method: webhooks.on_channel_added.method + Webhooks.OnChannelAdded.Url: webhooks.on_channel_added.url + Webhooks.OnChannelDestroy.Format: webhooks.on_channel_destroy.format + Webhooks.OnChannelDestroy.Method: webhooks.on_channel_destroy.method + Webhooks.OnChannelDestroy.Url: webhooks.on_channel_destroy.url + Webhooks.OnChannelDestroyed.Format: webhooks.on_channel_destroyed.format + Webhooks.OnChannelDestroyed.Method: webhooks.on_channel_destroyed.method + Webhooks.OnChannelDestroyed.Url: webhooks.on_channel_destroyed.url + Webhooks.OnChannelUpdate.Format: webhooks.on_channel_update.format + Webhooks.OnChannelUpdate.Method: webhooks.on_channel_update.method + Webhooks.OnChannelUpdate.Url: webhooks.on_channel_update.url + Webhooks.OnChannelUpdated.Format: webhooks.on_channel_updated.format + Webhooks.OnChannelUpdated.Method: webhooks.on_channel_updated.method + Webhooks.OnChannelUpdated.Url: webhooks.on_channel_updated.url + Webhooks.OnMemberAdd.Format: webhooks.on_member_add.format + Webhooks.OnMemberAdd.Method: webhooks.on_member_add.method + Webhooks.OnMemberAdd.Url: webhooks.on_member_add.url + Webhooks.OnMemberAdded.Format: webhooks.on_member_added.format + Webhooks.OnMemberAdded.Method: webhooks.on_member_added.method + Webhooks.OnMemberAdded.Url: webhooks.on_member_added.url + Webhooks.OnMemberRemove.Format: webhooks.on_member_remove.format + Webhooks.OnMemberRemove.Method: webhooks.on_member_remove.method + Webhooks.OnMemberRemove.Url: webhooks.on_member_remove.url + Webhooks.OnMemberRemoved.Format: webhooks.on_member_removed.format + Webhooks.OnMemberRemoved.Method: webhooks.on_member_removed.method + Webhooks.OnMemberRemoved.Url: webhooks.on_member_removed.url + Webhooks.OnMessageRemove.Format: webhooks.on_message_remove.format + Webhooks.OnMessageRemove.Method: webhooks.on_message_remove.method + Webhooks.OnMessageRemove.Url: webhooks.on_message_remove.url + Webhooks.OnMessageRemoved.Format: webhooks.on_message_removed.format + Webhooks.OnMessageRemoved.Method: webhooks.on_message_removed.method + Webhooks.OnMessageRemoved.Url: webhooks.on_message_removed.url + Webhooks.OnMessageSend.Format: webhooks.on_message_send.format + Webhooks.OnMessageSend.Method: webhooks.on_message_send.method + Webhooks.OnMessageSend.Url: webhooks.on_message_send.url + Webhooks.OnMessageSent.Format: webhooks.on_message_sent.format + Webhooks.OnMessageSent.Method: webhooks.on_message_sent.method + Webhooks.OnMessageSent.Url: webhooks.on_message_sent.url + Webhooks.OnMessageUpdate.Format: webhooks.on_message_update.format + Webhooks.OnMessageUpdate.Method: webhooks.on_message_update.method + Webhooks.OnMessageUpdate.Url: webhooks.on_message_update.url + Webhooks.OnMessageUpdated.Format: webhooks.on_message_updated.format + Webhooks.OnMessageUpdated.Method: webhooks.on_message_updated.method + Webhooks.OnMessageUpdated.Url: webhooks.on_message_updated.url /v1/Services: servers: - url: https://chat.twilio.com @@ -2936,25 +3813,64 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: - channel: '{service_sid: sid}' - role: '{service_sid: sid}' - user: '{service_sid: sid}' + channels: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Channels + roles: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Roles + users: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Users + pathType: list post: description: '' + tags: + - ChatV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v1.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: {} description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2968,8 +3884,14 @@ paths: resource. It can be up to 64 characters long. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name get: description: '' + tags: + - ChatV1Service parameters: - name: PageSize in: query @@ -3003,34 +3925,160 @@ paths: items: $ref: '#/components/schemas/chat.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://chat.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v1/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://chat.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v1/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + user_channels: 250 + channel_members: 100 + actions_per_second: 30 + links: + channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: + added_to_channel: + enabled: false + template: notifications.added_to_channel.template + invited_to_channel: + enabled: false + template: notifications.invited_to_channel.template + log_enabled: true + new_message: + enabled: false + template: notifications.new_message.template + removed_from_channel: + enabled: false + template: notifications.removed_from_channel.template + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: + on_channel_add: + format: webhooks.on_channel_add.format + method: webhooks.on_channel_add.method + url: webhooks.on_channel_add.url + on_channel_added: + format: webhooks.on_channel_added.format + method: webhooks.on_channel_added.method + url: webhooks.on_channel_added.url + on_channel_destroy: + format: webhooks.on_channel_destroy.format + method: webhooks.on_channel_destroy.method + url: webhooks.on_channel_destroy.url + on_channel_destroyed: + format: webhooks.on_channel_destroyed.format + method: webhooks.on_channel_destroyed.method + url: webhooks.on_channel_destroyed.url + on_channel_update: + format: webhooks.on_channel_update.format + method: webhooks.on_channel_update.method + url: webhooks.on_channel_update.url + on_channel_updated: + format: webhooks.on_channel_updated.format + method: webhooks.on_channel_updated.method + url: webhooks.on_channel_updated.url + on_member_add: + format: webhooks.on_member_add.format + method: webhooks.on_member_add.method + url: webhooks.on_member_add.url + on_member_added: + format: webhooks.on_member_added.format + method: webhooks.on_member_added.method + url: webhooks.on_member_added.url + on_member_remove: + format: webhooks.on_member_remove.format + method: webhooks.on_member_remove.method + url: webhooks.on_member_remove.url + on_member_removed: + format: webhooks.on_member_removed.format + method: webhooks.on_member_removed.method + url: webhooks.on_member_removed.url + on_message_remove: + format: webhooks.on_message_remove.format + method: webhooks.on_message_remove.method + url: webhooks.on_message_remove.url + on_message_removed: + format: webhooks.on_message_removed.format + method: webhooks.on_message_removed.method + url: webhooks.on_message_removed.url + on_message_send: + format: webhooks.on_message_send.format + method: webhooks.on_message_send.method + url: webhooks.on_message_send.url + on_message_sent: + format: webhooks.on_message_sent.format + method: webhooks.on_message_sent.method + url: webhooks.on_message_sent.url + on_message_update: + format: webhooks.on_message_update.format + method: webhooks.on_message_update.method + url: webhooks.on_message_update.url + on_message_updated: + format: webhooks.on_message_updated.format + method: webhooks.on_message_updated.method + url: webhooks.on_message_updated.url description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v1/Services/{ServiceSid}/Users/{Sid}: servers: - url: https://chat.twilio.com @@ -3040,12 +4088,18 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: - user_channel: '{service_sid: service_sid, user_sid: sid}' + user_channels: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v1/Services/{service_sid}/Users/{user_sid}/Channels parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - ChatV1User parameters: - name: ServiceSid in: path @@ -3070,14 +4124,32 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - GA delete: description: '' + tags: + - ChatV1User parameters: - name: ServiceSid in: path @@ -3102,10 +4174,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUser - x-maturity: - - GA post: description: '' + tags: + - ChatV1User parameters: - name: ServiceSid in: path @@ -3130,12 +4202,28 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3158,6 +4246,12 @@ paths: type: string description: A descriptive string that you create to describe the resource. It is often used for display purposes. + examples: + update: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name /v1/Services/{ServiceSid}/Users: servers: - url: https://chat.twilio.com @@ -3167,12 +4261,18 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: - user_channel: '{service_sid: service_sid, user_sid: sid}' + user_channels: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v1/Services/{service_sid}/Users/{user_sid}/Channels parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - ChatV1User parameters: - name: ServiceSid in: path @@ -3190,12 +4290,28 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3227,8 +4343,17 @@ paths: new resource. This value is often used for display purposes. required: - Identity + examples: + create: + value: + Identity: jing + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name get: description: '' + tags: + - ChatV1User parameters: - name: ServiceSid in: path @@ -3272,47 +4397,85 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + joined_channels_count: 0 + links: + user_channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: [] description: OK security: - accountSid_authToken: [] operationId: ListUser - x-maturity: - - GA /v1/Services/{ServiceSid}/Users/{UserSid}/Channels: servers: - url: https://chat.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - channel_sid - status - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: list get: description: List all Channels for a given User. + tags: + - ChatV1UserChannel parameters: - name: ServiceSid in: path @@ -3363,36 +4526,76 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.user.user_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + links: + channel: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: [] description: OK security: - accountSid_authToken: [] operationId: ListUserChannel - x-maturity: - - GA servers: - url: https://chat.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: ChatV1Channel +- name: ChatV1Credential +- name: ChatV1Invite +- name: ChatV1Member +- name: ChatV1Message +- name: ChatV1Role +- name: ChatV1Service +- name: ChatV1User +- name: ChatV1UserChannel +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_chat_v2.yaml b/spec/yaml/twilio_chat_v2.yaml index f1878bc1..ea13ed05 100644 --- a/spec/yaml/twilio_chat_v2.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: chat.v2.service.binding: type: object @@ -43,6 +47,10 @@ components: nullable: true description: The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity: type: string nullable: true @@ -51,6 +59,10 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 credential_sid: type: string minLength: 34 @@ -120,17 +132,29 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string $ref: '#/components/schemas/channel_enum_channel_type' @@ -153,6 +177,10 @@ components: nullable: true description: The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 members_count: type: integer nullable: true @@ -279,6 +307,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/credential_enum_push_service' @@ -355,6 +387,10 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -426,6 +462,10 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -469,6 +509,10 @@ components: nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 member_enum_webhook_enabled_type: type: string enum: @@ -497,6 +541,10 @@ components: nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 service_sid: type: string minLength: 34 @@ -538,6 +586,10 @@ components: nullable: true description: The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable. + x-twilio: + pii: + handling: standard + deleteSla: 30 was_edited: type: boolean nullable: true @@ -547,10 +599,18 @@ components: nullable: true description: The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. The default value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 body: type: string nullable: true description: The content of the message. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 index: type: integer nullable: true @@ -568,6 +628,10 @@ components: the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object''s file size in bytes. If the Message has no media, this value is `null`.' + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -613,6 +677,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/role_enum_role_type' @@ -670,6 +738,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -833,10 +905,18 @@ components: nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 role_sid: type: string minLength: 34 @@ -853,6 +933,10 @@ components: This value is often a username or an email address, and is case-sensitive. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 is_online: type: boolean nullable: true @@ -949,6 +1033,10 @@ components: nullable: true description: The unique endpoint identifier for the User Binding. The format of the value depends on the `binding_type`. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity: type: string nullable: true @@ -957,6 +1045,10 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 user_sid: type: string minLength: 34 @@ -1097,10 +1189,6 @@ components: enum: - 'true' - 'false' - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Chat description: This is the public Twilio REST API. @@ -1112,7 +1200,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/Bindings: @@ -1124,10 +1212,12 @@ paths: - sid - endpoint - identity - pathType: list parent: /Services/{Sid} + pathType: list get: description: '' + tags: + - ChatV2Binding parameters: - name: ServiceSid in: path @@ -1158,6 +1248,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1190,34 +1284,72 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: + - sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: [] description: OK security: - accountSid_authToken: [] operationId: ListBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Bindings/{Sid}: servers: - url: https://chat.twilio.com @@ -1227,10 +1359,12 @@ paths: - sid - endpoint - identity - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - ChatV2Binding parameters: - name: ServiceSid in: path @@ -1257,14 +1391,34 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.binding' + examples: + fetch: + value: + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser description: OK security: - accountSid_authToken: [] operationId: FetchBinding - x-maturity: - - GA delete: description: '' + tags: + - ChatV2Binding parameters: - name: ServiceSid in: path @@ -1291,8 +1445,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{Sid}: servers: - url: https://chat.twilio.com @@ -1302,15 +1454,33 @@ paths: - sid - unique_name - friendly_name - pathType: instance dependentProperties: - member: '{service_sid: service_sid, channel_sid: sid}' - message: '{service_sid: service_sid, channel_sid: sid}' - invite: '{service_sid: service_sid, channel_sid: sid}' - webhook: '{service_sid: service_sid, channel_sid: sid}' + members: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Members + messages: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Messages + invites: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Invites + webhooks: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - ChatV2Channel parameters: - name: ServiceSid in: path @@ -1335,14 +1505,36 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: OK security: - accountSid_authToken: [] operationId: FetchChannel - x-maturity: - - GA delete: description: '' + tags: + - ChatV2Channel parameters: - name: ServiceSid in: path @@ -1373,10 +1565,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannel - x-maturity: - - GA post: description: '' + tags: + - ChatV2Channel parameters: - name: ServiceSid in: path @@ -1407,12 +1599,32 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + created_by: username + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: OK security: - accountSid_authToken: [] operationId: UpdateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1451,6 +1663,16 @@ paths: type: string description: 'The `identity` of the User that created the channel. Default is: `system`.' + examples: + update: + value: + Type: channel + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + CreatedBy: username /v2/Services/{ServiceSid}/Channels: servers: - url: https://chat.twilio.com @@ -1460,15 +1682,33 @@ paths: - sid - unique_name - friendly_name - pathType: list dependentProperties: - member: '{service_sid: service_sid, channel_sid: sid}' - message: '{service_sid: service_sid, channel_sid: sid}' - invite: '{service_sid: service_sid, channel_sid: sid}' - webhook: '{service_sid: service_sid, channel_sid: sid}' + members: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Members + messages: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Messages + invites: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Invites + webhooks: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - ChatV2Channel parameters: - name: ServiceSid in: path @@ -1492,12 +1732,32 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + created_by: username + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: Created security: - accountSid_authToken: [] operationId: CreateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1544,8 +1804,20 @@ paths: type: string description: 'The `identity` of the User that created the channel. Default is: `system`.' + examples: + create: + value: + Type: public + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + CreatedBy: username get: description: '' + tags: + - ChatV2Channel parameters: - name: ServiceSid in: path @@ -1598,34 +1870,74 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + channels: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + readEmpty: + value: + channels: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels description: OK security: - accountSid_authToken: [] operationId: ListChannel - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks: servers: - url: https://chat.twilio.com @@ -1634,10 +1946,12 @@ paths: defaultOutputProperties: - sid - configuration - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list get: description: '' + tags: + - ChatV2Webhook parameters: - name: ServiceSid in: path @@ -1689,36 +2003,99 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + next_page_url: null + key: webhooks + webhooks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: webhook + configuration: + url: dummy + method: GET + filters: + - onMessageSent + - onChannelDestroyed + retry_count: 2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: trigger + configuration: + url: dummy + method: POST + filters: + - keyword1 + - keyword2 + retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + next_page_url: null + key: webhooks + webhooks: [] description: OK security: - accountSid_authToken: [] operationId: ListChannelWebhook - x-maturity: - - GA post: description: '' + tags: + - ChatV2Webhook parameters: - name: ServiceSid in: path @@ -1744,12 +2121,28 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: webhook + configuration: + url: dummy + method: GET + filters: + - onMessageSent + - onChannelDestroyed + retry_count: 2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateChannelWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1802,6 +2195,16 @@ paths: the default is 0. required: - Type + examples: + create: + value: + Type: webhook + Configuration.Url: dummy + Configuration.Method: GET + Configuration.Filters: + - onMessageSent + - onChannelDestroyed + Configuration.RetryCount: 2 /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid}: servers: - url: https://chat.twilio.com @@ -1810,10 +2213,12 @@ paths: defaultOutputProperties: - sid - configuration - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - ChatV2Webhook parameters: - name: ServiceSid in: path @@ -1848,14 +2253,27 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchChannelWebhook - x-maturity: - - GA post: description: '' + tags: + - ChatV2Webhook parameters: - name: ServiceSid in: path @@ -1890,12 +2308,28 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: trigger + configuration: + url: dummy + method: POST + filters: + - keyword1 + - keyword2 + retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateChannelWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1941,8 +2375,19 @@ paths: description: The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0. + examples: + update: + value: + Configuration.Url: dummy + Configuration.Method: POST + Configuration.Triggers: + - keyword1 + - keyword2 + Configuration.RetryCount: 5 delete: description: '' + tags: + - ChatV2Webhook parameters: - name: ServiceSid in: path @@ -1977,8 +2422,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannelWebhook - x-maturity: - - GA /v2/Credentials: servers: - url: https://chat.twilio.com @@ -1991,6 +2434,8 @@ paths: pathType: list get: description: '' + tags: + - ChatV2Credential parameters: - name: PageSize in: query @@ -2024,48 +2469,88 @@ paths: items: $ref: '#/components/schemas/chat.v2.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - GA post: description: '' + tags: + - ChatV2Credential responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v2.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2113,6 +2598,10 @@ paths: the Firebase console, found under Settings / Cloud messaging.' required: - Type + examples: + create: + value: + Type: apn /v2/Credentials/{Sid}: servers: - url: https://chat.twilio.com @@ -2125,6 +2614,8 @@ paths: pathType: instance get: description: '' + tags: + - ChatV2Credential parameters: - name: Sid in: path @@ -2141,14 +2632,25 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - GA post: description: '' + tags: + - ChatV2Credential parameters: - name: Sid in: path @@ -2165,12 +2667,21 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2211,8 +2722,14 @@ paths: type: string description: '[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.' + examples: + update: + value: + FriendlyName: Test slow create delete: description: '' + tags: + - ChatV2Credential parameters: - name: Sid in: path @@ -2229,8 +2746,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: servers: - url: https://chat.twilio.com @@ -2240,10 +2755,12 @@ paths: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - ChatV2Invite parameters: - name: ServiceSid in: path @@ -2278,14 +2795,27 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.invite' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchInvite - x-maturity: - - GA delete: description: '' + tags: + - ChatV2Invite parameters: - name: ServiceSid in: path @@ -2320,8 +2850,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInvite - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: servers: - url: https://chat.twilio.com @@ -2331,10 +2859,12 @@ paths: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - ChatV2Invite parameters: - name: ServiceSid in: path @@ -2360,12 +2890,23 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.invite' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInvite - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2389,8 +2930,15 @@ paths: assigned to the new member. required: - Identity + examples: + create: + value: + Identity: identity + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - ChatV2Invite parameters: - name: ServiceSid in: path @@ -2419,6 +2967,17 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: + - identity + readFull: + value: + - identity - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2451,34 +3010,65 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.channel.invite' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + invites: [] + meta: + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + readFull: + value: + invites: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListInvite - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: servers: - url: https://chat.twilio.com @@ -2488,10 +3078,12 @@ paths: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - ChatV2Member parameters: - name: ServiceSid in: path @@ -2524,14 +3116,29 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.member' + examples: + fetch: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMember - x-maturity: - - GA delete: description: '' + tags: + - ChatV2Member parameters: - name: ServiceSid in: path @@ -2570,10 +3177,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMember - x-maturity: - - GA post: description: '' + tags: + - ChatV2Member parameters: - name: ServiceSid in: path @@ -2612,12 +3219,25 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.member' + examples: + updateRoleSid: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: 20 + last_consumption_timestamp: '2016-03-24T21:05:52Z' + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + attributes: '{}' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2661,6 +3281,15 @@ paths: type: string description: A valid JSON string that contains application-specific data. + examples: + updateRoleSid: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2016-03-24T21:05:50Z' + DateUpdated: '2016-03-24T21:05:51Z' + LastConsumedMessageIndex: 20 + LastConsumptionTimestamp: '2016-03-24T21:05:52Z' + Attributes: '{}' /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members: servers: - url: https://chat.twilio.com @@ -2670,10 +3299,12 @@ paths: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - ChatV2Member parameters: - name: ServiceSid in: path @@ -2705,12 +3336,25 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.member' + examples: + create: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2768,8 +3412,15 @@ paths: data. required: - Identity + examples: + create: + value: + Identity: Twilio + Attributes: '{}' get: description: '' + tags: + - ChatV2Member parameters: - name: ServiceSid in: path @@ -2798,6 +3449,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2830,34 +3485,67 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.channel.member' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: + - sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: [] description: OK security: - accountSid_authToken: [] operationId: ListMember - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: servers: - url: https://chat.twilio.com @@ -2868,10 +3556,12 @@ paths: - from - to - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - ChatV2Message parameters: - name: ServiceSid in: path @@ -2906,14 +3596,55 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: text + media: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchMedia: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: media + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMessage - x-maturity: - - GA delete: description: '' + tags: + - ChatV2Message parameters: - name: ServiceSid in: path @@ -2954,10 +3685,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessage - x-maturity: - - GA post: description: '' + tags: + - ChatV2Message parameters: - name: ServiceSid in: path @@ -2998,12 +3729,29 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "foo": "bar" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + last_updated_by: username + was_edited: true + from: fromUser + body: Hello + index: 0 + type: text + media: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3041,6 +3789,15 @@ paths: type: string description: The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. + examples: + update: + value: + Body: Hello + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + LastUpdatedBy: username + From: fromUser /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: servers: - url: https://chat.twilio.com @@ -3051,10 +3808,12 @@ paths: - from - to - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - ChatV2Message parameters: - name: ServiceSid in: path @@ -3086,12 +3845,69 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: system + was_edited: false + from: system + body: Hello + index: 0 + type: text + media: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithAll: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + last_updated_by: username + was_edited: true + from: system + attributes: '{"test": "test"}' + body: Hello + index: 0 + type: text + media: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createMedia: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: system + was_edited: false + from: system + body: Hello + index: 0 + type: text + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3136,8 +3952,24 @@ paths: pattern: ^ME[0-9a-fA-F]{32}$ description: The SID of the [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new Message. + examples: + create: + value: + Body: Hello + createWithAll: + value: + Body: Hello + Attributes: '{"test": "test"}' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + LastUpdatedBy: username + createMedia: + value: + MediaSid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - ChatV2Message parameters: - name: ServiceSid in: path @@ -3196,34 +4028,91 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.channel.message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: text + media: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: media + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: [] description: OK security: - accountSid_authToken: [] operationId: ListMessage - x-maturity: - - GA /v2/Services/{ServiceSid}/Roles/{Sid}: servers: - url: https://chat.twilio.com @@ -3233,10 +4122,12 @@ paths: - sid - friendly_name - type - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - ChatV2Role parameters: - name: ServiceSid in: path @@ -3263,14 +4154,30 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRole - x-maturity: - - GA delete: description: '' + tags: + - ChatV2Role parameters: - name: ServiceSid in: path @@ -3297,10 +4204,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRole - x-maturity: - - GA post: description: '' + tags: + - ChatV2Role parameters: - name: ServiceSid in: path @@ -3327,12 +4234,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3353,6 +4274,10 @@ paths: this parameter depend on the role's `type`. required: - Permission + examples: + update: + value: + Permission: sendMessage /v2/Services/{ServiceSid}/Roles: servers: - url: https://chat.twilio.com @@ -3362,10 +4287,12 @@ paths: - sid - friendly_name - type - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - ChatV2Role parameters: - name: ServiceSid in: path @@ -3383,12 +4310,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3418,8 +4359,16 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: friendly_name + Type: channel + Permission: sendMessage get: description: '' + tags: + - ChatV2Role parameters: - name: ServiceSid in: path @@ -3463,34 +4412,68 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListRole - x-maturity: - - GA /v2/Services/{Sid}: servers: - url: https://chat.twilio.com @@ -3500,14 +4483,28 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: - channel: '{service_sid: sid}' - role: '{service_sid: sid}' - user: '{service_sid: sid}' - binding: '{service_sid: sid}' + channels: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Channels + roles: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Roles + users: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Users + bindings: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Bindings + pathType: instance get: description: '' + tags: + - ChatV2Service parameters: - name: Sid in: path @@ -3524,14 +4521,49 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: '' + tags: + - ChatV2Service parameters: - name: Sid in: path @@ -3548,10 +4580,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: '' + tags: + - ChatV2Service parameters: - name: Sid in: path @@ -3568,12 +4600,59 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 500 + user_channels: 600 + links: + channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: + log_enabled: true + added_to_channel: + enabled: false + template: notifications.added_to_channel.template + invited_to_channel: + enabled: false + template: notifications.invited_to_channel.template + new_message: + enabled: false + template: notifications.new_message.template + badge_count_enabled: true + removed_from_channel: + enabled: false + template: notifications.removed_from_channel.template + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: new media compatibility message description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3745,6 +4824,37 @@ paths: Notifications.LogEnabled: type: boolean description: Whether to log notifications. The default is `false`. + examples: + update: + value: + ConsumptionReportInterval: 100 + DefaultChannelCreatorRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultChannelRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultServiceRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + Notifications.AddedToChannel.Enabled: false + Notifications.AddedToChannel.Template: notifications.added_to_channel.template + Notifications.InvitedToChannel.Enabled: false + Notifications.InvitedToChannel.Template: notifications.invited_to_channel.template + Notifications.NewMessage.Enabled: false + Notifications.NewMessage.Template: notifications.new_message.template + Notifications.NewMessage.BadgeCountEnabled: true + Notifications.RemovedFromChannel.Enabled: false + Notifications.RemovedFromChannel.Template: notifications.removed_from_channel.template + Notifications.LogEnabled: true + Limits.ChannelMembers: 600 + Limits.UserChannels: 500 + PostWebhookUrl: post_webhook_url + PreWebhookUrl: pre_webhook_url + PreWebhookRetryCount: 2 + PostWebhookRetryCount: 3 + ReachabilityEnabled: false + ReadStatusEnabled: false + TypingIndicatorTimeout: 100 + WebhookFilters: + - webhook_filters + WebhookMethod: webhook_method + Media.CompatibilityMessage: new media compatibility message /v2/Services: servers: - url: https://chat.twilio.com @@ -3754,26 +4864,73 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: - channel: '{service_sid: sid}' - role: '{service_sid: sid}' - user: '{service_sid: sid}' - binding: '{service_sid: sid}' + channels: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Channels + roles: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Roles + users: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Users + bindings: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Bindings + pathType: list post: description: '' + tags: + - ChatV2Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3787,8 +4944,14 @@ paths: new resource. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name get: description: '' + tags: + - ChatV2Service parameters: - name: PageSize in: query @@ -3822,34 +4985,87 @@ paths: items: $ref: '#/components/schemas/chat.v2.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://chat.twilio.com/v2/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v2/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://chat.twilio.com/v2/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v2/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{Sid}: servers: - url: https://chat.twilio.com @@ -3860,13 +5076,23 @@ paths: - friendly_name - identity - date_created - pathType: instance dependentProperties: - user_channel: '{service_sid: service_sid, user_sid: sid}' - user_binding: '{service_sid: service_sid, user_sid: sid}' + user_channels: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Channels + user_bindings: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Bindings parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - ChatV2User parameters: - name: ServiceSid in: path @@ -3891,14 +5117,33 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - GA delete: description: '' + tags: + - ChatV2User parameters: - name: ServiceSid in: path @@ -3923,10 +5168,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUser - x-maturity: - - GA post: description: '' + tags: + - ChatV2User parameters: - name: ServiceSid in: path @@ -3957,12 +5202,29 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3985,6 +5247,12 @@ paths: type: string description: A descriptive string that you create to describe the resource. It is often used for display purposes. + examples: + update: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name /v2/Services/{ServiceSid}/Users: servers: - url: https://chat.twilio.com @@ -3995,13 +5263,23 @@ paths: - friendly_name - identity - date_created - pathType: list dependentProperties: - user_channel: '{service_sid: service_sid, user_sid: sid}' - user_binding: '{service_sid: service_sid, user_sid: sid}' + user_channels: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Channels + user_bindings: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Bindings parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - ChatV2User parameters: - name: ServiceSid in: path @@ -4025,12 +5303,29 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4062,8 +5357,17 @@ paths: new resource. This value is often used for display purposes. required: - Identity + examples: + create: + value: + Identity: jing + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name get: description: '' + tags: + - ChatV2User parameters: - name: ServiceSid in: path @@ -4107,34 +5411,71 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + joined_channels_count: 0 + links: + user_channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: [] description: OK security: - accountSid_authToken: [] operationId: ListUser - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings: servers: - url: https://chat.twilio.com @@ -4145,11 +5486,13 @@ paths: - endpoint - identity - binding_type - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_bindings + pathType: list get: description: '' + tags: + - ChatV2UserBinding parameters: - name: ServiceSid in: path @@ -4211,34 +5554,71 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.user.user_binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: + - sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: [] description: OK security: - accountSid_authToken: [] operationId: ListUserBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}: servers: - url: https://chat.twilio.com @@ -4249,11 +5629,13 @@ paths: - endpoint - identity - binding_type - pathType: instance parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_bindings + pathType: instance get: description: '' + tags: + - ChatV2UserBinding parameters: - name: ServiceSid in: path @@ -4288,14 +5670,33 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user.user_binding' + examples: + fetch: + value: + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUserBinding - x-maturity: - - GA delete: description: '' + tags: + - ChatV2UserBinding parameters: - name: ServiceSid in: path @@ -4330,8 +5731,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Channels: servers: - url: https://chat.twilio.com @@ -4340,11 +5739,13 @@ paths: defaultOutputProperties: - channel_sid - status - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: list get: description: List all Channels for a given User. + tags: + - ChatV2UserChannel parameters: - name: ServiceSid in: path @@ -4396,34 +5797,68 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.user.user_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: default + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: [] description: OK security: - accountSid_authToken: [] operationId: ListUserChannel - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}: servers: - url: https://chat.twilio.com @@ -4432,11 +5867,13 @@ paths: defaultOutputProperties: - channel_sid - status - pathType: instance parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: instance get: description: '' + tags: + - ChatV2UserChannel parameters: - name: ServiceSid in: path @@ -4470,14 +5907,30 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user.user_channel' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: default + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUserChannel - x-maturity: - - GA delete: description: Removes User from selected Channel. + tags: + - ChatV2UserChannel parameters: - name: ServiceSid in: path @@ -4515,10 +5968,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserChannel - x-maturity: - - GA post: description: '' + tags: + - ChatV2UserChannel parameters: - name: ServiceSid in: path @@ -4552,12 +6005,41 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user.user_channel' + examples: + updateNotificationLevel: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: muted + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 10 + unread_messages_count: 5 + notification_level: muted + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUserChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4582,8 +6064,27 @@ paths: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). + examples: + updateNotificationLevel: + value: + NotificationLevel: muted + updateLastConsumedMessageIndex: + value: + LastConsumedMessageIndex: 10 servers: - url: https://chat.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: ChatV2Binding +- name: ChatV2Channel +- name: ChatV2Credential +- name: ChatV2Invite +- name: ChatV2Member +- name: ChatV2Message +- name: ChatV2Role +- name: ChatV2Service +- name: ChatV2User +- name: ChatV2UserBinding +- name: ChatV2UserChannel +- name: ChatV2Webhook +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_chat_v3.yaml b/spec/yaml/twilio_chat_v3.yaml index 16ba1958..3a6ffdd1 100644 --- a/spec/yaml/twilio_chat_v3.yaml +++ b/spec/yaml/twilio_chat_v3.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: chat.v3.channel: type: object @@ -30,17 +34,29 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string $ref: '#/components/schemas/channel_enum_channel_type' @@ -63,6 +79,10 @@ components: nullable: true description: The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 members_count: type: integer nullable: true @@ -77,7 +97,7 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to. url: type: string @@ -94,10 +114,6 @@ components: enum: - 'true' - 'false' - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Chat description: This is the public Twilio REST API. @@ -109,7 +125,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v3/Services/{ServiceSid}/Channels/{Sid}: @@ -125,6 +141,8 @@ paths: pathType: instance post: description: Update a specific Channel. + tags: + - ChatV3Channel parameters: - name: ServiceSid in: path @@ -153,12 +171,27 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v3.channel' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + created_by: username + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v3/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -176,8 +209,13 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + 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 /v3/Services/{ServiceSid}/Channels: servers: - url: https://chat.twilio.com @@ -191,6 +229,7 @@ paths: pathType: list servers: - url: https://chat.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: ChatV3Channel +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_content_sdk.yaml b/spec/yaml/twilio_content_sdk.yaml new file mode 100644 index 00000000..f2895ded --- /dev/null +++ b/spec/yaml/twilio_content_sdk.yaml @@ -0,0 +1,1351 @@ +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/{Sid}/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: Sid + 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/{Sid}/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: Sid + 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 diff --git a/spec/yaml/twilio_content_v1.yaml b/spec/yaml/twilio_content_v1.yaml index 17a842a8..da30a48b 100644 --- a/spec/yaml/twilio_content_v1.yaml +++ b/spec/yaml/twilio_content_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: content.v1.content.approval_fetch: type: object @@ -76,7 +80,7 @@ components: 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) + description: The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource. url: type: string @@ -136,7 +140,7 @@ components: 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) + 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 @@ -189,7 +193,7 @@ components: 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) + 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 @@ -207,10 +211,6 @@ components: format: uri nullable: true description: The URL of the resource, relative to `https://content.twilio.com`. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Content description: This is the public Twilio REST API. @@ -222,7 +222,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Content/{Sid}/ApprovalRequests: @@ -235,12 +235,14 @@ paths: - sid - account_sid - whatsapp - pathType: instance parent: /Content/{Sid} mountName: approval_fetch + pathType: instance get: description: Fetch a Content resource's approval status by its unique Content Sid + tags: + - ContentV1ApprovalFetch parameters: - name: Sid in: path @@ -258,12 +260,24 @@ paths: application/json: schema: $ref: '#/components/schemas/content.v1.content.approval_fetch' + examples: + getApproval: + value: + sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + whatsapp: + type: whatsapp + name: tree_fiddy + category: ACCOUNT_UPDATE + content_type: twilio/location + status: approved + rejection_reason: '' + allow_category_change: true + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests description: OK security: - accountSid_authToken: [] operationId: FetchApprovalFetch - x-maturity: - - Preview /v1/Content/{Sid}: servers: - url: https://content.twilio.com @@ -278,13 +292,21 @@ paths: - language - variables - types - pathType: instance dependentProperties: - content/v1/approval_create: '{sid: sid}' - approval_fetch: '{sid: sid}' + 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: instance get: description: Fetch a Content resource by its unique Content Sid + tags: + - ContentV1Content parameters: - name: Sid in: path @@ -302,14 +324,36 @@ paths: application/json: schema: $ref: '#/components/schemas/content.v1.content' + examples: + fetch: + value: + sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests description: OK security: - accountSid_authToken: [] operationId: FetchContent - x-maturity: - - Preview delete: description: Deletes a Content resource + tags: + - ContentV1Content parameters: - name: Sid in: path @@ -327,8 +371,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteContent - x-maturity: - - Preview /v1/Content: servers: - url: https://content.twilio.com @@ -343,14 +385,22 @@ paths: - language - variables - types - pathType: list dependentProperties: - content/v1/approval_create: '{sid: sid}' - approval_fetch: '{sid: sid}' + 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: + - ContentV1Content parameters: - name: PageSize in: query @@ -384,34 +434,112 @@ paths: items: $ref: '#/components/schemas/content.v1.content' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + contents: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://content.twilio.com/v1/Content?PageSize=10&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/Content?PageSize=10&Page=0 + next_page_url: null + key: contents + readResults: + value: + contents: + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Anotha content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Third content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + meta: + page: 0 + page_size: 20 + first_page_url: https://content.twilio.com/v1/Content?PageSize=20&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/Content?PageSize=20&Page=0 + next_page_url: null + key: contents description: OK security: - accountSid_authToken: [] operationId: ListContent - x-maturity: - - Preview /v1/ContentAndApprovals: servers: - url: https://content.twilio.com @@ -428,11 +556,13 @@ paths: - variables - types - approval_requests - pathType: list className: content_and_approvals + pathType: list get: description: Retrieve a list of Contents with approval statuses belonging to the account used to make the request + tags: + - ContentV1ContentAndApprovals parameters: - name: PageSize in: query @@ -466,34 +596,127 @@ paths: items: $ref: '#/components/schemas/content.v1.content_and_approvals' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + contents: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0 + previous_page_url: null + next_page_url: null + url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0 + key: contents + readResults: + value: + contents: + - date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + approval_requests: + name: '' + category: '' + content_type: '' + status: unsubmitted + rejection_reason: '' + allow_category_change: true + - language: en + date_updated: '2023-01-13T23:33:46Z' + variables: + '1': name + '2': typedocument + friendly_name: Media Test + account_sid: AC25c0d4b9093547216c460212e24e77ee + sid: HX5fcd48a417c1cb59da349ad6d5da4607 + date_created: '2023-01-13T23:33:46Z' + types: + twilio/media: + body: '{{1}}, Congratulations {{2}}! For additional assistance, + please contact us at hello@twilio.com' + media: + - https://example.com/template + approval_requests: + category: TRANSACTIONAL + status: approved + rejection_reason: '' + name: Media Test + content_type: twilio/media + allow_category_change: false + - language: en + date_updated: '2023-01-18T02:46:35Z' + variables: + '1': name + '2': type_video + '3': small.mp4 + friendly_name: Video Highlights + account_sid: AC25c0d4b9093547216c460212e24e77ee + sid: HX15c711fcc6d9ea5268d7ab77938a20ff + date_created: '2023-01-18T02:46:35Z' + types: + twilio/media: + body: Hi there, {{1}}, we have received your request to + upload {{2}}, and should be uploaded shortly. + media: + - http://example.com/highlights/{{3}} + approval_requests: + category: TRANSACTIONAL + status: rejected + rejection_reason: 'INVALID_FORMAT. Facebook is not able to + create template with templateName=Video Highlights_hx15c711fcc6d9ea5268d7ab77938a20ff + due to the following error: Invalid parameter. More Details: + Message template ''components'' param is missing expected + field(s). component of type HEADER is missing expected field(s) + (example)' + name: Video Highlights + content_type: twilio/media + allow_category_change: true + meta: + page: 0 + page_size: 20 + first_page_url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0 + url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0 + previous_page_url: null + next_page_url: null + key: contents description: OK security: - accountSid_authToken: [] operationId: ListContentAndApprovals - x-maturity: - - Preview /v1/LegacyContent: servers: - url: https://content.twilio.com @@ -510,11 +733,13 @@ paths: - types - legacy_template_name - legacy_body - pathType: list mountName: legacy_contents + pathType: list get: description: Retrieve a list of Legacy Contents belonging to the account used to make the request + tags: + - ContentV1LegacyContent parameters: - name: PageSize in: query @@ -548,38 +773,116 @@ paths: items: $ref: '#/components/schemas/content.v1.legacy_content' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + contents: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0 + next_page_url: null + key: contents + readResults: + value: + contents: + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + legacy_template_name: legacy_template_1 + legacy_body: a body + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/LegacyContent + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Anotha content + language: en + variables: + name: foo + legacy_template_name: legacy_template_2 + legacy_body: another body + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/LegacyContent + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Third content + language: en + variables: + name: foo + legacy_template_name: legacy_template_3 + legacy_body: a third body + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/LegacyContent + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + meta: + page: 0 + page_size: 20 + first_page_url: https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0 + next_page_url: null + key: contents description: OK security: - accountSid_authToken: [] operationId: ListLegacyContent - x-maturity: - - Preview servers: - url: https://content.twilio.com -x-maturity: -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. +tags: +- name: ContentV1ApprovalCreate +- name: ContentV1ApprovalFetch +- name: ContentV1Content +- name: ContentV1ContentAndApprovals +- name: ContentV1LegacyContent +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_conversations_v1.yaml b/spec/yaml/twilio_conversations_v1.yaml index 51c22be3..9666b7da 100644 --- a/spec/yaml/twilio_conversations_v1.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: conversations.v1.configuration: type: object @@ -25,7 +29,7 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the default [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) used when creating a conversation. default_inactive_timer: type: string @@ -75,6 +79,10 @@ components: nullable: true description: The unique address to be configured. The address can be a whatsapp address or phone number + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true @@ -110,6 +118,7 @@ components: - whatsapp - messenger - gbm + - email configuration_address_enum_auto_creation_type: type: string enum: @@ -202,7 +211,7 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. sid: type: string @@ -216,18 +225,30 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 state: type: string $ref: '#/components/schemas/conversation_enum_state' @@ -310,10 +331,18 @@ components: nullable: true description: The channel specific identifier of the message's author. Defaults to `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 body: type: string nullable: true description: The content of the message, can be up to 1,600 characters long. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 media: type: array items: {} @@ -323,12 +352,20 @@ components: with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object''s file size in bytes. If the Message has no media, this value is `null`.' + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 participant_sid: type: string minLength: 34 @@ -369,7 +406,7 @@ components: maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template. conversation_message_enum_order_type: type: string @@ -499,17 +536,29 @@ components: 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. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. + x-twilio: + pii: + handling: standard + deleteSla: 30 role_sid: type: string minLength: 34 @@ -607,6 +656,16 @@ components: enum: - GET - POST + conversation_webhook_enum_target: + type: string + enum: + - webhook + - flex + conversation_webhook_enum_method: + type: string + enum: + - GET + - POST conversations.v1.credential: type: object properties: @@ -630,6 +689,10 @@ components: nullable: true description: The human-readable name of this credential, limited to 64 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/credential_enum_push_type' @@ -703,11 +766,19 @@ components: 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. + x-twilio: + pii: + handling: standard + deleteSla: 30 participant_messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_sid: type: string minLength: 34 @@ -721,17 +792,29 @@ components: nullable: true description: An application-defined string that uniquely identifies the Conversation resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 conversation_date_created: type: string format: date-time @@ -800,6 +883,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/role_enum_role_type' @@ -858,6 +945,10 @@ components: nullable: true description: The human-readable name of this service, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -929,6 +1020,10 @@ components: nullable: true description: The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity: type: string nullable: true @@ -937,6 +1032,10 @@ components: within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 binding_type: type: string $ref: '#/components/schemas/service_binding_enum_binding_type' @@ -980,7 +1079,7 @@ components: pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The conversation-level role assigned to a conversation creator - user when they join a new conversation. See the [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) + when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. default_conversation_role_sid: type: string @@ -989,7 +1088,7 @@ components: pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The conversation-level role assigned to users when they are - added to a conversation. See the [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) + added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. default_chat_service_role_sid: type: string @@ -998,7 +1097,7 @@ components: pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The service-level role assigned to users when they are added - to the service. See the [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) + to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. url: type: string @@ -1014,7 +1113,7 @@ components: reachability_enabled: type: boolean nullable: true - description: Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) + description: Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`. conversations.v1.service.service_conversation: type: object @@ -1041,7 +1140,7 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. sid: type: string @@ -1055,18 +1154,30 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 state: type: string $ref: '#/components/schemas/service_conversation_enum_state' @@ -1155,10 +1266,18 @@ components: nullable: true description: The channel specific identifier of the message's author. Defaults to `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 body: type: string nullable: true description: The content of the message, can be up to 1,600 characters long. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 media: type: array items: {} @@ -1168,12 +1287,20 @@ components: with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object''s file size in bytes. If the Message has no media, this value is `null`.' + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 participant_sid: type: string minLength: 34 @@ -1214,7 +1341,7 @@ components: maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template. service_conversation_message_enum_order_type: type: string @@ -1359,18 +1486,31 @@ components: 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 - Conversation SDK to communicate. Limited to 256 characters. + [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) + to communicate. Limited to 256 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if - specified. **Note** that if the attributes are not set "{}" will be returned. + specified. **Note** that if the attributes are not set `{}` will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. + x-twilio: + pii: + handling: standard + deleteSla: 30 role_sid: type: string minLength: 34 @@ -1383,12 +1523,12 @@ components: type: string format: date-time nullable: true - description: The date that this resource was created. + description: The date on which this resource was created. date_updated: type: string format: date-time nullable: true - description: The date that this resource was last updated. + description: The date on which this resource was last updated. url: type: string format: uri @@ -1555,11 +1695,19 @@ components: 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. + x-twilio: + pii: + handling: standard + deleteSla: 30 participant_messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_sid: type: string minLength: 34 @@ -1573,17 +1721,29 @@ components: nullable: true description: An application-defined string that uniquely identifies the Conversation resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 conversation_date_created: type: string format: date-time @@ -1652,6 +1812,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/service_role_enum_role_type' @@ -1727,15 +1891,27 @@ components: description: The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 is_online: type: boolean nullable: true @@ -1837,6 +2013,10 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_state: type: string $ref: '#/components/schemas/service_user_conversation_enum_state' @@ -1852,6 +2032,10 @@ components: description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 date_created: type: string format: date-time @@ -1880,6 +2064,10 @@ components: description: An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -2002,15 +2190,27 @@ components: description: The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 is_online: type: boolean nullable: true @@ -2112,6 +2312,10 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_state: type: string $ref: '#/components/schemas/user_conversation_enum_state' @@ -2127,6 +2331,10 @@ components: description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 date_created: type: string format: date-time @@ -2155,6 +2363,10 @@ components: description: An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -2177,10 +2389,6 @@ components: - inactive - active - closed - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Conversations description: This is the public Twilio REST API. @@ -2192,7 +2400,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Configuration: @@ -2208,32 +2416,56 @@ paths: pathType: instance get: description: Fetch the global configuration of conversations on your account + tags: + - ConversationsV1Configuration responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_inactive_timer: PT1M + default_closed_timer: PT10M + url: https://conversations.twilio.com/v1/Configuration + links: + service: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + webhooks: https://conversations.twilio.com/v1/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: FetchConfiguration - x-maturity: - - GA post: description: Update the global configuration of conversations on your account + tags: + - ConversationsV1Configuration responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_inactive_timer: PT1M + default_closed_timer: PT10M + url: https://conversations.twilio.com/v1/Configuration + links: + service: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + webhooks: https://conversations.twilio.com/v1/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2253,7 +2485,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The SID of the default [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation. DefaultInactiveTimer: type: string @@ -2265,6 +2497,13 @@ paths: description: Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. + examples: + update: + value: + DefaultChatServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultMessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultInactiveTimer: PT1M + DefaultClosedTimer: PT10M /v1/Configuration/Addresses: servers: - url: https://conversations.twilio.com @@ -2276,10 +2515,12 @@ paths: - type - address - friendly_name - pathType: list mountName: address_configurations + pathType: list get: description: Retrieve a list of address configurations for an account + tags: + - ConversationsV1AddressConfiguration parameters: - name: Type in: query @@ -2287,6 +2528,9 @@ paths: be one of: `whatsapp`, `sms`.' schema: type: string + examples: + readByAddressType: + value: sms - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2319,48 +2563,205 @@ paths: items: $ref: '#/components/schemas/conversations.v1.configuration_address' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readAll: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 + next_page_url: null + key: address_configurations + address_configurations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: '+37256123457' + type: sms + friendly_name: My Test Configuration + address_country: CA + auto_creation: + enabled: true + type: webhook + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: https://example.com + webhook_method: POST + webhook_filters: + - onParticipantAdded + - onMessageAdded + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + address: '+37256123458' + type: sms + friendly_name: Studio Test Configuration + address_country: US + auto_creation: + enabled: false + type: studio + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + address: '+37256123459' + type: sms + friendly_name: Default Test Configuration + address_country: NG + auto_creation: + enabled: true + type: default + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + readBlank: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 + url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: address_configurations + address_configurations: [] + readByAddressType: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0 + next_page_url: null + key: address_configurations + address_configurations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: '+37256123457' + type: sms + friendly_name: My Test Configuration + address_country: CA + auto_creation: + enabled: true + type: webhook + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: https://example.com + webhook_method: POST + webhook_filters: + - onParticipantAdded + - onMessageAdded + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + address: '+37256123458' + type: sms + friendly_name: Studio Test Configuration + address_country: US + auto_creation: + enabled: false + type: studio + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + address: '+37256123459' + type: sms + friendly_name: Default Test Configuration + address_country: NG + auto_creation: + enabled: true + type: default + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac description: OK security: - accountSid_authToken: [] operationId: ListConfigurationAddress - x-maturity: - - GA post: description: Create a new address configuration + tags: + - ConversationsV1AddressConfiguration responses: '201': content: 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 description: Created security: - accountSid_authToken: [] operationId: CreateConfigurationAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2388,7 +2789,9 @@ paths: type: string $ref: '#/components/schemas/configuration_address_enum_auto_creation_type' description: Type of Auto Creation. Value can be one of `webhook`, - `studio` or `default`. + `studio` or `default`. `default` creates a new Conversation under + the default Conversation service, without a webhook or Studio + integration. AutoCreation.ConversationServiceSid: type: string minLength: 34 @@ -2431,6 +2834,28 @@ paths: required: - Type - Address + examples: + create: + value: + Address: '+37256123457' + Type: sms + FriendlyName: My Test Configuration + AutoCreation.Enabled: true + AutoCreation.Type: webhook + AutoCreation.ConversationServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + AutoCreation.WebhookUrl: https://example.com + AutoCreation.WebhookMethod: POST + AutoCreation.WebhookFilters: + - onParticipantAdded + - onMessageAdded + AddressCountry: CA + createEmail: + value: + Address: example@example.com + Type: email + FriendlyName: My Email Configuration + AutoCreation.Enabled: true + AutoCreation.Type: default /v1/Configuration/Addresses/{Sid}: servers: - url: https://conversations.twilio.com @@ -2442,10 +2867,12 @@ paths: - type - address - friendly_name - pathType: instance mountName: address_configurations + pathType: instance get: description: 'Fetch an address configuration ' + tags: + - ConversationsV1AddressConfiguration parameters: - name: Sid in: path @@ -2460,14 +2887,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration_address' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: '+37256123457' + type: sms + friendly_name: My Test Configuration + address_country: CA + auto_creation: + enabled: true + type: webhook + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: https://example.com + webhook_method: POST + webhook_filters: + - onParticipantAdded + - onMessageAdded + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConfigurationAddress - x-maturity: - - GA post: description: Update an existing address configuration + tags: + - ConversationsV1AddressConfiguration parameters: - name: Sid in: path @@ -2482,12 +2930,28 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration_address' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: '+37256123457' + type: sms + friendly_name: My Test Configuration Updated + address_country: CA + auto_creation: + enabled: false + type: studio + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateConfigurationAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2543,8 +3007,18 @@ paths: type: integer description: For type `studio`, number of times to retry the webhook request + examples: + update: + value: + FriendlyName: My Test Configuration Updated + AutoCreation.Enabled: false + AutoCreation.Type: studio + AutoCreation.StudioFlowSid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + AutoCreation.StudioRetryCount: 3 delete: description: Remove an existing address configuration + tags: + - ConversationsV1AddressConfiguration parameters: - name: Sid in: path @@ -2559,8 +3033,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConfigurationAddress - x-maturity: - - GA /v1/Configuration/Webhooks: servers: - url: https://conversations.twilio.com @@ -2572,36 +3044,59 @@ paths: - method - pre_webhook_url - post_webhook_url - pathType: instance parent: /Configuration + pathType: instance get: description: '' + tags: + - ConversationsV1Webhook responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration.configuration_webhook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + pre_webhook_url: https://example.com/pre + post_webhook_url: https://example.com/post + method: GET + filters: + - onMessageSend + - onConversationUpdated + target: webhook + url: https://conversations.twilio.com/v1/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: FetchConfigurationWebhook - x-maturity: - - GA post: description: '' + tags: + - ConversationsV1Webhook responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration.configuration_webhook' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + pre_webhook_url: https://example.com/pre + post_webhook_url: http://example.com/post + method: GET + filters: + - onConversationUpdated + target: webhook + url: https://conversations.twilio.com/v1/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateConfigurationWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2632,6 +3127,15 @@ paths: type: string $ref: '#/components/schemas/configuration_webhook_enum_target' description: The routing target of the webhook. + examples: + update: + value: + PreWebhookUrl: https://example.com/pre + PostWebhookUrl: https://example.com/post + Method: GET + Filters: + - onConversationUpdated + Target: webhook /v1/Conversations: servers: - url: https://conversations.twilio.com @@ -2643,13 +3147,24 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: list dependentProperties: - participant: '{conversation_sid: sid}' - message: '{conversation_sid: sid}' - webhook: '{conversation_sid: sid}' + participants: + mapping: + conversation_sid: sid + resource_url: /v1/Conversations/{conversation_sid}/Participants + messages: + mapping: + conversation_sid: sid + resource_url: /v1/Conversations/{conversation_sid}/Messages + webhooks: + mapping: + conversation_sid: sid + resource_url: /v1/Conversations/{conversation_sid}/Webhooks + pathType: list post: description: Create a new conversation in your account's default service + tags: + - ConversationsV1Conversation parameters: - name: X-Twilio-Webhook-Enabled in: header @@ -2663,12 +3178,73 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + createNoTimersNoAttributes: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: null + attributes: '{}' + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + state: active + timers: {} + bindings: {} + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + 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 description: Created security: - accountSid_authToken: [] operationId: CreateConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2698,7 +3274,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. Attributes: type: string @@ -2719,8 +3295,44 @@ paths: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. + Bindings.Email.Address: + type: string + description: The default email address that will be used when sending + outbound emails in this conversation. + Bindings.Email.Name: + type: string + 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 get: description: Retrieve a list of conversations in your account's default service + tags: + - ConversationsV1Conversation parameters: - name: StartDate in: query @@ -2775,34 +3387,63 @@ paths: items: $ref: '#/components/schemas/conversations.v1.conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + conversations: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Home Repair Visit + unique_name: null + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: active + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListConversation - x-maturity: - - GA /v1/Conversations/{Sid}: servers: - url: https://conversations.twilio.com @@ -2814,13 +3455,24 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: instance dependentProperties: - participant: '{conversation_sid: sid}' - message: '{conversation_sid: sid}' - webhook: '{conversation_sid: sid}' + participants: + mapping: + conversation_sid: sid + resource_url: /v1/Conversations/{conversation_sid}/Participants + messages: + mapping: + conversation_sid: sid + resource_url: /v1/Conversations/{conversation_sid}/Messages + webhooks: + mapping: + conversation_sid: sid + resource_url: /v1/Conversations/{conversation_sid}/Webhooks + pathType: instance post: description: Update an existing conversation in your account's default service + tags: + - ConversationsV1Conversation parameters: - name: Sid in: path @@ -2841,12 +3493,32 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2877,7 +3549,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. State: type: string @@ -2897,8 +3569,30 @@ paths: description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + Bindings.Email.Address: + type: string + description: The default email address that will be used when sending + outbound emails in this conversation. + Bindings.Email.Name: + type: string + 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 delete: description: Remove a conversation from your account's default service + tags: + - ConversationsV1Conversation parameters: - name: Sid in: path @@ -2919,10 +3613,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConversation - x-maturity: - - GA get: description: Fetch a conversation from your account's default service + tags: + - ConversationsV1Conversation parameters: - name: Sid in: path @@ -2937,12 +3631,32 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My First Conversation + unique_name: first_conversation + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: active + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks description: OK security: - accountSid_authToken: [] operationId: FetchConversation - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Messages: servers: - url: https://conversations.twilio.com @@ -2953,12 +3667,23 @@ paths: - index - author - date_created - pathType: list dependentProperties: - delivery_receipt: '{conversation_sid: conversation_sid, message_sid: sid}' + delivery_receipts: + mapping: + conversation_sid: conversation_sid + message_sid: sid + resource_url: /v1/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts + channel_metadata: + mapping: + conversation_sid: conversation_sid + message_sid: sid + resource_url: /v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata parent: /Conversations/{Sid} + pathType: list post: description: Add a new message to the conversation + tags: + - ConversationsV1Message parameters: - name: ConversationSid in: path @@ -2979,12 +3704,140 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + 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 description: Created security: - accountSid_authToken: [] operationId: CreateConversationMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3026,7 +3879,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored. @@ -3034,8 +3887,49 @@ paths: type: string description: A structurally valid JSON string that contains values to resolve Rich Content template variables. + Subject: + type: string + 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 get: description: Retrieve a list of all messages in the conversation + tags: + - ConversationsV1Message parameters: - name: ConversationSid in: path @@ -3051,6 +3945,9 @@ paths: schema: type: string $ref: '#/components/schemas/conversation_message_enum_order_type' + examples: + readLastMessage: + value: desc - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3083,34 +3980,155 @@ paths: items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: I like pie. + media: null + author: pie_preferrer + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + 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 description: OK security: - accountSid_authToken: [] operationId: ListConversationMessage - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Messages/{Sid}: servers: - url: https://conversations.twilio.com @@ -3121,12 +4139,23 @@ paths: - index - author - date_created - pathType: instance dependentProperties: - delivery_receipt: '{conversation_sid: conversation_sid, message_sid: sid}' + delivery_receipts: + mapping: + conversation_sid: conversation_sid + message_sid: sid + resource_url: /v1/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts + channel_metadata: + mapping: + conversation_sid: conversation_sid + message_sid: sid + resource_url: /v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata parent: /Conversations/{Sid} + pathType: instance post: description: Update an existing message in the conversation + tags: + - ConversationsV1Message parameters: - name: ConversationSid in: path @@ -3156,12 +4185,36 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata description: OK security: - accountSid_authToken: [] operationId: UpdateConversationMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3192,8 +4245,22 @@ paths: you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + Subject: + type: string + 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' delete: description: Remove a message from the conversation + tags: + - ConversationsV1Message parameters: - name: ConversationSid in: path @@ -3223,10 +4290,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConversationMessage - x-maturity: - - GA get: description: Fetch a message from the conversation + tags: + - ConversationsV1Message parameters: - name: ConversationSid in: path @@ -3250,12 +4317,36 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Welcome! + media: null + author: system + participant_sid: null + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata description: OK security: - accountSid_authToken: [] operationId: FetchConversationMessage - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}: servers: - url: https://conversations.twilio.com @@ -3267,11 +4358,13 @@ paths: - message_sid - status - date_created - pathType: instance parent: /Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts + pathType: instance get: description: Fetch the delivery and read receipts of the conversation message + tags: + - ConversationsV1DeliveryReceipt parameters: - name: ConversationSid in: path @@ -3305,12 +4398,24 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message.conversation_message_receipt' + examples: + fetch: + value: + sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConversationMessageReceipt - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts: servers: - url: https://conversations.twilio.com @@ -3322,12 +4427,14 @@ paths: - message_sid - status - date_created - pathType: list parent: /Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts + pathType: list get: description: Retrieve a list of all delivery and read receipts of the conversation message + tags: + - ConversationsV1DeliveryReceipt parameters: - name: ConversationSid in: path @@ -3378,34 +4485,77 @@ paths: items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message.conversation_message_receipt' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 + next_page_url: null + key: delivery_receipts + delivery_receipts: + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListConversationMessageReceipt - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Participants: servers: - url: https://conversations.twilio.com @@ -3414,10 +4564,12 @@ paths: defaultOutputProperties: - sid - messaging_binding - pathType: list parent: /Conversations/{Sid} + pathType: list post: description: Add a new participant to the conversation + tags: + - ConversationsV1Participant parameters: - name: ConversationSid in: path @@ -3438,12 +4590,90 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' + examples: + createSms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createChat: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: null + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmmsChatNoAttributes: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{}' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmmsSmsNoAttributes: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{}' + messaging_binding: + type: sms + address: '+15017122661' + role_sid: null + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: Created security: - accountSid_authToken: [] operationId: CreateConversationParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3496,8 +4726,46 @@ paths: pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. + examples: + createSms: + value: + Attributes: '{ "role": "driver" }' + MessagingBinding.Address: '+15558675310' + MessagingBinding.ProxyAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createChat: + value: + Identity: IDENTITY + Attributes: '{ "role": "driver" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createGmms: + value: + Identity: IDENTITY + Attributes: '{ "role": "driver" }' + MessagingBinding.ProjectedAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createGmmsChatNoAttributes: + value: + Identity: IDENTITY + MessagingBinding.ProjectedAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' + createGmmsSmsNoAttributes: + value: + MessagingBinding.Address: '+15017122661' + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' get: description: Retrieve a list of all participants of the conversation + tags: + - ConversationsV1Participant parameters: - name: ConversationSid in: path @@ -3538,34 +4806,71 @@ paths: items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + next_page_url: null + key: participants + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: null + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: OK security: - accountSid_authToken: [] operationId: ListConversationParticipant - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Participants/{Sid}: servers: - url: https://conversations.twilio.com @@ -3574,10 +4879,12 @@ paths: defaultOutputProperties: - sid - messaging_binding - pathType: instance parent: /Conversations/{Sid} + pathType: instance post: description: Update an existing participant in the conversation + tags: + - ConversationsV1Participant parameters: - name: ConversationSid in: path @@ -3604,12 +4911,44 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + updateGmms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: id + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: OK security: - accountSid_authToken: [] operationId: UpdateConversationParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3662,8 +5001,20 @@ paths: description: "Timestamp of last \u201Cread\u201D message in the\ \ [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." + examples: + update: + value: + Attributes: '{ "role": "driver" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + updateGmms: + value: + MessagingBinding.ProjectedAddress: '+15017122661' delete: description: Remove a participant from the conversation + tags: + - ConversationsV1Participant parameters: - name: ConversationSid in: path @@ -3690,10 +5041,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConversationParticipant - x-maturity: - - GA get: description: Fetch a participant of the conversation + tags: + - ConversationsV1Participant parameters: - name: ConversationSid in: path @@ -3705,6 +5056,7 @@ paths: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. + Alternatively, you can pass a Participant's `identity` rather than the SID. schema: type: string required: true @@ -3714,12 +5066,45 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + 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 description: OK security: - accountSid_authToken: [] operationId: FetchConversationParticipant - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Webhooks: servers: - url: https://conversations.twilio.com @@ -3729,10 +5114,12 @@ paths: defaultOutputProperties: - sid - target - pathType: list parent: /Conversations/{Sid} + pathType: list get: description: Retrieve a list of all webhooks scoped to the conversation + tags: + - ConversationsV1Webhook parameters: - name: ConversationSid in: path @@ -3773,36 +5160,94 @@ paths: items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + next_page_url: null + key: webhooks + webhooks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: webhook + configuration: + url: https://example.com + method: get + filters: + - onMessageSent + - onConversationDestroyed + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: trigger + configuration: + url: https://example.com + method: post + filters: + - keyword1 + - keyword2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + next_page_url: null + key: webhooks + webhooks: [] description: OK security: - accountSid_authToken: [] operationId: ListConversationScopedWebhook - x-maturity: - - GA post: description: Create a new webhook scoped to the conversation + tags: + - ConversationsV1Webhook parameters: - name: ConversationSid in: path @@ -3817,12 +5262,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: webhook + configuration: + url: https://example.com + method: get + filters: + - onMessageSent + - onConversationDestroyed + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateConversationScopedWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3866,6 +5325,16 @@ paths: webhook will be replayed. Not set by default required: - Target + examples: + create: + value: + Target: webhook + Configuration.Url: https://example.com + Configuration.Method: get + Configuration.Filters: + - onMessageSent + - onConversationDestroyed + Configuration.ReplayAfter: 7 /v1/Conversations/{ConversationSid}/Webhooks/{Sid}: servers: - url: https://conversations.twilio.com @@ -3875,10 +5344,12 @@ paths: defaultOutputProperties: - sid - target - pathType: instance parent: /Conversations/{Sid} + pathType: instance get: description: Fetch the configuration of a conversation-scoped webhook + tags: + - ConversationsV1Webhook parameters: - name: ConversationSid in: path @@ -3902,14 +5373,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConversationScopedWebhook - x-maturity: - - GA post: description: Update an existing conversation-scoped webhook + tags: + - ConversationsV1Webhook parameters: - name: ConversationSid in: path @@ -3933,12 +5416,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: trigger + configuration: + url: https://example.com + method: post + filters: + - keyword1 + - keyword2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateConversationScopedWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3972,8 +5469,18 @@ paths: pattern: ^FW[0-9a-fA-F]{32}$ description: The studio flow SID, where the webhook should be sent to. + examples: + update: + value: + Configuration.Url: https://example.com + Configuration.Method: post + Configuration.Triggers: + - keyword1 + - keyword2 delete: description: Remove an existing webhook scoped to the conversation + tags: + - ConversationsV1Webhook parameters: - name: ConversationSid in: path @@ -3997,8 +5504,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConversationScopedWebhook - x-maturity: - - GA /v1/Credentials: servers: - url: https://conversations.twilio.com @@ -4011,18 +5516,29 @@ paths: pathType: list post: description: Add a new push notification credential to your account + tags: + - ConversationsV1Credential responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4070,8 +5586,14 @@ paths: the Firebase console, found under Settings / Cloud messaging.' required: - Type + examples: + create: + value: + Type: apn get: description: Retrieve a list of all push notification credentials on your account + tags: + - ConversationsV1Credential parameters: - name: PageSize in: query @@ -4105,34 +5627,63 @@ paths: items: $ref: '#/components/schemas/conversations.v1.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - GA /v1/Credentials/{Sid}: servers: - url: https://conversations.twilio.com @@ -4145,6 +5696,8 @@ paths: pathType: instance post: description: Update an existing push notification credential on your account + tags: + - ConversationsV1Credential parameters: - name: Sid in: path @@ -4161,12 +5714,21 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4212,8 +5774,14 @@ paths: type: string description: '[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.' + examples: + update: + value: + FriendlyName: Test slow create delete: description: Remove a push notification credential from your account + tags: + - ConversationsV1Credential parameters: - name: Sid in: path @@ -4230,10 +5798,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - GA get: description: Fetch a push notification credential from your account + tags: + - ConversationsV1Credential parameters: - name: Sid in: path @@ -4250,12 +5818,21 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - GA /v1/ParticipantConversations: servers: - url: https://conversations.twilio.com @@ -4270,6 +5847,8 @@ paths: get: description: Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified. + tags: + - ConversationsV1ParticipantConversation parameters: - name: Identity in: query @@ -4279,6 +5858,11 @@ paths: Conversations SDK to communicate. Limited to 256 characters. schema: type: string + examples: + readEmpty: + value: identity + readFullByIdentity: + value: identity - name: Address in: query description: A unique string identifier for the conversation participant who's @@ -4286,6 +5870,9 @@ paths: field of Participant resource. It should be url-encoded. schema: type: string + examples: + readFullByAddress: + value: '+375255555555' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4318,34 +5905,112 @@ paths: items: $ref: '#/components/schemas/conversations.v1.participant_conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + conversations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + next_page_url: null + key: conversations + readFullByIdentity: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_friendly_name: friendly_name + conversation_state: inactive + conversation_timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + conversation_attributes: '{}' + conversation_date_created: '2015-07-30T20:00:00Z' + conversation_date_updated: '2015-07-30T20:00:00Z' + conversation_created_by: created_by + conversation_unique_name: unique_name + participant_user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_identity: identity + participant_messaging_binding: null + links: + participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + next_page_url: null + key: conversations + readFullByAddress: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_friendly_name: friendly_name + conversation_state: inactive + conversation_timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + conversation_attributes: '{}' + conversation_date_created: '2015-07-30T20:00:00Z' + conversation_date_updated: '2015-07-30T20:00:00Z' + conversation_created_by: created_by + conversation_unique_name: unique_name + participant_user_sid: null + participant_identity: null + participant_messaging_binding: + address: '+375255555555' + proxy_address: '+12345678910' + type: sms + level: null + name: null + projected_address: null + links: + participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListParticipantConversation - x-maturity: - - GA /v1/Roles: servers: - url: https://conversations.twilio.com @@ -4359,18 +6024,34 @@ paths: pathType: list post: description: Create a new user role in your account's default service + tags: + - ConversationsV1Role responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4400,8 +6081,16 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: Conversation Role + Type: conversation + Permission: sendMessage get: description: Retrieve a list of all user roles in your account's default service + tags: + - ConversationsV1Role parameters: - name: PageSize in: query @@ -4435,34 +6124,68 @@ paths: items: $ref: '#/components/schemas/conversations.v1.role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListRole - x-maturity: - - GA /v1/Roles/{Sid}: servers: - url: https://conversations.twilio.com @@ -4476,6 +6199,8 @@ paths: pathType: instance post: description: Update an existing user role in your account's default service + tags: + - ConversationsV1Role parameters: - name: Sid in: path @@ -4492,12 +6217,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4518,8 +6257,14 @@ paths: this parameter depend on the role's `type`. required: - Permission + examples: + update: + value: + Permission: sendMessage delete: description: Remove a user role from your account's default service + tags: + - ConversationsV1Role parameters: - name: Sid in: path @@ -4536,10 +6281,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRole - x-maturity: - - GA get: description: Fetch a user role from your account's default service + tags: + - ConversationsV1Role parameters: - name: Sid in: path @@ -4556,12 +6301,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRole - x-maturity: - - GA /v1/Services: servers: - url: https://conversations.twilio.com @@ -4571,28 +6330,62 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list dependentProperties: - conversation: '{chat_service_sid: sid}' - binding: '{chat_service_sid: sid}' - user: '{chat_service_sid: sid}' - role: '{chat_service_sid: sid}' - configuration: '{chat_service_sid: sid}' - participant_conversation: '{chat_service_sid: sid}' + conversations: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations + bindings: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Bindings + users: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Users + roles: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Roles + configuration: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Configuration + participant_conversations: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/ParticipantConversations + pathType: list post: description: Create a new conversation service on your account + tags: + - ConversationsV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service' + examples: + create: + value: + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations + users: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + configuration: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + participant_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4606,8 +6399,14 @@ paths: 256 characters. Optional. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name get: description: Retrieve a list of all conversation services on your account + tags: + - ConversationsV1Service parameters: - name: PageSize in: query @@ -4641,34 +6440,57 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + services: + - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Home Service + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations + users: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + configuration: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + participant_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services?PageSize=50&Page=0 + next_page_url: null + key: services description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v1/Services/{Sid}: servers: - url: https://conversations.twilio.com @@ -4678,17 +6500,37 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance dependentProperties: - conversation: '{chat_service_sid: sid}' - binding: '{chat_service_sid: sid}' - user: '{chat_service_sid: sid}' - role: '{chat_service_sid: sid}' - configuration: '{chat_service_sid: sid}' - participant_conversation: '{chat_service_sid: sid}' + conversations: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations + bindings: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Bindings + users: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Users + roles: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Roles + configuration: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Configuration + participant_conversations: + mapping: + chat_service_sid: sid + resource_url: /v1/Services/{chat_service_sid}/ParticipantConversations + pathType: instance delete: description: Remove a conversation service with all its nested resources from your account + tags: + - ConversationsV1Service parameters: - name: Sid in: path @@ -4705,10 +6547,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA get: description: Fetch a conversation service from your account + tags: + - ConversationsV1Service parameters: - name: Sid in: path @@ -4725,12 +6567,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service' + examples: + fetch: + value: + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My First Service + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations + users: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + configuration: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + participant_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Bindings/{Sid}: servers: - url: https://conversations.twilio.com @@ -4741,10 +6597,12 @@ paths: - sid - endpoint - identity - pathType: instance parent: /Services/{Sid} + pathType: instance delete: description: Remove a push notification binding from the conversation service + tags: + - ConversationsV1Binding parameters: - name: ChatServiceSid in: path @@ -4771,10 +6629,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceBinding - x-maturity: - - GA get: description: Fetch a push notification binding from the conversation service + tags: + - ConversationsV1Binding parameters: - name: ChatServiceSid in: path @@ -4801,12 +6659,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_binding' + examples: + fetch: + value: + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_conversation + - new_message + - added_to_conversation + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchServiceBinding - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Bindings: servers: - url: https://conversations.twilio.com @@ -4817,11 +6690,13 @@ paths: - sid - endpoint - identity - pathType: list parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all push notification bindings in the conversation service + tags: + - ConversationsV1Binding parameters: - name: ChatServiceSid in: path @@ -4852,6 +6727,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4884,34 +6763,69 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: + - sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_conversation + - new_message + - added_to_conversation + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: [] description: OK security: - accountSid_authToken: [] operationId: ListServiceBinding - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Configuration: servers: - url: https://conversations.twilio.com @@ -4920,10 +6834,12 @@ paths: x-twilio: defaultOutputProperties: - chat_service_sid - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: Fetch the configuration of a conversation service + tags: + - ConversationsV1Configuration parameters: - name: ChatServiceSid in: path @@ -4940,14 +6856,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration' + examples: + fetch: + value: + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_conversation_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_conversation_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_chat_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reachability_enabled: false + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + links: + notifications: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: FetchServiceConfiguration - x-maturity: - - GA post: description: Update configuration settings of a conversation service + tags: + - ConversationsV1Configuration parameters: - name: ChatServiceSid in: path @@ -4964,12 +6892,22 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration' + examples: + update: + value: + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_conversation_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_conversation_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_chat_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reachability_enabled: false + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + links: + notifications: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4983,8 +6921,7 @@ paths: maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The conversation-level role assigned to a conversation - creator when they join a new conversation. See the [Conversation - Role](https://www.twilio.com/docs/conversations/api/role-resource) + creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. DefaultConversationRoleSid: type: string @@ -4992,7 +6929,7 @@ paths: maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The conversation-level role assigned to users when - they are added to a conversation. See the [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) + they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. DefaultChatServiceRoleSid: type: string @@ -5000,12 +6937,19 @@ paths: maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The service-level role assigned to users when they - are added to the service. See the [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) + are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. ReachabilityEnabled: type: boolean - description: Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) + 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 /v1/Services/{ChatServiceSid}/Conversations: servers: - url: https://conversations.twilio.com @@ -5017,14 +6961,28 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: list dependentProperties: - participant: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' - message: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' - webhook: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' + participants: + mapping: + chat_service_sid: chat_service_sid + conversation_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Participants + messages: + mapping: + chat_service_sid: chat_service_sid + conversation_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages + webhooks: + mapping: + chat_service_sid: chat_service_sid + conversation_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Webhooks parent: /Services/{Sid} + pathType: list post: description: Create a new conversation in your service + tags: + - ConversationsV1Conversation parameters: - name: ChatServiceSid in: path @@ -5048,12 +7006,51 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + createNoTimersNoAttributes: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: null + attributes: '{}' + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + state: active + timers: {} + bindings: {} + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5081,7 +7078,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. DateCreated: type: string @@ -5104,8 +7101,37 @@ paths: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. + Bindings.Email.Address: + type: string + description: The default email address that will be used when sending + outbound emails in this conversation. + Bindings.Email.Name: + type: string + 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 get: description: Retrieve a list of conversations in your service + tags: + - ConversationsV1Conversation parameters: - name: ChatServiceSid in: path @@ -5170,34 +7196,63 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + conversations: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Home Repair Visit + unique_name: null + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: active + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListServiceConversation - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{Sid}: servers: - url: https://conversations.twilio.com @@ -5209,14 +7264,28 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: instance dependentProperties: - participant: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' - message: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' - webhook: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' + participants: + mapping: + chat_service_sid: chat_service_sid + conversation_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Participants + messages: + mapping: + chat_service_sid: chat_service_sid + conversation_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages + webhooks: + mapping: + chat_service_sid: chat_service_sid + conversation_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Webhooks parent: /Services/{Sid} + pathType: instance post: description: Update an existing conversation in your service + tags: + - ConversationsV1Conversation parameters: - name: ChatServiceSid in: path @@ -5247,12 +7316,32 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5283,7 +7372,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. State: type: string @@ -5303,8 +7392,30 @@ paths: description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + Bindings.Email.Address: + type: string + description: The default email address that will be used when sending + outbound emails in this conversation. + Bindings.Email.Name: + type: string + 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 delete: description: Remove a conversation from your service + tags: + - ConversationsV1Conversation parameters: - name: ChatServiceSid in: path @@ -5335,10 +7446,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceConversation - x-maturity: - - GA get: description: Fetch a conversation from your service + tags: + - ConversationsV1Conversation parameters: - name: ChatServiceSid in: path @@ -5363,12 +7474,32 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My First Conversation + unique_name: first_conversation + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: active + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversation - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages: servers: - url: https://conversations.twilio.com @@ -5380,13 +7511,25 @@ paths: - index - author - date_created - pathType: list dependentProperties: - delivery_receipt: '{chat_service_sid: chat_service_sid, conversation_sid: - conversation_sid, message_sid: sid}' + delivery_receipts: + mapping: + chat_service_sid: chat_service_sid + conversation_sid: conversation_sid + message_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts + channel_metadata: + mapping: + chat_service_sid: chat_service_sid + conversation_sid: conversation_sid + message_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: list post: description: Add a new message to the conversation in a specific service + tags: + - ConversationsV1Message parameters: - name: ChatServiceSid in: path @@ -5417,12 +7560,145 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + 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 description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5464,7 +7740,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored. @@ -5472,8 +7748,49 @@ paths: type: string description: A structurally valid JSON string that contains values to resolve Rich Content template variables. + Subject: + type: string + 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 get: description: Retrieve a list of all messages in the conversation + tags: + - ConversationsV1Message parameters: - name: ChatServiceSid in: path @@ -5499,6 +7816,9 @@ paths: schema: type: string $ref: '#/components/schemas/service_conversation_message_enum_order_type' + examples: + readLastMessage: + value: desc - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5531,34 +7851,159 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: I like pie. + media: null + author: pie_preferrer + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + 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 description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationMessage - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}: servers: - url: https://conversations.twilio.com @@ -5570,13 +8015,25 @@ paths: - index - author - date_created - pathType: instance dependentProperties: - delivery_receipt: '{chat_service_sid: chat_service_sid, conversation_sid: - conversation_sid, message_sid: sid}' + delivery_receipts: + mapping: + chat_service_sid: chat_service_sid + conversation_sid: conversation_sid + message_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts + channel_metadata: + mapping: + chat_service_sid: chat_service_sid + conversation_sid: conversation_sid + message_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: instance post: description: Update an existing message in the conversation + tags: + - ConversationsV1Message parameters: - name: ChatServiceSid in: path @@ -5616,12 +8073,37 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5652,8 +8134,22 @@ paths: you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + Subject: + type: string + 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' delete: description: Remove a message from the conversation + tags: + - ConversationsV1Message parameters: - name: ChatServiceSid in: path @@ -5693,10 +8189,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceConversationMessage - x-maturity: - - GA get: description: Fetch a message from the conversation + tags: + - ConversationsV1Message parameters: - name: ChatServiceSid in: path @@ -5730,12 +8226,37 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Welcome! + media: null + author: system + participant_sid: null + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationMessage - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}: servers: - url: https://conversations.twilio.com @@ -5747,11 +8268,13 @@ paths: - message_sid - status - date_created - pathType: instance parent: /Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts + pathType: instance get: description: Fetch the delivery and read receipts of the conversation message + tags: + - ConversationsV1DeliveryReceipt parameters: - name: ChatServiceSid in: path @@ -5795,12 +8318,25 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt' + examples: + fetch: + value: + sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationMessageReceipt - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts: servers: - url: https://conversations.twilio.com @@ -5812,12 +8348,14 @@ paths: - message_sid - status - date_created - pathType: list parent: /Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts + pathType: list get: description: Retrieve a list of all delivery and read receipts of the conversation message + tags: + - ConversationsV1DeliveryReceipt parameters: - name: ChatServiceSid in: path @@ -5878,34 +8416,80 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 + next_page_url: null + key: delivery_receipts + delivery_receipts: + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationMessageReceipt - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants: servers: - url: https://conversations.twilio.com @@ -5915,10 +8499,12 @@ paths: defaultOutputProperties: - sid - messaging_binding - pathType: list parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: list post: description: Add a new participant to the conversation in a specific service + tags: + - ConversationsV1Participant parameters: - name: ChatServiceSid in: path @@ -5949,12 +8535,95 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' + examples: + createSms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: 'null' + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createChat: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: null + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmmsChatNoAttributes: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{}' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmmsSmsNoAttributes: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{}' + messaging_binding: + type: sms + address: '+15017122661' + role_sid: null + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5967,39 +8636,39 @@ paths: 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 Conversation SDK to communicate. Limited to 256 characters. + using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) + to communicate. Limited to 256 characters. MessagingBinding.Address: type: string description: The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines - a participant uniquely. This field (with proxy_address) is only + a participant uniquely. This field (with `proxy_address`) is only null when the participant is interacting from an SDK endpoint - (see the 'identity' field). + (see the `identity` field). MessagingBinding.ProxyAddress: type: string description: The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is - interacting from an SDK endpoint (see the 'identity' field). + interacting from an SDK endpoint (see the `identity` field). DateCreated: type: string format: date-time - description: The date that this resource was created. + description: The date on which this resource was created. DateUpdated: type: string format: date-time - description: The date that this resource was last updated. + description: The date on which this resource was last updated. Attributes: type: string description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are - not set "{}" will be returned. + not set `{}` will be returned. MessagingBinding.ProjectedAddress: type: string description: The address of the Twilio phone number that is used - in Group MMS. Communication mask for the Conversation participant - with Identity. + in Group MMS. RoleSid: type: string minLength: 34 @@ -6007,8 +8676,46 @@ paths: pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. + examples: + createSms: + value: + Attributes: '{ "role": "driver" }' + MessagingBinding.Address: '+15558675310' + MessagingBinding.ProxyAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createChat: + value: + Identity: IDENTITY + Attributes: '{ "role": "driver" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createGmms: + value: + Identity: IDENTITY + Attributes: '{ "role": "driver" }' + MessagingBinding.ProjectedAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createGmmsChatNoAttributes: + value: + Identity: IDENTITY + MessagingBinding.ProjectedAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' + createGmmsSmsNoAttributes: + value: + MessagingBinding.Address: '+15017122661' + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' get: description: Retrieve a list of all participants of the conversation + tags: + - ConversationsV1Participant parameters: - name: ChatServiceSid in: path @@ -6059,34 +8766,73 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + next_page_url: null + key: participants + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: null + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationParticipant - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}: servers: - url: https://conversations.twilio.com @@ -6096,10 +8842,12 @@ paths: defaultOutputProperties: - sid - messaging_binding - pathType: instance parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: instance post: description: Update an existing participant in the conversation + tags: + - ConversationsV1Participant parameters: - name: ChatServiceSid in: path @@ -6136,12 +8884,46 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + updateGmms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: id + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6152,23 +8934,24 @@ paths: DateCreated: type: string format: date-time - description: The date that this resource was created. + description: The date on which this resource was created. DateUpdated: type: string format: date-time - description: The date that this resource was last updated. + description: The date on which this resource was last updated. Identity: type: string 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 Conversation SDK to communicate. Limited to 256 characters. + using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) + to communicate. Limited to 256 characters. Attributes: type: string description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are - not set "{}" will be returned. + not set `{}` will be returned. RoleSid: type: string minLength: 34 @@ -6194,8 +8977,20 @@ paths: description: "Timestamp of last \u201Cread\u201D message in the\ \ [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." + examples: + update: + value: + Attributes: '{ "role": "driver" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + updateGmms: + value: + MessagingBinding.ProjectedAddress: '+15017122661' delete: description: Remove a participant from the conversation + tags: + - ConversationsV1Participant parameters: - name: ChatServiceSid in: path @@ -6232,10 +9027,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceConversationParticipant - x-maturity: - - GA get: description: Fetch a participant of the conversation + tags: + - ConversationsV1Participant parameters: - name: ChatServiceSid in: path @@ -6257,6 +9052,7 @@ paths: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. + Alternatively, you can pass a Participant's `identity` rather than the SID. schema: type: string required: true @@ -6266,12 +9062,47 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + 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 description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationParticipant - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks: servers: - url: https://conversations.twilio.com @@ -6281,10 +9112,12 @@ paths: defaultOutputProperties: - sid - target - pathType: list parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: list post: description: Create a new webhook scoped to the conversation in a specific service + tags: + - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path @@ -6309,12 +9142,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: webhook + configuration: + url: https://example.com + method: get + filters: + - onMessageSent + - onConversationDestroyed + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationScopedWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6358,8 +9206,20 @@ paths: webhook will be replayed. Not set by default required: - Target + examples: + create: + value: + Target: webhook + Configuration.Url: https://example.com + Configuration.Method: get + Configuration.Filters: + - onMessageSent + - onConversationDestroyed + Configuration.ReplayAfter: 7 get: description: Retrieve a list of all webhooks scoped to the conversation + tags: + - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path @@ -6410,34 +9270,93 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + next_page_url: null + key: webhooks + webhooks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: webhook + configuration: + url: https://example.com + method: get + filters: + - onMessageSent + - onConversationDestroyed + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: trigger + configuration: + url: https://example.com + method: post + filters: + - keyword1 + - keyword2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + next_page_url: null + key: webhooks + webhooks: [] description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationScopedWebhook - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}: servers: - url: https://conversations.twilio.com @@ -6447,10 +9366,12 @@ paths: defaultOutputProperties: - sid - target - pathType: instance parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: instance post: description: Update an existing conversation-scoped webhook + tags: + - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path @@ -6484,12 +9405,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: trigger + configuration: + url: https://example.com + method: post + filters: + - keyword1 + - keyword2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationScopedWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6523,8 +9459,18 @@ paths: pattern: ^FW[0-9a-fA-F]{32}$ description: The studio flow SID, where the webhook should be sent to. + examples: + update: + value: + Configuration.Url: https://example.com + Configuration.Method: post + Configuration.Triggers: + - keyword1 + - keyword2 delete: description: Remove an existing webhook scoped to the conversation + tags: + - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path @@ -6558,10 +9504,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceConversationScopedWebhook - x-maturity: - - GA get: description: Fetch the configuration of a conversation-scoped webhook + tags: + - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path @@ -6595,12 +9541,23 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationScopedWebhook - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Configuration/Notifications: servers: - url: https://conversations.twilio.com @@ -6609,10 +9566,12 @@ paths: x-twilio: defaultOutputProperties: - chat_service_sid - pathType: instance parent: /Services/{ChatServiceSid}/Configuration + pathType: instance post: description: Update push notification service settings + tags: + - ConversationsV1Notification parameters: - name: ChatServiceSid in: path @@ -6630,12 +9589,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_notification' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + log_enabled: true + added_to_conversation: + enabled: false + template: 'You have been added to a Conversation: ${CONVERSATION}' + sound: ring + new_message: + enabled: false + template: 'You have a new message in ${CONVERSATION} from ${PARTICIPANT}: + ${MESSAGE}' + badge_count_enabled: true + sound: ring + with_media: + enabled: false + template: 'You have a new message in ${CONVERSATION} with + ${MEDIA_COUNT} media files: ${MEDIA}' + removed_from_conversation: + enabled: false + template: 'You have been removed from a Conversation: ${CONVERSATION}' + sound: ring + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications description: OK security: - accountSid_authToken: [] operationId: UpdateServiceNotification - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6701,8 +9683,30 @@ paths: description: The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`. + examples: + update: + value: + NewMessage.Enabled: false + NewMessage.Template: 'You have a new message in ${CONVERSATION} + from ${PARTICIPANT}: ${MESSAGE}' + NewMessage.Sound: ring + NewMessage.BadgeCountEnabled: true + NewMessage.WithMedia.Enabled: false + NewMessage.WithMedia.Template: 'You have a new message in ${CONVERSATION} + with ${MEDIA_COUNT} media files: ${MEDIA}' + AddedToConversation.Enabled: false + AddedToConversation.Template: 'You have been added to a Conversation: + ${CONVERSATION}' + AddedToConversation.Sound: ring + RemovedFromConversation.Enabled: false + RemovedFromConversation.Template: 'You have been removed from a + Conversation: ${CONVERSATION}' + RemovedFromConversation.Sound: ring + LogEnabled: true get: description: Fetch push notification service settings + tags: + - ConversationsV1Notification parameters: - name: ChatServiceSid in: path @@ -6720,12 +9724,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_notification' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + log_enabled: false + added_to_conversation: + enabled: true + template: 'You have been added to a Conversation: ${CONVERSATION}' + sound: ring + new_message: + enabled: true + template: 'You have a new message in ${CONVERSATION} from ${PARTICIPANT}: + ${MESSAGE}' + badge_count_enabled: false + sound: ring + with_media: + enabled: false + template: 'You have a new message in ${CONVERSATION} with + ${MEDIA_COUNT} media files: ${MEDIA}' + removed_from_conversation: + enabled: true + template: 'You have been removed from a Conversation: ${CONVERSATION}' + sound: ring + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications description: OK security: - accountSid_authToken: [] operationId: FetchServiceNotification - x-maturity: - - GA /v1/Services/{ChatServiceSid}/ParticipantConversations: servers: - url: https://conversations.twilio.com @@ -6736,11 +9763,13 @@ paths: - chat_service_sid - participant_sid - conversation_sid - pathType: list parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified. + tags: + - ConversationsV1ParticipantConversation parameters: - name: ChatServiceSid in: path @@ -6760,6 +9789,11 @@ paths: Conversations SDK to communicate. Limited to 256 characters. schema: type: string + examples: + readEmpty: + value: identity + readFullByIdentity: + value: identity - name: Address in: query description: A unique string identifier for the conversation participant who's @@ -6767,6 +9801,9 @@ paths: field of Participant resource. It should be url-encoded. schema: type: string + examples: + readFullByAddress: + value: '+375255555555' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6799,34 +9836,112 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_participant_conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + conversations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + next_page_url: null + key: conversations + readFullByIdentity: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_friendly_name: friendly_name + conversation_state: inactive + conversation_timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + conversation_attributes: '{}' + conversation_date_created: '2015-07-30T20:00:00Z' + conversation_date_updated: '2015-07-30T20:00:00Z' + conversation_created_by: created_by + conversation_unique_name: unique_name + participant_user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_identity: identity + participant_messaging_binding: null + links: + participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + next_page_url: null + key: conversations + readFullByAddress: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_friendly_name: friendly_name + conversation_state: inactive + conversation_timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + conversation_attributes: '{}' + conversation_date_created: '2015-07-30T20:00:00Z' + conversation_date_updated: '2015-07-30T20:00:00Z' + conversation_created_by: created_by + conversation_unique_name: unique_name + participant_user_sid: null + participant_identity: null + participant_messaging_binding: + address: '+375255555555' + proxy_address: '+12345678910' + type: sms + level: null + name: null + projected_address: null + links: + participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListServiceParticipantConversation - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Roles: servers: - url: https://conversations.twilio.com @@ -6837,10 +9952,12 @@ paths: - sid - friendly_name - type - pathType: list parent: /Services/{Sid} + pathType: list post: description: Create a new user role in your service + tags: + - ConversationsV1Role parameters: - name: ChatServiceSid in: path @@ -6858,12 +9975,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateServiceRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6893,8 +10024,16 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: Conversation Role + Type: conversation + Permission: sendMessage get: description: Retrieve a list of all user roles in your service + tags: + - ConversationsV1Role parameters: - name: ChatServiceSid in: path @@ -6938,34 +10077,68 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListServiceRole - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Roles/{Sid}: servers: - url: https://conversations.twilio.com @@ -6976,10 +10149,12 @@ paths: - sid - friendly_name - type - pathType: instance parent: /Services/{Sid} + pathType: instance post: description: Update an existing user role in your service + tags: + - ConversationsV1Role parameters: - name: ChatServiceSid in: path @@ -7006,12 +10181,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateServiceRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7032,8 +10221,14 @@ paths: this parameter depend on the role's `type`. required: - Permission + examples: + update: + value: + Permission: sendMessage delete: description: Remove a user role from your service + tags: + - ConversationsV1Role parameters: - name: ChatServiceSid in: path @@ -7060,10 +10255,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceRole - x-maturity: - - GA get: description: Fetch a user role from your service + tags: + - ConversationsV1Role parameters: - name: ChatServiceSid in: path @@ -7090,12 +10285,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchServiceRole - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Users: servers: - url: https://conversations.twilio.com @@ -7105,12 +10314,18 @@ paths: defaultOutputProperties: - sid - identity - pathType: list dependentProperties: - user_conversation: '{chat_service_sid: chat_service_sid, user_sid: sid}' + user_conversations: + mapping: + chat_service_sid: chat_service_sid + user_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Users/{user_sid}/Conversations parent: /Services/{Sid} + pathType: list post: description: Add a new conversation user to your service + tags: + - ConversationsV1User parameters: - name: ChatServiceSid in: path @@ -7134,12 +10349,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: Created security: - accountSid_authToken: [] operationId: CreateServiceUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7168,8 +10398,17 @@ paths: to assign to the user. required: - Identity + examples: + create: + value: + Identity: admin + FriendlyName: name + Attributes: '{ "duty": "tech" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all conversation users in your service + tags: + - ConversationsV1User parameters: - name: ChatServiceSid in: path @@ -7213,34 +10452,72 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: agent0034 + friendly_name: John from customs + attributes: '{ "duty": "agent" }' + is_online: false + is_notifiable: null + date_created: '2020-03-24T20:38:21Z' + date_updated: '2020-03-24T20:38:21Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: ListServiceUser - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Users/{Sid}: servers: - url: https://conversations.twilio.com @@ -7250,12 +10527,18 @@ paths: defaultOutputProperties: - sid - identity - pathType: instance dependentProperties: - user_conversation: '{chat_service_sid: chat_service_sid, user_sid: sid}' + user_conversations: + mapping: + chat_service_sid: chat_service_sid + user_sid: sid + resource_url: /v1/Services/{chat_service_sid}/Users/{user_sid}/Conversations parent: /Services/{Sid} + pathType: instance post: description: Update an existing conversation user in your service + tags: + - ConversationsV1User parameters: - name: ChatServiceSid in: path @@ -7286,12 +10569,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: new name + attributes: '{ "duty": "tech", "team": "internals" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: UpdateServiceUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7313,8 +10611,16 @@ paths: pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user. + examples: + update: + value: + FriendlyName: new name + Attributes: '{ "duty": "tech", "team": "internals" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: Remove a conversation user from your service + tags: + - ConversationsV1User parameters: - name: ChatServiceSid in: path @@ -7345,10 +10651,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceUser - x-maturity: - - GA get: description: Fetch a conversation user from your service + tags: + - ConversationsV1User parameters: - name: ChatServiceSid in: path @@ -7373,12 +10679,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: FetchServiceUser - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}: servers: - url: https://conversations.twilio.com @@ -7391,11 +10712,13 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: instance parent: /Services/{ChatServiceSid}/Users/{Sid} mountName: user_conversations + pathType: instance post: description: Update a specific User Conversation. + tags: + - ConversationsV1UserConversation parameters: - name: ChatServiceSid in: path @@ -7427,12 +10750,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateServiceUserConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7455,8 +10801,16 @@ paths: nullable: true description: The index of the last Message in the Conversation that the Participant has read. + examples: + update: + value: + NotificationLevel: default + LastReadTimestamp: '2015-07-30T20:00:00Z' + LastReadMessageIndex: 100 delete: description: Delete a specific User Conversation. + tags: + - ConversationsV1UserConversation parameters: - name: ChatServiceSid in: path @@ -7488,10 +10842,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceUserConversation - x-maturity: - - GA get: description: Fetch a specific User Conversation. + tags: + - ConversationsV1UserConversation parameters: - name: ChatServiceSid in: path @@ -7523,12 +10877,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchServiceUserConversation - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations: servers: - url: https://conversations.twilio.com @@ -7541,11 +10918,13 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: list parent: /Services/{ChatServiceSid}/Users/{Sid} mountName: user_conversations + pathType: list get: description: Retrieve a list of all User Conversations for the User. + tags: + - ConversationsV1UserConversation parameters: - name: ChatServiceSid in: path @@ -7596,34 +10975,77 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + conversations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations + readFull: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListServiceUserConversation - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Configuration/Webhooks: servers: - url: https://conversations.twilio.com @@ -7633,10 +11055,12 @@ paths: x-twilio: defaultOutputProperties: - chat_service_sid - pathType: instance parent: /Services/{ChatServiceSid}/Configuration + pathType: instance post: description: Update a specific Webhook. + tags: + - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path @@ -7654,12 +11078,22 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + pre_webhook_url: https://www.example.com/pre + post_webhook_url: https://www.example.com/post + filters: + - onMessageRemoved + - onParticipantAdded + method: GET + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateServiceWebhookConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7694,8 +11128,19 @@ paths: type: string description: The HTTP method to be used when sending a webhook request. One of `GET` or `POST`. + examples: + update: + value: + PreWebhookUrl: https://www.example.com/pre + PostWebhookUrl: https://www.example.com/post + Filters: + - onMessageRemoved + - onParticipantAdded + Method: GET get: description: Fetch a specific service webhook configuration. + tags: + - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path @@ -7713,12 +11158,31 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + pre_webhook_url: https://www.example.com/pre + post_webhook_url: https://www.example.com/post + filters: + - onMessageRemove + - onParticipantAdd + method: POST + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks + fetchEmpty: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks + pre_webhook_url: null + post_webhook_url: null + filters: null + method: null description: OK security: - accountSid_authToken: [] operationId: FetchServiceWebhookConfiguration - x-maturity: - - GA /v1/Users: servers: - url: https://conversations.twilio.com @@ -7728,11 +11192,16 @@ paths: defaultOutputProperties: - sid - identity - pathType: list dependentProperties: - user_conversation: '{user_sid: sid}' + user_conversations: + mapping: + user_sid: sid + resource_url: /v1/Users/{user_sid}/Conversations + pathType: list post: description: Add a new conversation user to your account's default service + tags: + - ConversationsV1User parameters: - name: X-Twilio-Webhook-Enabled in: header @@ -7746,12 +11215,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: Created security: - accountSid_authToken: [] operationId: CreateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7780,9 +11264,18 @@ paths: to assign to the user. required: - Identity + examples: + create: + value: + Identity: admin + FriendlyName: name + Attributes: '{ "duty": "tech" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all conversation users in your account's default service + tags: + - ConversationsV1User parameters: - name: PageSize in: query @@ -7816,34 +11309,72 @@ paths: items: $ref: '#/components/schemas/conversations.v1.user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: agent0034 + friendly_name: John from customs + attributes: '{ "duty": "agent" }' + is_online: false + is_notifiable: null + date_created: '2020-03-24T20:38:21Z' + date_updated: '2020-03-24T20:38:21Z' + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: ListUser - x-maturity: - - GA /v1/Users/{Sid}: servers: - url: https://conversations.twilio.com @@ -7853,12 +11384,17 @@ paths: defaultOutputProperties: - sid - identity - pathType: instance dependentProperties: - user_conversation: '{user_sid: sid}' + user_conversations: + mapping: + user_sid: sid + resource_url: /v1/Users/{user_sid}/Conversations + pathType: instance post: description: Update an existing conversation user in your account's default service + tags: + - ConversationsV1User parameters: - name: Sid in: path @@ -7879,12 +11415,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: new name + attributes: '{ "duty": "tech", "team": "internals" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7906,8 +11457,16 @@ paths: pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user. + examples: + update: + value: + FriendlyName: new name + Attributes: '{ "duty": "tech", "team": "internals" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: Remove a conversation user from your account's default service + tags: + - ConversationsV1User parameters: - name: Sid in: path @@ -7928,10 +11487,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUser - x-maturity: - - GA get: description: Fetch a conversation user from your account's default service + tags: + - ConversationsV1User parameters: - name: Sid in: path @@ -7946,12 +11505,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - GA /v1/Users/{UserSid}/Conversations/{ConversationSid}: servers: - url: https://conversations.twilio.com @@ -7964,11 +11538,13 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: instance parent: /Users/{Sid} mountName: user_conversations + pathType: instance post: description: Update a specific User Conversation. + tags: + - ConversationsV1UserConversation parameters: - name: UserSid in: path @@ -7990,12 +11566,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.user.user_conversation' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUserConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -8018,8 +11617,16 @@ paths: nullable: true description: The index of the last Message in the Conversation that the Participant has read. + examples: + update: + value: + NotificationLevel: default + LastReadTimestamp: '2015-07-30T20:00:00Z' + LastReadMessageIndex: 100 delete: description: Delete a specific User Conversation. + tags: + - ConversationsV1UserConversation parameters: - name: UserSid in: path @@ -8041,10 +11648,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserConversation - x-maturity: - - GA get: description: Fetch a specific User Conversation. + tags: + - ConversationsV1UserConversation parameters: - name: UserSid in: path @@ -8066,12 +11673,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.user.user_conversation' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUserConversation - x-maturity: - - GA /v1/Users/{UserSid}/Conversations: servers: - url: https://conversations.twilio.com @@ -8084,11 +11714,13 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: list parent: /Users/{Sid} mountName: user_conversations + pathType: list get: description: Retrieve a list of all User Conversations for the User. + tags: + - ConversationsV1UserConversation parameters: - name: UserSid in: path @@ -8129,36 +11761,95 @@ paths: items: $ref: '#/components/schemas/conversations.v1.user.user_conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + conversations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations + readFull: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListUserConversation - x-maturity: - - GA servers: - url: https://conversations.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: ConversationsV1AddressConfiguration +- name: ConversationsV1Binding +- name: ConversationsV1ChannelMetadata +- name: ConversationsV1Configuration +- name: ConversationsV1Conversation +- name: ConversationsV1Credential +- name: ConversationsV1DeliveryReceipt +- name: ConversationsV1Message +- name: ConversationsV1Notification +- name: ConversationsV1Participant +- name: ConversationsV1ParticipantConversation +- name: ConversationsV1Role +- name: ConversationsV1Service +- name: ConversationsV1User +- name: ConversationsV1UserConversation +- name: ConversationsV1Webhook +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_events_v1.yaml b/spec/yaml/twilio_events_v1.yaml index 41b4d36c..b094d2fb 100644 --- a/spec/yaml/twilio_events_v1.yaml +++ b/spec/yaml/twilio_events_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: events.v1.event_type: type: object @@ -187,7 +191,7 @@ components: schema_version: type: integer nullable: true - description: The schema version that the subscription should use. + description: The schema version that the Subscription should use. subscription_sid: type: string minLength: 34 @@ -252,10 +256,6 @@ components: nullable: true description: Contains a dictionary of URL links to nested resources of this Subscription. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Events description: This is the public Twilio REST API. @@ -267,7 +267,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Types: @@ -279,10 +279,12 @@ paths: - type - schema_id - description - pathType: list mountName: event_types + pathType: list get: description: Retrieve a paginated list of all the available Event Types. + tags: + - EventsV1EventType parameters: - name: SchemaId in: query @@ -290,6 +292,9 @@ paths: Types using a given schema. schema: type: string + examples: + readResultsWithSchemaId: + value: Messaging.MessageStatus - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -322,34 +327,102 @@ paths: items: $ref: '#/components/schemas/events.v1.event_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + types: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Types?PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Types?PageSize=10&Page=0 + next_page_url: null + key: types + readResults: + value: + types: + - date_created: '2020-08-13T13:28:20Z' + date_updated: '2020-08-13T13:28:20Z' + type: com.twilio.messaging.message.delivered + schema_id: Messaging.MessageStatus + public: true + description: Messaging- delivered message + url: https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered + links: + schema: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions + - date_created: '2020-08-13T13:28:19Z' + date_updated: '2020-08-13T13:28:19Z' + type: com.twilio.messaging.message.failed + schema_id: Messaging.MessageStatus + public: true + description: Messaging- failed message + url: https://events.twilio.com/v1/Types/com.twilio.messaging.message.failed + links: + schema: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Types?PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Types?PageSize=20&Page=0 + next_page_url: null + key: types + readResultsWithSchemaId: + value: + types: + - date_created: '2020-08-13T13:28:20Z' + date_updated: '2020-08-13T13:28:20Z' + type: com.twilio.messaging.message.delivered + schema_id: Messaging.MessageStatus + public: true + description: Messaging- delivered message + url: https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered + links: + schema: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions + - date_created: '2020-08-13T13:28:19Z' + date_updated: '2020-08-13T13:28:19Z' + type: com.twilio.messaging.message.failed + schema_id: Messaging.MessageStatus + public: true + description: Messaging- failed message + url: https://events.twilio.com/v1/Types/com.twilio.messaging.message.failed + links: + schema: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Types?SchemaId=Messaging.MessageStatus&PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Types?SchemaId=Messaging.MessageStatus&PageSize=20&Page=0 + next_page_url: null + key: types description: OK security: - accountSid_authToken: [] operationId: ListEventType - x-maturity: - - Beta /v1/Types/{Type}: servers: - url: https://events.twilio.com @@ -359,10 +432,12 @@ paths: - type - schema_id - description - pathType: instance mountName: event_types + pathType: instance get: description: Fetch a specific Event Type. + tags: + - EventsV1EventType parameters: - name: Type in: path @@ -376,12 +451,22 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.event_type' + examples: + fetch: + value: + date_created: '2020-08-13T13:28:20Z' + date_updated: '2020-08-13T13:28:20Z' + type: com.twilio.messaging.message.delivered + schema_id: Messaging.MessageStatus + public: true + description: Messaging- delivered message + url: https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered + links: + schema: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions description: OK security: - accountSid_authToken: [] operationId: FetchEventType - x-maturity: - - Beta /v1/Schemas/{Id}: servers: - url: https://events.twilio.com @@ -389,11 +474,16 @@ paths: x-twilio: defaultOutputProperties: - id - pathType: instance dependentProperties: - schema_version: '{id: id}' + versions: + mapping: + id: id + resource_url: /v1/Schemas/{id}/Versions + pathType: instance get: description: Fetch a specific schema with its nested versions. + tags: + - EventsV1Schema parameters: - name: Id in: path @@ -408,12 +498,19 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.schema' + examples: + fetch: + value: + id: Messaging.MessageStatus + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus + latest_version_date_created: '2020-07-30T20:00:00Z' + latest_version: 1 + links: + versions: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions description: OK security: - accountSid_authToken: [] operationId: FetchSchema - x-maturity: - - Beta /v1/Schemas: servers: - url: https://events.twilio.com @@ -421,9 +518,12 @@ paths: x-twilio: defaultOutputProperties: - id - pathType: list dependentProperties: - schema_version: '{id: id}' + versions: + mapping: + id: id + resource_url: /v1/Schemas/{id}/Versions + pathType: list /v1/Schemas/{Id}/Versions: servers: - url: https://events.twilio.com @@ -433,11 +533,13 @@ paths: - id - schema_version - date_created - pathType: list parent: /Schemas/{Id} className: schema_version + pathType: list get: description: Retrieve a paginated list of versions of the schema. + tags: + - EventsV1SchemaVersion parameters: - name: Id in: path @@ -478,34 +580,67 @@ paths: items: $ref: '#/components/schemas/events.v1.schema.schema_version' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + schema_versions: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=10&Page=0 + next_page_url: null + key: schema_versions + readResults: + value: + schema_versions: + - id: Messaging.MessageStatus + schema_version: 1 + public: true + date_created: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/1 + raw: https://events-schemas.twilio.com/Messaging.MessageStatus/1 + - id: Messaging.MessageStatus + schema_version: 2 + public: true + date_created: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/2 + raw: https://events-schemas.twilio.com/Messaging.MessageStatus/2 + meta: + page: 0 + page_size: 50 + first_page_url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=50&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=50&Page=0 + next_page_url: null + key: schema_versions description: OK security: - accountSid_authToken: [] operationId: ListSchemaVersion - x-maturity: - - Beta /v1/Schemas/{Id}/Versions/{SchemaVersion}: servers: - url: https://events.twilio.com @@ -515,11 +650,13 @@ paths: - id - schema_version - date_created - pathType: instance parent: /Schemas/{Id} className: schema_version + pathType: instance get: description: Fetch a specific schema and version. + tags: + - EventsV1SchemaVersion parameters: - name: Id in: path @@ -540,12 +677,19 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.schema.schema_version' + examples: + fetch: + value: + id: Messaging.MessageStatus + schema_version: 1 + public: true + date_created: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/1 + raw: https://events-schemas.twilio.com/Messaging.MessageStatus/1 description: OK security: - accountSid_authToken: [] operationId: FetchSchemaVersion - x-maturity: - - Beta /v1/Sinks/{Sid}: servers: - url: https://events.twilio.com @@ -559,12 +703,20 @@ paths: - sink_configuration - sink_type - status - pathType: instance dependentProperties: - sink_test: '{sid: sid}' - sink_validate: '{sid: sid}' + sink_test: + mapping: + sid: sid + resource_url: /v1/Sinks/{sid}/Test + sink_validate: + mapping: + sid: sid + resource_url: /v1/Sinks/{sid}/Validate + pathType: instance get: description: Fetch a specific Sink. + tags: + - EventsV1Sink parameters: - name: Sid in: path @@ -581,14 +733,31 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.sink' + examples: + fetch: + value: + status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:111111111:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: A Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate description: OK security: - accountSid_authToken: [] operationId: FetchSink - x-maturity: - - Beta delete: description: Delete a specific Sink. + tags: + - EventsV1Sink parameters: - name: Sid in: path @@ -605,10 +774,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSink - x-maturity: - - Beta post: description: Update a specific Sink + tags: + - EventsV1Sink parameters: - name: Sid in: path @@ -625,12 +794,27 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.sink' + examples: + update: + value: + status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:111111111:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: My Kinesis Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate description: OK security: - accountSid_authToken: [] operationId: UpdateSink - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -644,6 +828,10 @@ paths: should not contain PII.** required: - Description + examples: + update: + value: + Description: My Kinesis Sink /v1/Sinks: servers: - url: https://events.twilio.com @@ -657,24 +845,61 @@ paths: - sink_configuration - sink_type - status - pathType: list dependentProperties: - sink_test: '{sid: sid}' - sink_validate: '{sid: sid}' + sink_test: + mapping: + sid: sid + resource_url: /v1/Sinks/{sid}/Test + sink_validate: + mapping: + sid: sid + resource_url: /v1/Sinks/{sid}/Validate + pathType: list post: description: Create a new Sink + tags: + - EventsV1Sink responses: '201': content: application/json: schema: $ref: '#/components/schemas/events.v1.sink' + examples: + create: + value: + status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:111111111:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: My Kinesis Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate + createSegment: + value: + status: initialized + sink_configuration: + write_key: MY_WRITEKEY + description: My segment Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sink_type: segment + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate description: Created security: - accountSid_authToken: [] operationId: CreateSink - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -697,9 +922,23 @@ paths: - Description - SinkConfiguration - SinkType + examples: + create: + value: + Description: My Kinesis Sink + SinkType: kinesis + SinkConfiguration: '{"arn": "arn:aws:kinesis:us-east-1:111111111:stream/test","role_arn": + "arn:aws:iam::111111111:role/Role","external_id": "1234567890"}' + createSegment: + value: + Description: My segment Sink + SinkType: segment + SinkConfiguration: '{"write_key": "MY_WRITEKEY"}' get: description: Retrieve a paginated list of Sinks belonging to the account used to make the request. + tags: + - EventsV1Sink parameters: - name: InUse in: query @@ -707,12 +946,18 @@ paths: used/not used by a subscription. schema: type: boolean + examples: + readResultsInUse: + value: true - name: Status in: query description: A String query parameter filtering the results by status `initialized`, `validating`, `active` or `failed`. schema: type: string + examples: + readResultsStatus: + value: active - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -745,34 +990,175 @@ paths: items: $ref: '#/components/schemas/events.v1.sink' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sinks: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Sinks?PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Sinks?PageSize=10&Page=0 + next_page_url: null + key: sinks + readResults: + value: + sinks: + - status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:111111111:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: A Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T19:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate + - status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:222222222:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: ANOTHER Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + date_created: '2015-07-30T20:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Validate + - status: active + sink_configuration: + destination: http://example.org/webhook + method: POST + batch_events: true + description: A webhook Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + date_created: '2015-07-30T21:00:00Z' + sink_type: webhook + date_updated: '2015-07-30T21:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Sinks?PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Sinks?PageSize=20&Page=0 + next_page_url: null + key: sinks + readResultsInUse: + value: + sinks: + - status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:111111111:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: A Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T19:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate + - status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:222222222:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: ANOTHER Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + date_created: '2015-07-30T20:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Validate + - status: active + sink_configuration: + destination: http://example.org/webhook + method: POST + batch_events: true + description: A webhook Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + date_created: '2015-07-30T21:00:00Z' + sink_type: webhook + date_updated: '2015-07-30T21:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Sinks?InUse=True&PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Sinks?InUse=True&PageSize=20&Page=0 + next_page_url: null + key: sinks + readResultsStatus: + value: + sinks: + - status: active + sink_configuration: + destination: http://example.org/webhook + method: POST + batch_events: true + description: A webhook Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + date_created: '2015-07-30T21:00:00Z' + sink_type: webhook + date_updated: '2015-07-30T21:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Sinks?Status=active&PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Sinks?Status=active&PageSize=20&Page=0 + next_page_url: null + key: sinks description: OK security: - accountSid_authToken: [] operationId: ListSink - x-maturity: - - Beta /v1/Sinks/{Sid}/Test: servers: - url: https://events.twilio.com @@ -780,11 +1166,13 @@ paths: x-twilio: defaultOutputProperties: - result - pathType: list parent: /Sinks/{Sid} mountName: sink_test + pathType: list post: description: Create a new Sink Test Event for the given Sink. + tags: + - EventsV1SinkTest parameters: - name: Sid in: path @@ -802,12 +1190,14 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.sink.sink_test' + examples: + create: + value: + result: submitted description: Created security: - accountSid_authToken: [] operationId: CreateSinkTest - x-maturity: - - Beta /v1/Sinks/{Sid}/Validate: servers: - url: https://events.twilio.com @@ -815,11 +1205,13 @@ paths: x-twilio: defaultOutputProperties: - result - pathType: list parent: /Sinks/{Sid} mountName: sink_validate + pathType: list post: description: Validate that a test event for a Sink was received. + tags: + - EventsV1SinkValidate parameters: - name: Sid in: path @@ -837,12 +1229,14 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.sink.sink_validate' + examples: + create: + value: + result: valid description: Created security: - accountSid_authToken: [] operationId: CreateSinkValidate - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -856,20 +1250,26 @@ paths: test event for a Sink being validated. required: - TestId + examples: + create: + value: + TestId: TestID /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents: servers: - url: https://events.twilio.com - description: Event subscribed to in the parent subscription + description: Event subscribed to in the parent Subscription x-twilio: defaultOutputProperties: - type - schema_version - account_sid - subscription_sid - pathType: list parent: /Subscriptions/{Sid} + pathType: list get: description: Retrieve a list of all Subscribed Event types for a Subscription. + tags: + - EventsV1SubscribedEvent parameters: - name: SubscriptionSid in: path @@ -912,36 +1312,69 @@ paths: items: $ref: '#/components/schemas/events.v1.subscription.subscribed_event' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + types: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=10&Page=0 + next_page_url: null + key: types + readResults: + value: + types: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: com.twilio.messaging.message.delivered + schema_version: 2 + subscription_sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: com.twilio.messaging.message.failed + schema_version: 15 + subscription_sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.failed + meta: + page: 0 + page_size: 50 + first_page_url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=50&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=50&Page=0 + next_page_url: null + key: types description: OK security: - accountSid_authToken: [] operationId: ListSubscribedEvent - x-maturity: - - Beta post: - description: Create a new Subscribed Event type for the subscription + description: Add an event type to a Subscription. + tags: + - EventsV1SubscribedEvent parameters: - name: SubscriptionSid in: path @@ -958,12 +1391,18 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.subscription.subscribed_event' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subscription_sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: com.twilio.messaging.message.delivered + schema_version: 2 + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered description: Created security: - accountSid_authToken: [] operationId: CreateSubscribedEvent - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -976,23 +1415,30 @@ paths: description: Type of event being subscribed to. SchemaVersion: type: integer - description: The schema version that the subscription should use. + description: The schema version that the Subscription should use. required: - Type + examples: + create: + value: + Type: com.twilio.messaging.message.delivered + SchemaVersion: 2 /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type}: servers: - url: https://events.twilio.com - description: Event subscribed to in the parent subscription + description: Event subscribed to in the parent Subscription x-twilio: defaultOutputProperties: - type - schema_version - account_sid - subscription_sid - pathType: instance parent: /Subscriptions/{Sid} + pathType: instance get: description: Read an Event for a Subscription. + tags: + - EventsV1SubscribedEvent parameters: - name: SubscriptionSid in: path @@ -1015,14 +1461,22 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.subscription.subscribed_event' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subscription_sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: com.twilio.messaging.message.delivered + schema_version: 2 + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered description: OK security: - accountSid_authToken: [] operationId: FetchSubscribedEvent - x-maturity: - - Beta post: description: Update an Event for a Subscription. + tags: + - EventsV1SubscribedEvent parameters: - name: SubscriptionSid in: path @@ -1045,12 +1499,18 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.subscription.subscribed_event' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subscription_sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: com.twilio.messaging.message.delivered + schema_version: 2 + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered description: OK security: - accountSid_authToken: [] operationId: UpdateSubscribedEvent - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1060,9 +1520,15 @@ paths: properties: SchemaVersion: type: integer - description: The schema version that the subscription should use. + description: The schema version that the Subscription should use. + examples: + update: + value: + SchemaVersion: 2 delete: - description: Remove an event type from a subscription. + description: Remove an event type from a Subscription. + tags: + - EventsV1SubscribedEvent parameters: - name: SubscriptionSid in: path @@ -1085,8 +1551,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSubscribedEvent - x-maturity: - - Beta /v1/Subscriptions: servers: - url: https://events.twilio.com @@ -1098,12 +1562,17 @@ paths: - sink_sid - date_created - date_updated - pathType: list dependentProperties: - subscribed_event: '{subscription_sid: sid}' + subscribed_events: + mapping: + subscription_sid: sid + 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. + tags: + - EventsV1Subscription parameters: - name: SinkSid in: query @@ -1114,6 +1583,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^DG[0-9a-fA-F]{32}$ + examples: + readResultsFilteredBySinkSid: + value: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1146,48 +1618,129 @@ paths: items: $ref: '#/components/schemas/events.v1.subscription' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + subscriptions: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Subscriptions?PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Subscriptions?PageSize=10&Page=0 + next_page_url: null + key: subscriptions + readResults: + value: + subscriptions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: A subscription + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Another subscription + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/SubscribedEvents + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Subscriptions?PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Subscriptions?PageSize=20&Page=0 + next_page_url: null + key: subscriptions + readResultsFilteredBySinkSid: + value: + subscriptions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: A subscription + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Another subscription + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/SubscribedEvents + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Subscriptions?SinkSid=DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Subscriptions?SinkSid=DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=10&Page=0 + next_page_url: null + key: subscriptions description: OK security: - accountSid_authToken: [] operationId: ListSubscription - x-maturity: - - Beta post: description: Create a new Subscription. + 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 description: Created security: - accountSid_authToken: [] operationId: CreateSubscription - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1216,6 +1769,16 @@ paths: - Description - SinkSid - Types + examples: + create: + value: + SinkSid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Description: A subscription + Types: + - '{"type": "com.twilio.messaging.message.delivered","schema_version": + 1}' + - '{"type": "com.twilio.messaging.message.failed","schema_version": + 12}' /v1/Subscriptions/{Sid}: servers: - url: https://events.twilio.com @@ -1227,11 +1790,16 @@ paths: - sink_sid - date_created - date_updated - pathType: instance dependentProperties: - subscribed_event: '{subscription_sid: sid}' + subscribed_events: + mapping: + subscription_sid: sid + resource_url: /v1/Subscriptions/{subscription_sid}/SubscribedEvents + pathType: instance get: description: Fetch a specific Subscription. + tags: + - EventsV1Subscription parameters: - name: Sid in: path @@ -1248,14 +1816,26 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.subscription' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: A subscription + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents description: OK security: - accountSid_authToken: [] operationId: FetchSubscription - x-maturity: - - Beta post: description: Update a Subscription. + tags: + - EventsV1Subscription parameters: - name: Sid in: path @@ -1272,12 +1852,22 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.subscription' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2020-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + description: Updated description + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents description: OK security: - accountSid_authToken: [] operationId: UpdateSubscription - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1296,8 +1886,15 @@ paths: description: The SID of the sink that events selected by this subscription should be sent to. Sink must be active for the subscription to be created. + examples: + update: + value: + SinkSid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + Description: Updated description delete: description: Delete a specific Subscription. + tags: + - EventsV1Subscription parameters: - name: Sid in: path @@ -1314,11 +1911,16 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSubscription - x-maturity: - - Beta servers: - url: https://events.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: EventsV1EventType +- name: EventsV1Schema +- name: EventsV1SchemaVersion +- name: EventsV1Sink +- name: EventsV1SinkTest +- name: EventsV1SinkValidate +- name: EventsV1SubscribedEvent +- name: EventsV1Subscription +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_flex_v1.yaml b/spec/yaml/twilio_flex_v1.yaml index 2f141f69..9ed4f7b3 100644 --- a/spec/yaml/twilio_flex_v1.yaml +++ b/spec/yaml/twilio_flex_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: flex.v1.channel: type: object @@ -162,6 +166,13 @@ components: pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flex service instance. + flex_instance_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GO[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex instance. ui_language: type: string nullable: true @@ -279,12 +290,118 @@ components: flex_ui_status_report: nullable: true description: Configurable parameters for Flex UI Status report. + agent_conv_end_methods: + nullable: true + description: Agent conversation end methods. + citrix_voice_vdi: + nullable: true + description: Citrix voice vdi configuration and settings. + offline_config: + nullable: true + description: Presence and presence ttl configuration configuration_enum_status: type: string enum: - ok - inprogress - notstarted + flex.v1.plugin_configuration.configured_plugin: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that the Flex Plugin resource is installed for. + configuration_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FJ[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Plugin Configuration that this Flex Plugin + belongs to. + plugin_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FP[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Plugin. + plugin_version_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FV[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Plugin Version. + phase: + type: integer + nullable: true + description: The phase this Flex Plugin would initialize at runtime. + plugin_url: + type: string + nullable: true + description: The URL of where the Flex Plugin Version JavaScript bundle + is hosted on. + x-twilio: + pii: + handling: standard + deleteSla: 30 + unique_name: + type: string + nullable: true + description: The name that uniquely identifies this Flex Plugin resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + friendly_name: + type: string + nullable: true + description: The friendly name of this Flex Plugin resource. + description: + type: string + nullable: true + description: A descriptive string that you create to describe the plugin + resource. It can be up to 500 characters long + plugin_archived: + type: boolean + nullable: true + description: Whether the Flex Plugin is archived. The default value is false. + version: + type: string + nullable: true + description: The latest version of this Flex Plugin Version. + changelog: + type: string + nullable: true + description: A changelog that describes the changes this Flex Plugin Version + brings. + plugin_version_archived: + type: boolean + nullable: true + description: Whether the Flex Plugin Version is archived. The default value + is false. + private: + type: boolean + nullable: true + description: Whether to validate the request is authorized to access the + Flex Plugin Version. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin was installed + 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 Flex Plugin resource. flex.v1.flex_flow: type: object properties: @@ -320,6 +437,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 chat_service_sid: type: string minLength: 34 @@ -508,6 +629,42 @@ components: type: string format: uri nullable: true + 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 + insights_conversational_ai_enum_type: + type: string + enum: + - metrics + - summary + 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 + - mean_trend + - scored_mean_trend + - total_trend flex.v1.insights_conversations: type: object properties: @@ -840,6 +997,12 @@ components: type: object format: uri-map nullable: true + interaction_context_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HQ[0-9a-fA-F]{32}$ + nullable: true flex.v1.interaction.interaction_channel: type: object properties: @@ -864,10 +1027,10 @@ components: $ref: '#/components/schemas/interaction_channel_enum_type' nullable: true description: "The Interaction Channel's type. Can be: `sms`, `email`, `chat`,\ - \ `whatsapp`, `web`. \n **Note:** These can be different from the task\ - \ channel type specified in the Routing attributes. Task channel type\ - \ corresponds to channel capacity while this channel type is the actual\ - \ media type" + \ `whatsapp`, `web`, `messenger`, or `gbm`. \n **Note:** These can be\ + \ different from the task channel type specified in the Routing attributes.\ + \ Task channel type corresponds to channel capacity while this channel\ + \ type is the actual media type" status: type: string $ref: '#/components/schemas/interaction_channel_enum_channel_status' @@ -912,6 +1075,28 @@ components: - active - failed - closed + - inactive + interaction_channel_enum_update_channel_status: + type: string + enum: + - closed + - 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: @@ -994,6 +1179,9 @@ components: type: string format: uri nullable: true + routing_properties: + nullable: true + description: The Participant's routing properties. interaction_channel_participant_enum_status: type: string enum: @@ -1007,9 +1195,17 @@ components: - external - agent - unknown - flex.v1.web_channel: + flex.v1.plugin: type: object properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FP[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Flex Plugin + resource. account_sid: type: string minLength: 34 @@ -1017,275 +1213,2325 @@ components: 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 WebChannel resource and owns this Workflow. - flex_flow_sid: + that created the Flex Plugin resource and owns this resource. + unique_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^FO[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flex Flow. + description: The name that uniquely identifies this Flex Plugin resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + friendly_name: + type: string + nullable: true + description: The friendly name this Flex Plugin resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + description: + type: string + nullable: true + description: A descriptive string that you create to describe the plugin + resource. It can be up to 500 characters long + x-twilio: + pii: + handling: standard + deleteSla: 30 + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin is archived. The default value is false. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT-7 when the Flex Plugin 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-7 when the Flex Plugin 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 Flex Plugin resource. + links: + type: object + format: uri-map + nullable: true + flex.v1.plugin_archive: + type: object + properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ + pattern: ^FP[0-9a-fA-F]{32}$ nullable: true - description: The unique string that we created to identify the WebChannel + description: The unique string that we created to identify the Flex Plugin resource. - url: + account_sid: type: string - format: uri + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The absolute URL of the WebChannel resource. + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Flex Plugin resource and owns this resource. + unique_name: + type: string + nullable: true + description: The name that uniquely identifies this Flex Plugin resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + friendly_name: + type: string + nullable: true + description: The friendly name this Flex Plugin resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + description: + type: string + nullable: true + description: A descriptive string that you create to describe the plugin + resource. It can be up to 500 characters long + x-twilio: + pii: + handling: standard + deleteSla: 30 + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin is archived. The default value is false. date_created: type: string format: date-time nullable: true - description: The date and time in GMT when the resource was created specified + description: The date and time in GMT when the Flex Plugin 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 + description: The date and time in GMT when the Flex Plugin was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - web_channel_enum_chat_status: - type: string - enum: - - inactive - securitySchemes: - accountSid_authToken: - type: http - scheme: basic -info: - title: Twilio - Flex - description: This is the public Twilio REST API. - termsOfService: https://www.twilio.com/legal/tos - contact: - name: Twilio Support - url: https://support.twilio.com - email: support@twilio.com - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 -openapi: 3.0.1 -paths: - /v1/Channels: - servers: - - url: https://flex-api.twilio.com - description: Flex chat channels - x-twilio: - defaultOutputProperties: - - sid - - flex_flow_sid - - user_sid - - task_sid - pathType: list - mountName: channel - get: - description: '' - 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: + url: type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListChannelResponse - properties: - flex_chat_channels: - type: array - items: - $ref: '#/components/schemas/flex.v1.channel' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListChannel - x-maturity: - - GA - post: - description: '' - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/flex.v1.channel' - description: Created - security: + format: uri + nullable: true + description: The absolute URL of the Flex Plugin resource. + flex.v1.plugin_configuration: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FJ[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Flex Plugin + Configuration 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/iam/api/account) + that created the Flex Plugin Configuration resource and owns this resource. + name: + type: string + nullable: true + description: The name of this Flex Plugin Configuration. + description: + type: string + nullable: true + description: The description of the Flex Plugin Configuration resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin Configuration is archived. The default + value is false. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin Configuration + was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Flex Plugin Configuration resource. + links: + type: object + format: uri-map + nullable: true + flex.v1.plugin_configuration_archive: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FJ[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Flex Plugin + Configuration 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/iam/api/account) + that created the Flex Plugin Configuration resource and owns this resource. + name: + type: string + nullable: true + description: The name of this Flex Plugin Configuration. + description: + type: string + nullable: true + description: The description of the Flex Plugin Configuration resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin Configuration is archived. The default + value is false. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin Configuration + was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Flex Plugin Configuration resource. + flex.v1.plugin_release: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FK[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Plugin Release + 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/iam/api/account) + that created the Plugin Release resource and owns this resource. + configuration_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FJ[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Plugin Configuration resource to release. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin Release was created + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Plugin Release resource. + flex.v1.plugin.plugin_version: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FV[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Flex Plugin + Version resource. + plugin_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FP[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Plugin resource this Flex Plugin Version + belongs to. + 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 Flex Plugin Version resource and owns this resource. + version: + type: string + nullable: true + description: The unique version of this Flex Plugin Version. + plugin_url: + type: string + format: uri + nullable: true + description: The URL of where the Flex Plugin Version JavaScript bundle + is hosted on. + x-twilio: + pii: + handling: standard + deleteSla: 30 + changelog: + type: string + nullable: true + description: A changelog that describes the changes this Flex Plugin Version + brings. + x-twilio: + pii: + handling: standard + deleteSla: 30 + private: + type: boolean + nullable: true + description: Whether to inject credentials while accessing this Plugin Version. + The default value is false. + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin Version is archived. The default value + is false. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin Version was created + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Flex Plugin Version resource. + flex.v1.plugin_version_archive: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FV[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Flex Plugin + Version resource. + plugin_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FP[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Plugin resource this Flex Plugin Version + belongs to. + 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 Flex Plugin Version resource and owns this resource. + version: + type: string + nullable: true + description: The unique version of this Flex Plugin Version. + plugin_url: + type: string + format: uri + nullable: true + description: The URL of where the Flex Plugin Version JavaScript bundle + is hosted on. + x-twilio: + pii: + handling: standard + deleteSla: 30 + changelog: + type: string + nullable: true + description: A changelog that describes the changes this Flex Plugin Version + brings. + x-twilio: + pii: + handling: standard + deleteSla: 30 + private: + type: boolean + nullable: true + description: Whether to inject credentials while accessing this Plugin Version. + The default value is false. + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin Version is archived. The default value + is false. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin Version was created + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Flex Plugin Version resource. + flex.v1.provisioning_status: + type: object + properties: + status: + type: string + $ref: '#/components/schemas/provisioning_status_enum_status' + nullable: true + description: Email Provisioning Status + url: + type: string + format: uri + nullable: true + description: The absolute URL of the resource. + provisioning_status_enum_status: + type: string + enum: + - active + - in-progress + - not-configured + - 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: + 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 WebChannel resource and owns this Workflow. + flex_flow_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FO[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Flow. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the WebChannel + resource. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the WebChannel 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. + web_channel_enum_chat_status: + type: string + enum: + - inactive +info: + title: Twilio - Flex + 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/Channels: + servers: + - url: https://flex-api.twilio.com + description: Flex chat channels + x-twilio: + defaultOutputProperties: + - sid + - flex_flow_sid + - user_sid + - task_sid + mountName: channel + pathType: list + get: + description: '' + tags: + - FlexV1Channel + 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: ListChannelResponse + properties: + flex_chat_channels: + type: array + items: + $ref: '#/components/schemas/flex.v1.channel' + 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: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 + next_page_url: null + key: flex_chat_channels + flex_chat_channels: + - flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 + next_page_url: null + key: flex_chat_channels + flex_chat_channels: [] + description: OK + security: + - accountSid_authToken: [] + operationId: ListChannel + post: + description: '' + tags: + - FlexV1Channel + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.channel' + examples: + create: + value: + flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateChannel + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateChannelRequest + properties: + FlexFlowSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FO[0-9a-fA-F]{32}$ + description: The SID of the Flex Flow. + Identity: + type: string + description: The `identity` value that uniquely identifies the new + resource's chat User. + ChatUserFriendlyName: + type: string + description: The chat participant's friendly name. + ChatFriendlyName: + type: string + description: The chat channel's friendly name. + Target: + type: string + description: The Target Contact Identity, for example the phone + number of an SMS. + ChatUniqueName: + type: string + description: The chat channel's unique name. + PreEngagementData: + type: string + description: The pre-engagement data. + TaskSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WT[0-9a-fA-F]{32}$ + description: The SID of the TaskRouter Task. Only valid when integration + type is `task`. `null` for integration types `studio` & `external` + TaskAttributes: + type: string + description: The Task attributes to be added for the TaskRouter + Task. + LongLived: + type: boolean + description: Whether to create the channel as long-lived. + required: + - FlexFlowSid + - Identity + - ChatUserFriendlyName + - ChatFriendlyName + examples: + create: + value: + FlexFlowSid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Target: def + Identity: abc + ChatUserFriendlyName: friendly2 + ChatFriendlyName: friendly1 + ChatUniqueName: unique + PreEngagementData: '{}' + TaskSid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + TaskAttributes: '{}' + LongLived: true + /v1/Channels/{Sid}: + servers: + - url: https://flex-api.twilio.com + description: Flex chat channels + x-twilio: + defaultOutputProperties: + - sid + - flex_flow_sid + - user_sid + - task_sid + mountName: channel + pathType: instance + get: + description: '' + tags: + - FlexV1Channel + parameters: + - name: Sid + in: path + description: The SID of the Flex chat channel resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.channel' + examples: + fetch: + value: + flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchChannel + delete: + description: '' + tags: + - FlexV1Channel + parameters: + - name: Sid + in: path + description: The SID of the Flex chat channel resource to delete. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteChannel + /v1/Configuration: + servers: + - url: https://flex-api.twilio.com + description: Configuration for a Flex instance + x-twilio: + defaultOutputProperties: + - status + - ui_language + - ui_version + - service_version + pathType: instance + get: + description: '' + tags: + - FlexV1Configuration + parameters: + - name: UiVersion + in: query + description: The Pinned UI version of the Configuration resource to fetch. + schema: + type: string + responses: + '200': + content: + 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 + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateConfiguration + requestBody: + content: + application/json: + schema: + type: object + title: UpdateConfigurationRequest + properties: {} + /v1/PluginService/Configurations/{ConfigurationSid}/Plugins: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - plugin_sid + - plugin_version_sid + - plugin_url + - phase + parent: /PluginService/Configurations/{Sid} + className: configured_plugin + pathType: list + get: + description: '' + tags: + - FlexV1ConfiguredPlugin + parameters: + - name: ConfigurationSid + in: path + description: The SID of the Flex Plugin Configuration the resource to belongs + to. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + - 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: ListConfiguredPluginResponse + properties: + plugins: + type: array + items: + $ref: '#/components/schemas/flex.v1.plugin_configuration.configured_plugin' + 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: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: ListConfiguredPlugin + /v1/PluginService/Configurations/{ConfigurationSid}/Plugins/{PluginSid}: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - plugin_sid + - plugin_version_sid + - plugin_url + - phase + parent: /PluginService/Configurations/{Sid} + className: configured_plugin + pathType: instance + get: + description: '' + tags: + - FlexV1ConfiguredPlugin + parameters: + - name: ConfigurationSid + in: path + description: The SID of the Flex Plugin Configuration the resource to belongs + to. + schema: + type: string + required: true + - name: PluginSid + in: path + description: The unique string that we created to identify the Flex Plugin + resource. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + 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 + /v1/FlexFlows: + servers: + - url: https://flex-api.twilio.com + description: Flex Flow + x-twilio: + defaultOutputProperties: + - sid + - friendly_name + - channel_type + - integration_type + mountName: flex_flow + pathType: list + get: + description: '' + tags: + - FlexV1FlexFlow + parameters: + - name: FriendlyName + in: query + description: The `friendly_name` of the Flex Flow resources to read. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + - 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: ListFlexFlowResponse + properties: + flex_flows: + type: array + items: + $ref: '#/components/schemas/flex.v1.flex_flow' + 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: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 + next_page_url: null + key: flex_flows + flex_flows: + - sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + friendly_name: friendly_name + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_type: sms + contact_identity: '12345' + enabled: true + integration_type: studio + integration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + retry_count: 1 + long_lived: true + janitor_enabled: true + url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 + next_page_url: null + key: flex_flows + flex_flows: [] + description: OK + security: + - accountSid_authToken: [] + operationId: ListFlexFlow + post: + description: '' + tags: + - FlexV1FlexFlow + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.flex_flow' + examples: + create: + value: + sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + friendly_name: friendly_name + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_type: sms + contact_identity: '12345' + enabled: true + integration_type: studio + integration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + retry_count: 1 + long_lived: true + janitor_enabled: true + url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateFlexFlow + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateFlexFlowRequest + properties: + FriendlyName: + type: string + description: A descriptive string that you create to describe the + Flex Flow resource. + ChatServiceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + description: The SID of the chat service. + ChannelType: + type: string + $ref: '#/components/schemas/flex_flow_enum_channel_type' + description: "The channel type. One of `web`, `facebook`, `sms`,\ + \ `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send\ + \ to Flex widget passes it on to the Task attributes for Tasks\ + \ created based on this Flex Flow. The Task attributes will be\ + \ used by the Flex UI to render the respective Task as appropriate\ + \ (applying channel-specific design and length limits). If `channelType`\ + \ is `facebook`, `whatsapp` or `line`, the Send to Flex widget\ + \ should set the Task Channel to Programmable Chat." + ContactIdentity: + type: string + description: The channel contact's Identity. + Enabled: + type: boolean + description: Whether the new Flex Flow is enabled. + IntegrationType: + type: string + $ref: '#/components/schemas/flex_flow_enum_integration_type' + description: 'The software that will handle inbound messages. [Integration + Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) + can be: `studio`, `external`, or `task`.' + Integration.FlowSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + description: The SID of the Studio Flow. Required when `integrationType` + is `studio`. + Integration.Url: + type: string + format: uri + description: The URL of the external webhook. Required when `integrationType` + is `external`. + Integration.WorkspaceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WS[0-9a-fA-F]{32}$ + description: The Workspace SID for a new Task. Required when `integrationType` + is `task`. + Integration.WorkflowSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WW[0-9a-fA-F]{32}$ + description: The Workflow SID for a new Task. Required when `integrationType` + is `task`. + Integration.Channel: + type: string + description: The Task Channel SID (TCXXXX) or unique name (e.g., + `sms`) to use for the Task that will be created. Applicable and + required when `integrationType` is `task`. The default value is + `default`. + Integration.Timeout: + type: integer + description: The Task timeout in seconds for a new Task. Default + is 86,400 seconds (24 hours). Optional when `integrationType` + is `task`, not applicable otherwise. + Integration.Priority: + type: integer + description: The Task priority of a new Task. The default priority + is 0. Optional when `integrationType` is `task`, not applicable + otherwise. + Integration.CreationOnMessage: + type: boolean + description: In the context of outbound messaging, defines whether + to create a Task immediately (and therefore reserve the conversation + to current agent), or delay Task creation until the customer sends + the first response. Set to false to create immediately, true to + delay Task creation. This setting is only applicable for outbound + messaging. + LongLived: + type: boolean + description: When enabled, Flex will keep the chat channel active + so that it may be used for subsequent interactions with a contact + identity. Defaults to `false`. + JanitorEnabled: + type: boolean + description: When enabled, the Messaging Channel Janitor will remove + active Proxy sessions if the associated Task is deleted outside + of the Flex UI. Defaults to `false`. + Integration.RetryCount: + type: integer + 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. + required: + - FriendlyName + - ChatServiceSid + - ChannelType + examples: + create: + value: + FriendlyName: friendly_name + ChatServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ChannelType: sms + ContactIdentity: '12345' + Enabled: true + IntegrationType: studio + Integration.FlowSid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + LongLived: true + JanitorEnabled: true + Integration.RetryCount: 1 + /v1/FlexFlows/{Sid}: + servers: + - url: https://flex-api.twilio.com + description: Flex Flow + x-twilio: + defaultOutputProperties: + - sid + - friendly_name + - channel_type + - integration_type + mountName: flex_flow + pathType: instance + get: + description: '' + tags: + - FlexV1FlexFlow + parameters: + - name: Sid + in: path + description: The SID of the Flex Flow resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FO[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.flex_flow' + examples: + fetch: + value: + sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + friendly_name: friendly_name + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_type: sms + contact_identity: '12345' + enabled: true + integration_type: studio + integration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + retry_count: 1 + long_lived: true + janitor_enabled: true + url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: - accountSid_authToken: [] - operationId: CreateChannel - x-maturity: - - GA + operationId: FetchFlexFlow + post: + description: '' + tags: + - FlexV1FlexFlow + parameters: + - name: Sid + in: path + description: The SID of the Flex Flow resource to update. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FO[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.flex_flow' + examples: + update: + value: + sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + friendly_name: friendly_name + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_type: sms + contact_identity: '12345' + enabled: true + integration_type: studio + integration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + retry_count: 1 + long_lived: true + janitor_enabled: true + url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateFlexFlow requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateChannelRequest + title: UpdateFlexFlowRequest properties: - FlexFlowSid: + FriendlyName: + type: string + description: A descriptive string that you create to describe the + Flex Flow resource. + ChatServiceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + description: The SID of the chat service. + ChannelType: + type: string + $ref: '#/components/schemas/flex_flow_enum_channel_type' + description: "The channel type. One of `web`, `facebook`, `sms`,\ + \ `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send\ + \ to Flex widget passes it on to the Task attributes for Tasks\ + \ created based on this Flex Flow. The Task attributes will be\ + \ used by the Flex UI to render the respective Task as appropriate\ + \ (applying channel-specific design and length limits). If `channelType`\ + \ is `facebook`, `whatsapp` or `line`, the Send to Flex widget\ + \ should set the Task Channel to Programmable Chat." + ContactIdentity: + type: string + description: The channel contact's Identity. + Enabled: + type: boolean + description: Whether the new Flex Flow is enabled. + IntegrationType: + type: string + $ref: '#/components/schemas/flex_flow_enum_integration_type' + description: 'The software that will handle inbound messages. [Integration + Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) + can be: `studio`, `external`, or `task`.' + Integration.FlowSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FW[0-9a-fA-F]{32}$ + description: The SID of the Studio Flow. Required when `integrationType` + is `studio`. + Integration.Url: + type: string + format: uri + description: The URL of the external webhook. Required when `integrationType` + is `external`. + Integration.WorkspaceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WS[0-9a-fA-F]{32}$ + description: The Workspace SID for a new Task. Required when `integrationType` + is `task`. + Integration.WorkflowSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WW[0-9a-fA-F]{32}$ + description: The Workflow SID for a new Task. Required when `integrationType` + is `task`. + Integration.Channel: + type: string + description: The Task Channel SID (TCXXXX) or unique name (e.g., + `sms`) to use for the Task that will be created. Applicable and + required when `integrationType` is `task`. The default value is + `default`. + Integration.Timeout: + type: integer + description: The Task timeout in seconds for a new Task. Default + is 86,400 seconds (24 hours). Optional when `integrationType` + is `task`, not applicable otherwise. + Integration.Priority: + type: integer + description: The Task priority of a new Task. The default priority + is 0. Optional when `integrationType` is `task`, not applicable + otherwise. + Integration.CreationOnMessage: + type: boolean + description: In the context of outbound messaging, defines whether + to create a Task immediately (and therefore reserve the conversation + to current agent), or delay Task creation until the customer sends + the first response. Set to false to create immediately, true to + delay Task creation. This setting is only applicable for outbound + messaging. + LongLived: + type: boolean + description: When enabled, Flex will keep the chat channel active + so that it may be used for subsequent interactions with a contact + identity. Defaults to `false`. + JanitorEnabled: + type: boolean + description: When enabled, the Messaging Channel Janitor will remove + active Proxy sessions if the associated Task is deleted outside + of the Flex UI. Defaults to `false`. + Integration.RetryCount: + type: integer + 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 + delete: + description: '' + tags: + - FlexV1FlexFlow + parameters: + - name: Sid + in: path + description: The SID of the Flex Flow resource to delete. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FO[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteFlexFlow + /v1/Insights/QualityManagement/Assessments: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - account_sid + - assessment_sid + - assessment + 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. + tags: + - FlexV1Assessments + parameters: + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.insights_assessments' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: dbdf1f7b-c776-5e78-9676-98a397fb3cdc + user_name: Supervisor + user_email: supervisor@example.com + answer_id: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 + answer_text: Fair + timestamp: '1657329694199' + assessment: + questionnaire: + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Customer Experience + question: + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Active listening + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateInsightsAssessments + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateInsightsAssessmentsRequest + properties: + CategorySid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FY[0-9a-fA-F]{32}$ + description: 'The SID of the category ' + CategoryName: type: string - minLength: 34 - maxLength: 34 - pattern: ^FO[0-9a-fA-F]{32}$ - description: The SID of the Flex Flow. - Identity: + description: The name of the category + SegmentId: type: string - description: The `identity` value that uniquely identifies the new - resource's chat User. - ChatUserFriendlyName: + description: Segment Id of the conversation + AgentId: type: string - description: The chat participant's friendly name. - ChatFriendlyName: + description: The id of the Agent + Offset: + type: number + description: The offset of the conversation. + MetricId: type: string - description: The chat channel's friendly name. - Target: + minLength: 34 + maxLength: 34 + pattern: ^GE[0-9a-fA-F]{32}$ + description: The question SID selected for assessment + MetricName: type: string - description: The Target Contact Identity, for example the phone - number of an SMS. - ChatUniqueName: + description: The question name of the assessment + AnswerText: type: string - description: The chat channel's unique name. - PreEngagementData: + description: The answer text selected by user + AnswerId: type: string - description: The pre-engagement data. - TaskSid: + description: The id of the answer selected by user + QuestionnaireSid: type: string minLength: 34 maxLength: 34 - pattern: ^WT[0-9a-fA-F]{32}$ - description: The SID of the TaskRouter Task. Only valid when integration - type is `task`. `null` for integration types `studio` & `external` - TaskAttributes: - type: string - description: The Task attributes to be added for the TaskRouter - Task. - LongLived: - type: boolean - description: Whether to create the channel as long-lived. + pattern: ^GM[0-9a-fA-F]{32}$ + description: Questionnaire SID of the associated question required: - - FlexFlowSid - - Identity - - ChatUserFriendlyName - - ChatFriendlyName - /v1/Channels/{Sid}: - servers: - - url: https://flex-api.twilio.com - description: Flex chat channels - x-twilio: - defaultOutputProperties: - - sid - - flex_flow_sid - - user_sid - - task_sid - pathType: instance - mountName: channel + - CategorySid + - CategoryName + - SegmentId + - AgentId + - Offset + - MetricId + - MetricName + - AnswerText + - AnswerId + - QuestionnaireSid + examples: + create: + value: + CategorySid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + CategoryName: Good for Training + SegmentId: dbdf1f7b-c776-5e78-9676-98a397fb3cdc + AgentId: 583fcaa6-a4ef-5447-9077-900421e37a61 + Offset: '6.985619' + MetricId: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + MetricName: Active listening + AnswerId: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 + AnswerText: Fair + QuestionnaireSid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: - description: '' + description: Get assessments done for a conversation by logged in user + tags: + - FlexV1Assessments parameters: - - name: Sid - in: path - description: The SID of the Flex chat channel resource to fetch. + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string + - name: SegmentId + in: query + description: The id of the segment. + schema: + type: string + examples: + readBySegmentId: + value: dbdf1f7b-c776-5e78-9676-98a397fb3cdc + readEmpty: + value: dbdf1f7b-c776-5e78-9676-98a397fb3cdc + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.channel' + type: object + title: ListInsightsAssessmentsResponse + properties: + assessments: + type: array + items: + $ref: '#/components/schemas/flex.v1.insights_assessments' + 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: + readBySegmentId: + value: + assessments: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: dbdf1f7b-c776-5e78-9676-98a397fb3cdc + user_name: Supervisor + user_email: supervisor@example.com + answer_id: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 + answer_text: Fair + timestamp: '1657329694199' + assessment: + questionnaire: + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Customer Experience + question: + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Active listening + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 + key: assessments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 + readEmpty: + value: + assessments: [] + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 + key: assessments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: FetchChannel - x-maturity: - - GA - delete: - description: '' + operationId: ListInsightsAssessments + /v1/Insights/QualityManagement/Assessments/{AssessmentSid}: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - account_sid + - assessment_sid + - assessment + className: assessments + pathType: instance + post: + description: Update a specific Assessment assessed earlier + tags: + - FlexV1Assessments parameters: - - name: Sid + - name: AssessmentSid in: path - description: The SID of the Flex chat channel resource to delete. + description: The SID of the assessment to be modified schema: type: string minLength: 34 maxLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ + pattern: ^FM[0-9a-fA-F]{32}$ required: true + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.insights_assessments' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 + user_name: Supervisor + user_email: supervisor@example.com + answer_id: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 + answer_text: Fair + timestamp: '1657329694199' + assessment: + questionnaire: + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Customer Experience + question: + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Active listening + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK security: - accountSid_authToken: [] - operationId: DeleteChannel - x-maturity: - - GA - /v1/Configuration: + operationId: UpdateInsightsAssessments + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateInsightsAssessmentsRequest + properties: + Offset: + type: number + description: The offset of the conversation + AnswerText: + type: string + description: The answer text selected by user + AnswerId: + type: string + description: The id of the answer selected by user + required: + - Offset + - AnswerText + - AnswerId + examples: + update: + value: + Offset: '6.985619' + AnswerId: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 + AnswerText: Fair + /v1/Insights/QualityManagement/Assessments/Comments: servers: - url: https://flex-api.twilio.com - description: Configuration for a Flex instance + description: '' x-twilio: defaultOutputProperties: - - status - - ui_language - - ui_version - - service_version - pathType: instance + - account_sid + - assessment_sid + - comment + mountName: insights_assessments_comment + pathType: list + post: + description: To create a comment assessment for a conversation + tags: + - FlexV1InsightsAssessmentsComment + parameters: + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.insights_assessments_comment' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 + user_name: Linda Houghton + user_email: linda.houghton@vacasa.com + timestamp: '1657329694199' + comment: + comment: log0zu0268 + category: + category_id: c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateInsightsAssessmentsComment + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateInsightsAssessmentsCommentRequest + properties: + CategoryId: + type: string + description: The ID of the category + CategoryName: + type: string + description: The name of the category + Comment: + type: string + description: The Assessment comment. + SegmentId: + type: string + description: The id of the segment. + AgentId: + type: string + description: The id of the agent. + Offset: + type: number + description: The offset + required: + - CategoryId + - CategoryName + - Comment + - SegmentId + - AgentId + - Offset + examples: + create: + value: + CategoryId: 4b4e78e4-4f05-49e2-bf52-0973c5cde418 + CategoryName: Good for Training + Comment: log0zu0268 + SegmentId: dbdf1f7b-c776-5e78-9676-98a397fb3cdc + AgentId: 583fcaa6-a4ef-5447-9077-900421e37a61 + Offset: '6.985619' get: - description: '' + description: To create a comment assessment for a conversation + tags: + - FlexV1InsightsAssessmentsComment parameters: - - name: UiVersion + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string + - name: SegmentId in: query - description: The Pinned UI version of the Configuration resource to fetch. + description: The id of the segment. + schema: + type: string + examples: + readBySegmentId: + value: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 + readEmpty: + value: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 + - name: AgentId + in: query + description: The id of the agent. + schema: + type: string + examples: + readByAgentId: + value: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 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: @@ -1293,33 +3539,140 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/flex.v1.configuration' + type: object + title: ListInsightsAssessmentsCommentResponse + properties: + comments: + type: array + items: + $ref: '#/components/schemas/flex.v1.insights_assessments_comment' + 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: + readBySegmentId: + value: + comments: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 + user_name: Linda Houghton + user_email: linda.houghton@vacasa.com + timestamp: '1657329694199' + comment: + comment: log0zu0268 + category: + category_id: c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 + key: comments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 + readByAgentId: + value: + comments: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 + user_name: Linda Houghton + user_email: linda.houghton@vacasa.com + timestamp: '1657329694199' + comment: + comment: log0zu0268 + category: + category_id: c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?AgentId=5d80ee80-7608-55df-b2b2-5ab5608b9831&PageSize=50&Page=0 + key: comments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?AgentId=5d80ee80-7608-55df-b2b2-5ab5608b9831&PageSize=50&Page=0 + readEmpty: + value: + comments: [] + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 + key: comments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: FetchConfiguration - x-maturity: - - GA - /v1/FlexFlows: + operationId: ListInsightsAssessmentsComment + /v1/Insights/Conversations: servers: - url: https://flex-api.twilio.com - description: Flex Flow + description: '' x-twilio: defaultOutputProperties: - - sid - - friendly_name - - channel_type - - integration_type + - conversation_id + - account_id + - segment_count + - segments + mountName: insights_conversations + className: insights_conversations pathType: list - mountName: flex_flow get: - description: '' + description: To get conversation with segment id + tags: + - FlexV1InsightsConversations parameters: - - name: FriendlyName + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string + - name: SegmentId in: query - description: The `friendly_name` of the Flex Flow resources to read. + 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 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1345,366 +3698,562 @@ paths: application/json: schema: type: object - title: ListFlexFlowResponse + title: ListInsightsConversationsResponse properties: - flex_flows: + conversations: type: array items: - $ref: '#/components/schemas/flex.v1.flex_flow' + $ref: '#/components/schemas/flex.v1.insights_conversations' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + conversations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 + next_page_url: null + key: conversations + readFull: + value: + conversations: + - account_id: 76e4c1c3-6f93-5d08-ae66-aad4b9092f2d + conversation_id: 2cb2452a-c6d9-564d-b285-b5404f073031 + segment_count: 2 + segments: + - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a4 + order: 0 + offset: 1.542 + talk_time: 18 + timestamp: '2022-05-11T16:02:27.659Z' + agent_name: First Agent + - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 + order: 0 + offset: 1.211 + talk_time: 10 + timestamp: '2022-05-21T16:02:27.659Z' + agent_name: Second Agent + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] - operationId: ListFlexFlow - x-maturity: - - GA + operationId: ListInsightsConversations + /v1/Insights/QualityManagement/Questionnaires: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - account_sid + - questionnaire_sid + - name + mountName: insights_questionnaires + className: insights_questionnaires + pathType: list post: - description: '' + description: To create a Questionnaire + tags: + - FlexV1InsightsQuestionnaires + parameters: + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string responses: '201': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.flex_flow' + $ref: '#/components/schemas/flex.v1.insights_questionnaires' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abc + description: description + active: false + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateFlexFlow - x-maturity: - - GA + operationId: CreateInsightsQuestionnaires requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateFlexFlowRequest + title: CreateInsightsQuestionnairesRequest properties: - FriendlyName: - type: string - description: A descriptive string that you create to describe the - Flex Flow resource. - ChatServiceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - description: The SID of the chat service. - ChannelType: - type: string - $ref: '#/components/schemas/flex_flow_enum_channel_type' - description: "The channel type. One of `web`, `facebook`, `sms`,\ - \ `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send\ - \ to Flex widget passes it on to the Task attributes for Tasks\ - \ created based on this Flex Flow. The Task attributes will be\ - \ used by the Flex UI to render the respective Task as appropriate\ - \ (applying channel-specific design and length limits). If `channelType`\ - \ is `facebook`, `whatsapp` or `line`, the Send to Flex widget\ - \ should set the Task Channel to Programmable Chat." - ContactIdentity: - type: string - description: The channel contact's Identity. - Enabled: - type: boolean - description: Whether the new Flex Flow is enabled. - IntegrationType: - type: string - $ref: '#/components/schemas/flex_flow_enum_integration_type' - description: 'The software that will handle inbound messages. [Integration - Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) - can be: `studio`, `external`, or `task`.' - Integration.FlowSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - description: The SID of the Studio Flow. Required when `integrationType` - is `studio`. - Integration.Url: - type: string - format: uri - description: The URL of the external webhook. Required when `integrationType` - is `external`. - Integration.WorkspaceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^WS[0-9a-fA-F]{32}$ - description: The Workspace SID for a new Task. Required when `integrationType` - is `task`. - Integration.WorkflowSid: + Name: type: string - minLength: 34 - maxLength: 34 - pattern: ^WW[0-9a-fA-F]{32}$ - description: The Workflow SID for a new Task. Required when `integrationType` - is `task`. - Integration.Channel: + description: The name of this questionnaire + Description: type: string - description: The Task Channel SID (TCXXXX) or unique name (e.g., - `sms`) to use for the Task that will be created. Applicable and - required when `integrationType` is `task`. The default value is - `default`. - Integration.Timeout: - type: integer - description: The Task timeout in seconds for a new Task. Default - is 86,400 seconds (24 hours). Optional when `integrationType` - is `task`, not applicable otherwise. - Integration.Priority: - type: integer - description: The Task priority of a new Task. The default priority - is 0. Optional when `integrationType` is `task`, not applicable - otherwise. - Integration.CreationOnMessage: - type: boolean - description: In the context of outbound messaging, defines whether - to create a Task immediately (and therefore reserve the conversation - to current agent), or delay Task creation until the customer sends - the first response. Set to false to create immediately, true to - delay Task creation. This setting is only applicable for outbound - messaging. - LongLived: - type: boolean - description: When enabled, Flex will keep the chat channel active - so that it may be used for subsequent interactions with a contact - identity. Defaults to `false`. - JanitorEnabled: + description: The description of this questionnaire + Active: type: boolean - description: When enabled, the Messaging Channel Janitor will remove - active Proxy sessions if the associated Task is deleted outside - of the Flex UI. Defaults to `false`. - Integration.RetryCount: - type: integer - 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. + description: The flag to enable or disable questionnaire + QuestionSids: + type: array + items: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GE[0-9a-fA-F]{32}$ + description: The list of questions sids under a questionnaire required: - - FriendlyName - - ChatServiceSid - - ChannelType - /v1/FlexFlows/{Sid}: - servers: - - url: https://flex-api.twilio.com - description: Flex Flow - x-twilio: - defaultOutputProperties: - - sid - - friendly_name - - channel_type - - integration_type - pathType: instance - mountName: flex_flow + - Name + examples: + create: + value: + Name: abc + Description: description + Active: false + QuestionSids: + - GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee get: - description: '' + description: To get all questionnaires with questions + tags: + - FlexV1InsightsQuestionnaires parameters: - - name: Sid - in: path - description: The SID of the Flex Flow resource to fetch. + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string + - name: IncludeInactive + in: query + description: Flag indicating whether to include inactive questionnaires or + not + schema: + type: boolean + examples: + readEmpty: + value: true + readFull: + value: true + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^FO[0-9a-fA-F]{32}$ - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.flex_flow' + type: object + title: ListInsightsQuestionnairesResponse + properties: + questionnaires: + type: array + items: + $ref: '#/components/schemas/flex.v1.insights_questionnaires' + 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: + questionnaires: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0 + next_page_url: null + key: questionnaires + readFull: + value: + questionnaires: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abc + description: description + active: false + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abc + description: description + active: true + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0 + key: questionnaires + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0 + readActiveQuestionnaires: + value: + questionnaires: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: efg + description: description + active: true + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?PageSize=50&Page=0 + key: questionnaires + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: FetchFlexFlow - x-maturity: - - GA + operationId: ListInsightsQuestionnaires + /v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - account_sid + - questionnaire_sid + - name + mountName: insights_questionnaires + className: insights_questionnaires + pathType: instance post: - description: '' + description: To update the questionnaire + tags: + - FlexV1InsightsQuestionnaires parameters: - - name: Sid + - name: QuestionnaireSid in: path - description: The SID of the Flex Flow resource to update. + description: The SID of the questionnaire schema: type: string minLength: 34 maxLength: 34 - pattern: ^FO[0-9a-fA-F]{32}$ + pattern: ^GM[0-9a-fA-F]{32}$ required: true + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.flex_flow' + $ref: '#/components/schemas/flex.v1.insights_questionnaires' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abc + description: description + active: true + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateFlexFlow - x-maturity: - - GA + operationId: UpdateInsightsQuestionnaires requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateFlexFlowRequest + title: UpdateInsightsQuestionnairesRequest properties: - FriendlyName: - type: string - description: A descriptive string that you create to describe the - Flex Flow resource. - ChatServiceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - description: The SID of the chat service. - ChannelType: - type: string - $ref: '#/components/schemas/flex_flow_enum_channel_type' - description: "The channel type. One of `web`, `facebook`, `sms`,\ - \ `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send\ - \ to Flex widget passes it on to the Task attributes for Tasks\ - \ created based on this Flex Flow. The Task attributes will be\ - \ used by the Flex UI to render the respective Task as appropriate\ - \ (applying channel-specific design and length limits). If `channelType`\ - \ is `facebook`, `whatsapp` or `line`, the Send to Flex widget\ - \ should set the Task Channel to Programmable Chat." - ContactIdentity: - type: string - description: The channel contact's Identity. - Enabled: + Active: type: boolean - description: Whether the new Flex Flow is enabled. - IntegrationType: - type: string - $ref: '#/components/schemas/flex_flow_enum_integration_type' - description: 'The software that will handle inbound messages. [Integration - Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) - can be: `studio`, `external`, or `task`.' - Integration.FlowSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^FW[0-9a-fA-F]{32}$ - description: The SID of the Studio Flow. Required when `integrationType` - is `studio`. - Integration.Url: - type: string - format: uri - description: The URL of the external webhook. Required when `integrationType` - is `external`. - Integration.WorkspaceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^WS[0-9a-fA-F]{32}$ - description: The Workspace SID for a new Task. Required when `integrationType` - is `task`. - Integration.WorkflowSid: + description: The flag to enable or disable questionnaire + Name: type: string - minLength: 34 - maxLength: 34 - pattern: ^WW[0-9a-fA-F]{32}$ - description: The Workflow SID for a new Task. Required when `integrationType` - is `task`. - Integration.Channel: + description: The name of this questionnaire + Description: type: string - description: The Task Channel SID (TCXXXX) or unique name (e.g., - `sms`) to use for the Task that will be created. Applicable and - required when `integrationType` is `task`. The default value is - `default`. - Integration.Timeout: - type: integer - description: The Task timeout in seconds for a new Task. Default - is 86,400 seconds (24 hours). Optional when `integrationType` - is `task`, not applicable otherwise. - Integration.Priority: - type: integer - description: The Task priority of a new Task. The default priority - is 0. Optional when `integrationType` is `task`, not applicable - otherwise. - Integration.CreationOnMessage: - type: boolean - description: In the context of outbound messaging, defines whether - to create a Task immediately (and therefore reserve the conversation - to current agent), or delay Task creation until the customer sends - the first response. Set to false to create immediately, true to - delay Task creation. This setting is only applicable for outbound - messaging. - LongLived: - type: boolean - description: When enabled, Flex will keep the chat channel active - so that it may be used for subsequent interactions with a contact - identity. Defaults to `false`. - JanitorEnabled: - type: boolean - description: When enabled, the Messaging Channel Janitor will remove - active Proxy sessions if the associated Task is deleted outside - of the Flex UI. Defaults to `false`. - Integration.RetryCount: - type: integer - 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. + description: The description of this questionnaire + QuestionSids: + type: array + items: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GE[0-9a-fA-F]{32}$ + description: The list of questions sids under a questionnaire + required: + - Active + examples: + update: + value: + Name: abc + Description: description + Active: true + QuestionSids: + - GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee delete: - description: '' + description: To delete the questionnaire + tags: + - FlexV1InsightsQuestionnaires parameters: - - name: Sid + - name: QuestionnaireSid + in: path + description: The SID of the questionnaire + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GM[0-9a-fA-F]{32}$ + required: true + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteInsightsQuestionnaires + get: + description: To get the Questionnaire Detail + tags: + - FlexV1InsightsQuestionnaires + parameters: + - name: QuestionnaireSid in: path - description: The SID of the Flex Flow resource to delete. + description: The SID of the questionnaire schema: type: string minLength: 34 maxLength: 34 - pattern: ^FO[0-9a-fA-F]{32}$ + pattern: ^GM[0-9a-fA-F]{32}$ required: true + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.insights_questionnaires' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: efg + description: description + active: true + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK security: - accountSid_authToken: [] - operationId: DeleteFlexFlow - x-maturity: - - GA - /v1/Insights/QualityManagement/Assessments: + operationId: FetchInsightsQuestionnaires + /v1/Insights/QualityManagement/Categories: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - - assessment_sid - - assessment + - category_sid + - name + mountName: insights_questionnaires_category pathType: list - className: assessments 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. + description: To create a category for Questions + tags: + - FlexV1InsightsQuestionnairesCategory parameters: - name: Authorization in: header @@ -1716,83 +4265,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/flex.v1.insights_assessments' + $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abc + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateInsightsAssessments - x-maturity: - - Preview + operationId: CreateInsightsQuestionnairesCategory requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateInsightsAssessmentsRequest + title: CreateInsightsQuestionnairesCategoryRequest properties: - CategorySid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^FY[0-9a-fA-F]{32}$ - description: 'The SID of the category ' - CategoryName: - type: string - description: The name of the category - SegmentId: - type: string - description: Segment Id of the conversation - AgentId: - type: string - description: The id of the Agent - Offset: - type: number - description: The offset of the conversation. - MetricId: - type: string - minLength: 34 - maxLength: 34 - pattern: ^GE[0-9a-fA-F]{32}$ - description: The question SID selected for assessment - MetricName: - type: string - description: The question name of the assessment - AnswerText: - type: string - description: The answer text selected by user - AnswerId: - type: string - description: The id of the answer selected by user - QuestionnaireSid: + Name: type: string - minLength: 34 - maxLength: 34 - pattern: ^GM[0-9a-fA-F]{32}$ - description: Questionnaire SID of the associated question + description: The name of this category. required: - - CategorySid - - CategoryName - - SegmentId - - AgentId - - Offset - - MetricId - - MetricName - - AnswerText - - AnswerId - - QuestionnaireSid + - Name + examples: + create: + value: + Name: abc get: - description: Get assessments done for a conversation by logged in user + description: To get all the categories + tags: + - FlexV1InsightsQuestionnairesCategory parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string - - name: SegmentId - in: query - description: The id of the segment. - schema: - type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1818,63 +4328,90 @@ paths: application/json: schema: type: object - title: ListInsightsAssessmentsResponse + title: ListInsightsQuestionnairesCategoryResponse properties: - assessments: + categories: type: array items: - $ref: '#/components/schemas/flex.v1.insights_assessments' + $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + categories: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 + next_page_url: null + key: categories + readFull: + value: + categories: + - category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Test1 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 + next_page_url: null + key: categories description: OK security: - accountSid_authToken: [] - operationId: ListInsightsAssessments - x-maturity: - - Preview - /v1/Insights/QualityManagement/Assessments/{AssessmentSid}: + operationId: ListInsightsQuestionnairesCategory + /v1/Insights/QualityManagement/Categories/{CategorySid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - - assessment_sid - - assessment + - category_sid + - name + mountName: insights_questionnaires_category pathType: instance - className: assessments post: - description: Update a specific Assessment assessed earlier + description: To update the category for Questions + tags: + - FlexV1InsightsQuestionnairesCategory parameters: - - name: AssessmentSid + - name: CategorySid in: path - description: The SID of the assessment to be modified + description: The SID of the category to be updated schema: type: string minLength: 34 maxLength: 34 - pattern: ^FM[0-9a-fA-F]{32}$ + pattern: ^FY[0-9a-fA-F]{32}$ required: true - name: Authorization in: header @@ -1886,46 +4423,74 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/flex.v1.insights_assessments' + $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abcd + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateInsightsAssessments - x-maturity: - - Preview + operationId: UpdateInsightsQuestionnairesCategory requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateInsightsAssessmentsRequest + title: UpdateInsightsQuestionnairesCategoryRequest properties: - Offset: - type: number - description: The offset of the conversation - AnswerText: - type: string - description: The answer text selected by user - AnswerId: + Name: type: string - description: The id of the answer selected by user + description: The name of this category. required: - - Offset - - AnswerText - - AnswerId - /v1/Insights/QualityManagement/Assessments/Comments: + - Name + examples: + update: + value: + Name: abcd + delete: + description: '' + tags: + - FlexV1InsightsQuestionnairesCategory + parameters: + - name: CategorySid + in: path + description: The SID of the category to be deleted + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FY[0-9a-fA-F]{32}$ + required: true + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteInsightsQuestionnairesCategory + /v1/Insights/QualityManagement/Questions: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - - assessment_sid - - comment + - question_sid + - question + mountName: insights_questionnaires_question pathType: list - mountName: insights_assessments_comment post: - description: To create a comment assessment for a conversation + description: To create a question for a Category + tags: + - FlexV1InsightsQuestionnairesQuestion parameters: - name: Authorization in: header @@ -1937,63 +4502,109 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/flex.v1.insights_assessments_comment' + $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + question: What is the total time + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: time spent + category: + category_name: test cat + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + answer_set: + sort: 0 + name: Yes, No + answers: + - sort: 0 + score: 100 + description: Yes. + name: 'Yes' + id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 + - sort: 1 + score: 0 + description: No or a very poor. + name: 'No' + id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c + category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 + type: select + id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateInsightsAssessmentsComment - x-maturity: - - Preview + operationId: CreateInsightsQuestionnairesQuestion requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateInsightsAssessmentsCommentRequest + title: CreateInsightsQuestionnairesQuestionRequest properties: - CategoryId: - type: string - description: The ID of the category - CategoryName: + CategorySid: type: string - description: The name of the category - Comment: + minLength: 34 + maxLength: 34 + pattern: ^FY[0-9a-fA-F]{32}$ + description: The SID of the category + Question: type: string - description: The Assessment comment. - SegmentId: + description: The question. + AnswerSetId: type: string - description: The id of the segment. - AgentId: + description: The answer_set for the question. + AllowNa: + type: boolean + description: The flag to enable for disable NA for answer. + Description: type: string - description: The id of the agent. - Offset: - type: number - description: The offset + description: The description for the question. required: - - CategoryId - - CategoryName - - Comment - - SegmentId - - AgentId - - Offset + - CategorySid + - Question + - AnswerSetId + - AllowNa + examples: + create: + value: + CategorySid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Question: What is the total time + Description: time spent + AnswerSetId: a6a8a54f-5305-4aec-b92c-a6e429932f58 + AllowNa: false get: - description: To create a comment assessment for a conversation + description: To get all the question for the given categories + tags: + - FlexV1InsightsQuestionnairesQuestion parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string - - name: SegmentId - in: query - description: The id of the segment. - schema: - type: string - - name: AgentId + - name: CategorySid in: query - description: The id of the agent. + description: The list of category SIDs schema: - type: string + type: array + items: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FY[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: + - FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + readFull: + value: + - FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2019,56 +4630,238 @@ paths: application/json: schema: type: object - title: ListInsightsAssessmentsCommentResponse + title: ListInsightsQuestionnairesQuestionResponse properties: - comments: + questions: type: array items: - $ref: '#/components/schemas/flex.v1.insights_assessments_comment' + $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' meta: - type: object properties: first_page_url: + format: uri + type: string + key: type: string - format: uri next_page_url: - type: string format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + questions: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: questions + readFull: + value: + questions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + question: What is the total time + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: time spent + category: + category_name: test cat + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + answer_set: + sort: 0 + name: Yes, No + answers: + - sort: 0 + score: 100 + description: Yes. + name: 'Yes' + id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 + - sort: 1 + score: 0 + description: No or a very poor. + name: 'No' + id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c + category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 + type: select + id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: questions description: OK security: - accountSid_authToken: [] - operationId: ListInsightsAssessmentsComment - x-maturity: - - Preview - /v1/Insights/Conversations: + operationId: ListInsightsQuestionnairesQuestion + /v1/Insights/QualityManagement/Questions/{QuestionSid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - - conversation_id + - account_sid + - question_sid + - question + mountName: insights_questionnaires_question + pathType: instance + post: + description: To update the question + tags: + - FlexV1InsightsQuestionnairesQuestion + parameters: + - name: QuestionSid + in: path + description: The SID of the question + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GE[0-9a-fA-F]{32}$ + required: true + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + question: What is the total time + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: time spent + category: + category_name: test cat + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + answer_set: + sort: 0 + name: Yes, No + answers: + - sort: 0 + score: 100 + description: Yes. + name: 'Yes' + id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 + - sort: 1 + score: 0 + description: No or a very poor. + name: 'No' + id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c + category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 + type: select + id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateInsightsQuestionnairesQuestion + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateInsightsQuestionnairesQuestionRequest + properties: + AllowNa: + type: boolean + description: The flag to enable for disable NA for answer. + CategorySid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FY[0-9a-fA-F]{32}$ + description: The SID of the category + Question: + type: string + description: The question. + Description: + type: string + description: The description for the question. + AnswerSetId: + type: string + description: The answer_set for the question. + required: + - AllowNa + examples: + update: + value: + Question: What is the total time + Description: time spent + AnswerSetId: a6a8a54f-5305-4aec-b92c-a6e429932f58 + AllowNa: false + delete: + description: '' + tags: + - FlexV1InsightsQuestionnairesQuestion + parameters: + - name: QuestionSid + in: path + description: The SID of the question + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GE[0-9a-fA-F]{32}$ + required: true + - name: Authorization + in: header + description: The Authorization HTTP request header + schema: + type: string + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteInsightsQuestionnairesQuestion + /v1/Insights/Segments: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - segment_id + - external_id - account_id - - segment_count - - segments + - agent_id + - queue + mountName: insights_segments + className: insights_segments pathType: list - mountName: insights_conversations - className: insights_conversations get: - description: To get conversation with segment id + description: To get segments for given reservation Ids + tags: + - FlexV1InsightsSegments parameters: - name: Authorization in: header @@ -2077,10 +4870,31 @@ paths: type: string - name: SegmentId in: query - description: Unique Id of the segment for which conversation details needs - to be fetched + description: To unique id of the segment schema: type: string + examples: + readBySegmentId: + value: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 + - name: ReservationId + in: query + description: The list of reservation Ids + schema: + type: array + items: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WR[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: + - WReeeff42d5326cfdaa0f7a1181d00f1b1 + - WReeeff42d5326cfdaa0f7a1181d00f1b2 + readByReservationIds: + value: + - WReeeff42d5326cfdaa0f7a1181d00f1b1 + - WReeeff42d5326cfdaa0f7a1181d00f1b2 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2106,55 +4920,137 @@ paths: application/json: schema: type: object - title: ListInsightsConversationsResponse + title: ListInsightsSegmentsResponse properties: - conversations: + segments: type: array items: - $ref: '#/components/schemas/flex.v1.insights_conversations' + $ref: '#/components/schemas/flex.v1.insights_segments' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + segments: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 + next_page_url: null + key: segments + readByReservationIds: + value: + segments: + - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 + external_id: EV4ab3c50aeeb9dc48c96f7290cf626a37 + queue: Everyone + external_contact: '+13051515226' + external_segment_link_id: null + date: '2022-02-08T08:00:00Z' + account_id: 76e4c1c3-6f93-5d08-ae66-aad4b9092f2d + external_segment_link: null + agent_id: 0e4a8059-18a3-5e48-9efb-29ae3213e7fe + agent_phone: '+13051515226' + agent_name: Flex Insights + agent_team_name: Everyone + agent_team_name_in_hierarchy: Everyone + agent_link: null + customer_phone: '+420606078007' + customer_name: '+420606078007' + customer_link: null + segment_recording_offset: null + media: null + assessment_type: + - null + assessment_percentage: + - null + url: https://flex-api.twilio.com/v1/Insights/Segments/02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 + next_page_url: null + key: segments + readBySegmentId: + value: + segments: + - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 + external_id: EV4ab3c50aeeb9dc48c96f7290cf626a37 + queue: Everyone + external_contact: '+13051515226' + external_segment_link_id: null + date: '2022-02-08T08:00:00Z' + account_id: 76e4c1c3-6f93-5d08-ae66-aad4b9092f2d + external_segment_link: null + agent_id: 0e4a8059-18a3-5e48-9efb-29ae3213e7fe + agent_phone: '+13051515226' + agent_name: Flex Insights + agent_team_name: Everyone + agent_team_name_in_hierarchy: Everyone + agent_link: null + customer_phone: '+420606078007' + customer_name: '+420606078007' + customer_link: null + segment_recording_offset: null + media: null + assessment_type: + - null + assessment_percentage: + - null + url: https://flex-api.twilio.com/v1/Insights/Segments/02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/Segments?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a5&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/Segments?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a5&PageSize=50&Page=0 + next_page_url: null + key: segments description: OK security: - accountSid_authToken: [] - operationId: ListInsightsConversations - x-maturity: - - Preview - /v1/Insights/QualityManagement/Questionnaires: + operationId: ListInsightsSegments + /v1/Insights/Session: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - - account_sid - - questionnaire_sid - - name - pathType: list - mountName: insights_questionnaires - className: insights_questionnaires + - workspace_id + - session_expiry + - session_id + - base_url + mountName: insights_session + pathType: instance post: - description: To create a Questionnaire + description: To obtain session details for fetching reports and dashboards + tags: + - FlexV1InsightsSession parameters: - name: Authorization in: header @@ -2166,70 +5062,164 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/flex.v1.insights_questionnaires' + $ref: '#/components/schemas/flex.v1.insights_session' + examples: + create: + value: + session_expiry: '2022-09-27T09:28:01Z' + workspace_id: clbi1eelh1x8z4.......ijpnyu + session_id: "-----BEGIN PGP MESSAGE-----\n\nwcBMA11tX1FL13rp\u2026\ + \u2026kHXd\n=vOBk\n-----END PGP MESSAGE-----\n" + base_url: https://analytics.ytica.com/ + url: https://flex-api.twilio.com/v1/Insights/Session description: Created security: - accountSid_authToken: [] - operationId: CreateInsightsQuestionnaires - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateInsightsQuestionnairesRequest - properties: - Name: - type: string - description: The name of this questionnaire - Description: - type: string - description: The description of this questionnaire - Active: - type: boolean - description: The flag to enable or disable questionnaire - QuestionSids: - type: array - items: - type: string - minLength: 34 - maxLength: 34 - pattern: ^GE[0-9a-fA-F]{32}$ - description: The list of questions sids under a questionnaire - required: - - Name + operationId: CreateInsightsSession + /v1/Insights/QualityManagement/Settings/AnswerSets: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - answer_sets + - answer_set_categories + - not_applicable + mountName: insights_settings_answer_sets + className: insights_settings_answer_sets + pathType: list get: - description: To get all questionnaires with questions + description: To get the Answer Set Settings for an Account + tags: + - FlexV1InsightsSettingsAnswerSets parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string - - name: IncludeInactive - in: query - description: Flag indicating whether to include inactive questionnaires or - not - schema: - type: boolean - - 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. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.insights_settings_answersets' + examples: + read: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Settings/AnswerSets + answer_sets: + - category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 + id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + name: Yes, No + sort: 0 + type: select + answers: + - description: Yes. + id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 + name: 'Yes' + score: 100 + sort: 0 + - description: No or a very poor. + id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c + name: 'No' + score: 0 + sort: 1 + - category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 + id: 675e8803-e7ca-4002-97f6-a29490450b1b + name: Good, Poor + sort: 1 + type: select + answers: + - description: Good. + id: 5aa6c6c0-05cf-4952-b9f9-9fdbe18cc79d + name: Good + score: 100 + sort: 0 + - description: Poor. + id: d19f1c36-8331-44cc-9944-e94cb39e35e9 + name: Poor + score: 0 + sort: 1 + answer_set_categories: + - id: 1a8cac56-826c-4f85-ac14-9104811cf184 + name: Two Options + sort: 1 + - id: 10c44902-0e6e-46b6-9378-d4665348b4b7 + name: Three Options + sort: 2 + - id: 10c44902-0e6e-46b6-9378-d4665348b4b8 + name: Rating + sort: 3 + not_applicable: + description: Not applicable for this call + id: 8dc58ae1-16ae-4e17-a357-799d06230fa3 + name: N/A + score: 0 + sort: 0 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchInsightsSettingsAnswersets + /v1/Insights/QualityManagement/Settings/CommentTags: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - comments + mountName: insights_settings_comment + pathType: list + get: + description: To get the Comment Settings for an Account + tags: + - FlexV1InsightsSettingsComment + parameters: + - name: Authorization + in: header + description: The Authorization HTTP request header schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.insights_settings_comment' + examples: + read: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + comments: + - default: false + id: 4c5ba39a-e192-4c5d-a41c-b765a833665b + name: Good + sort: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Settings/CommentTags + description: OK + security: + - accountSid_authToken: [] + operationId: FetchInsightsSettingsComment + /v1/Insights/UserRoles: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - roles + mountName: insights_user_roles + className: insights_user_roles + pathType: instance + get: + description: This is used by Flex UI and Quality Management to fetch the Flex + Insights roles for the user + tags: + - FlexV1InsightsUserRoles + parameters: + - name: Authorization + in: header + description: The Authorization HTTP request header schema: type: string responses: @@ -2237,214 +5227,377 @@ paths: content: application/json: schema: - type: object - title: ListInsightsQuestionnairesResponse - properties: - questionnaires: - type: array - items: - $ref: '#/components/schemas/flex.v1.insights_questionnaires' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string + $ref: '#/components/schemas/flex.v1.insights_user_roles' + examples: + fetch: + value: + roles: + - wfo.full_access + url: https://flex-api.twilio.com/v1/Insights/UserRoles description: OK security: - accountSid_authToken: [] - operationId: ListInsightsQuestionnaires - x-maturity: - - Preview - /v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}: + operationId: FetchInsightsUserRoles + /v1/Interactions/{Sid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - - account_sid - - questionnaire_sid - - name + - sid + dependentProperties: + channels: + mapping: + interaction_sid: sid + resource_url: /v1/Interactions/{interaction_sid}/Channels + mountName: interaction pathType: instance - mountName: insights_questionnaires - className: insights_questionnaires - post: - description: To update the questionnaire + get: + description: '' + tags: + - FlexV1Interaction parameters: - - name: QuestionnaireSid + - name: Sid in: path - description: The SID of the questionnaire + description: The SID of the Interaction resource to fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^GM[0-9a-fA-F]{32}$ + pattern: ^KD[0-9a-fA-F]{32}$ required: true - - name: Authorization - in: header - description: The Authorization HTTP request header - schema: - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.insights_questionnaires' + $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 description: OK security: - accountSid_authToken: [] - operationId: UpdateInsightsQuestionnaires - x-maturity: - - Preview + operationId: FetchInteraction + /v1/Interactions: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + dependentProperties: + channels: + mapping: + interaction_sid: sid + resource_url: /v1/Interactions/{interaction_sid}/Channels + mountName: interaction + pathType: list + post: + description: Create a new Interaction. + tags: + - FlexV1Interaction + responses: + '201': + content: + 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 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateInteraction requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateInsightsQuestionnairesRequest + title: CreateInteractionRequest properties: - Active: - type: boolean - description: The flag to enable or disable questionnaire - Name: - type: string - description: The name of this questionnaire - Description: + Channel: + description: The Interaction's channel. + Routing: + description: The Interaction's routing logic. + InteractionContextSid: type: string - description: The description of this questionnaire - QuestionSids: - type: array - items: - type: string - minLength: 34 - maxLength: 34 - pattern: ^GE[0-9a-fA-F]{32}$ - description: The list of questions sids under a questionnaire + minLength: 34 + maxLength: 34 + pattern: ^HQ[0-9a-fA-F]{32}$ + description: The Interaction context sid is used for adding a context + lookup sid required: - - Active - delete: - description: To delete the questionnaire + - Channel + - Routing + examples: + create: + value: + Channel: '{"type":"sms","initiated_by":"customer"}' + Routing: '{}' + InteractionContextSid: interaction_context_sid + /v1/Interactions/{InteractionSid}/Channels/{Sid}: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + dependentProperties: + invites: + mapping: + interaction_sid: interaction_sid + channel_sid: sid + resource_url: /v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Invites + participants: + mapping: + interaction_sid: interaction_sid + channel_sid: sid + resource_url: /v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Participants + parent: /Interactions/{Sid} + className: interaction_channel + pathType: instance + get: + description: Fetch a Channel for an Interaction. + tags: + - FlexV1InteractionChannel parameters: - - name: QuestionnaireSid + - name: InteractionSid in: path - description: The SID of the questionnaire + description: The unique string created by Twilio to identify an Interaction + resource, prefixed with KD. schema: type: string minLength: 34 maxLength: 34 - pattern: ^GM[0-9a-fA-F]{32}$ + pattern: ^KD[0-9a-fA-F]{32}$ required: true - - name: Authorization - in: header - description: The Authorization HTTP request header - schema: - type: string - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteInsightsQuestionnaires - x-maturity: - - Preview - get: - description: To get the Questionnaire Detail - parameters: - - name: QuestionnaireSid + - name: Sid in: path - description: The SID of the questionnaire + description: The unique string created by Twilio to identify an Interaction + Channel resource, prefixed with UO. schema: type: string minLength: 34 maxLength: 34 - pattern: ^GM[0-9a-fA-F]{32}$ + pattern: ^UO[0-9a-fA-F]{32}$ required: true - - name: Authorization - in: header - description: The Authorization HTTP request header - schema: - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.insights_questionnaires' + $ref: '#/components/schemas/flex.v1.interaction.interaction_channel' + examples: + fetch: + value: + sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + type: chat + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: closed + error_code: 19025 + error_message: Channel validation error + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites description: OK security: - accountSid_authToken: [] - operationId: FetchInsightsQuestionnaires - x-maturity: - - Preview - /v1/Insights/QualityManagement/Categories: - servers: - - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - account_sid - - category_sid - - name - pathType: list - mountName: insights_questionnaires_category + operationId: FetchInteractionChannel post: - description: To create a category for Questions + description: Update an existing Interaction Channel. + tags: + - FlexV1InteractionChannel parameters: - - name: Authorization - in: header - description: The Authorization HTTP request header + - name: InteractionSid + in: path + description: The unique string created by Twilio to identify an Interaction + resource, prefixed with KD. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KD[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The unique string created by Twilio to identify an Interaction + Channel resource, prefixed with UO. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^UO[0-9a-fA-F]{32}$ + required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' - description: Created + $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 + description: OK security: - accountSid_authToken: [] - operationId: CreateInsightsQuestionnairesCategory - x-maturity: - - Preview + operationId: UpdateInteractionChannel requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateInsightsQuestionnairesCategoryRequest + title: UpdateInteractionChannelRequest properties: - Name: + Status: type: string - description: The name of this category. + $ref: '#/components/schemas/interaction_channel_enum_update_channel_status' + description: 'Required. Indicates the Interaction channel''s status. + When a channel is set to `closed`, all tasks are put in the `wrapping` + state by default unless the Routing status is set to `closed` + in which case the tasks will be `completed`. When a channel is + set to `inactive`, it is mandatory to set the Routing status as + `closed` else the request will be invalid. Value: `closed`, `inactive`' + Routing: + description: It changes the state of associated tasks. Routing status + is required, When the channel status is set to `inactive`. Allowed + Value for routing status is `closed`. Otherwise Optional, if not + specified, all tasks will be set to `wrapping`. required: - - Name + - Status + examples: + update: + value: + Status: closed + updateStatusClosed: + value: + Status: closed + updateStatusInactive: + value: + Status: inactive + Routing: '{"status":"closed"}' + /v1/Interactions/{InteractionSid}/Channels: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + dependentProperties: + invites: + mapping: + interaction_sid: interaction_sid + channel_sid: sid + resource_url: /v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Invites + participants: + mapping: + interaction_sid: interaction_sid + channel_sid: sid + resource_url: /v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Participants + parent: /Interactions/{Sid} + className: interaction_channel + pathType: list get: - description: To get all the categories + description: List all Channels for an Interaction. + tags: + - FlexV1InteractionChannel parameters: - - name: Authorization - in: header - description: The Authorization HTTP request header + - name: InteractionSid + in: path + description: The unique string created by Twilio to identify an Interaction + resource, prefixed with KD. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^KD[0-9a-fA-F]{32}$ + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2470,197 +5623,217 @@ paths: application/json: schema: type: object - title: ListInsightsQuestionnairesCategoryResponse + title: ListInteractionChannelResponse properties: - categories: + channels: type: array items: - $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' + $ref: '#/components/schemas/flex.v1.interaction.interaction_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + channels: + - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + type: chat + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: closed + error_code: 19025 + error_message: Channel validation error + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites + - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 + type: sms + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + error_code: null + error_message: null + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2/Invites + - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3 + type: email + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 19025 + error_message: Channel validation error + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3/Invites + - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4 + type: voice + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: setup + error_code: null + error_message: null + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4/Invites + - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5 + type: gbm + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 19025 + error_message: Channel validation error + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5/Invites + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels description: OK security: - accountSid_authToken: [] - operationId: ListInsightsQuestionnairesCategory - x-maturity: - - Preview - /v1/Insights/QualityManagement/Categories/{CategorySid}: + operationId: ListInteractionChannel + /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - - account_sid - - category_sid - - name - pathType: instance - mountName: insights_questionnaires_category + - sid + parent: /Interactions/{InteractionSid}/Channels/{Sid} + className: interaction_channel_invite + pathType: list post: - description: To update the category for Questions + description: Invite an Agent or a TaskQueue to a Channel. + tags: + - FlexV1InteractionChannelInvite parameters: - - name: CategorySid + - name: InteractionSid in: path - description: The SID of the category to be updated + description: The Interaction SID for this Channel. schema: type: string minLength: 34 maxLength: 34 - pattern: ^FY[0-9a-fA-F]{32}$ + pattern: ^KD[0-9a-fA-F]{32}$ required: true - - name: Authorization - in: header - description: The Authorization HTTP request header - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateInsightsQuestionnairesCategory - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateInsightsQuestionnairesCategoryRequest - properties: - Name: - type: string - description: The name of this category. - required: - - Name - delete: - description: '' - parameters: - - name: CategorySid + - name: ChannelSid in: path - description: The SID of the category to be deleted + description: The Channel SID for this Invite. schema: type: string minLength: 34 maxLength: 34 - pattern: ^FY[0-9a-fA-F]{32}$ + pattern: ^UO[0-9a-fA-F]{32}$ required: true - - name: Authorization - in: header - description: The Authorization HTTP request header - schema: - type: string - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteInsightsQuestionnairesCategory - x-maturity: - - Preview - /v1/Insights/QualityManagement/Questions: - servers: - - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - account_sid - - question_sid - - question - pathType: list - mountName: insights_questionnaires_question - post: - description: To create a question for a Category - parameters: - - name: Authorization - in: header - description: The Authorization HTTP request header - schema: - type: string responses: '201': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' + $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite' + examples: + create: + value: + sid: KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + routing: + reservation: null + properties: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: 1634845217 + date_updated: 1634845217 + attributes: '{"customerAddress":"customer phone address","flexChannelInviteSid":"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","conversationSid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channelType":"sms","customers":{"phone":"customer + phone address","name":"customer name"},"conversations":{"conversation_id":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","media":[{"type":"ChatTranscript","sid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]},"customerName":"customer + name","flexInteractionChannelSid":"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","flexInteractionSid":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' + assignment_status: pending + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_name: Default Fifo Workflow + queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + queue_name: Sample Queue + priority: 0 + age: 0 + reason: '' + timeout: 86400 + assignmentCounter: 0 + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + routing_target: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_entered_date: 1634845217 + age_in_queue: 0 + addons: '{}' + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateInsightsQuestionnairesQuestion - x-maturity: - - Preview + operationId: CreateInteractionChannelInvite requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateInsightsQuestionnairesQuestionRequest + title: CreateInteractionChannelInviteRequest properties: - CategorySid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^FY[0-9a-fA-F]{32}$ - description: The SID of the category - Question: - type: string - description: The question. - AnswerSetId: - type: string - description: The answer_set for the question. - AllowNa: - type: boolean - description: The flag to enable for disable NA for answer. - Description: - type: string - description: The description for the question. + Routing: + description: The Interaction's routing logic. required: - - CategorySid - - Question - - AnswerSetId - - AllowNa + - Routing + examples: + create: + value: + Routing: '{"properties":{"workspace_sid":"WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","workflow_sid":"WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","worker_sid":"WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","queue_sid":"WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","attributes":{"customerName":"customer + name","customerAddress":"customer email address"}}}' get: - description: To get all the question for the given categories + description: List all Invites for a Channel. + tags: + - FlexV1InteractionChannelInvite parameters: - - name: Authorization - in: header - description: The Authorization HTTP request header + - name: InteractionSid + in: path + description: The Interaction SID for this Channel. schema: type: string - - name: CategorySid - in: query - description: The list of category SIDs + minLength: 34 + maxLength: 34 + pattern: ^KD[0-9a-fA-F]{32}$ + required: true + - name: ChannelSid + in: path + description: The Channel SID for this Participant. schema: - type: array - items: - type: string - minLength: 34 - maxLength: 34 - pattern: ^FY[0-9a-fA-F]{32}$ + type: string + minLength: 34 + maxLength: 34 + pattern: ^UO[0-9a-fA-F]{32}$ + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2686,170 +5859,221 @@ paths: application/json: schema: type: object - title: ListInsightsQuestionnairesQuestionResponse + title: ListInteractionChannelInviteResponse properties: - questions: + invites: type: array items: - $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' + $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + invites: + - sid: KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + routing: + reservation: null + properties: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: 1634845217 + date_updated: 1634845217 + attributes: '{"customerAddress":"customer phone address","flexChannelInviteSid":"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","conversationSid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channelType":"sms","customers":{"phone":"customer + phone address","name":"customer name"},"conversations":{"conversation_id":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","media":[{"type":"ChatTranscript","sid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]},"customerName":"customer + name","flexInteractionChannelSid":"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","flexInteractionSid":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' + assignment_status: pending + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_name: Default Fifo Workflow + queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + queue_name: Sample Queue + priority: 0 + age: 0 + reason: '' + timeout: 86400 + assignmentCounter: 0 + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + routing_target: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_entered_date: 1634845217 + age_in_queue: 0 + addons: '{}' + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + - sid: KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + routing: + reservation: null + properties: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: 1634845217 + date_updated: 1634845217 + attributes: '{"customerAddress":"customer phone address","flexChannelInviteSid":"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","conversationSid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channelType":"sms","customers":{"phone":"customer + phone address","name":"customer name"},"conversations":{"conversation_id":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","media":[{"type":"ChatTranscript","sid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]},"customerName":"customer + name","flexInteractionChannelSid":"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","flexInteractionSid":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' + assignment_status: pending + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_name: Default Fifo Workflow + queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + queue_name: Sample Queue + priority: 0 + age: 0 + reason: '' + timeout: 86400 + assignmentCounter: 0 + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + routing_target: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_entered_date: 1634845217 + age_in_queue: 0 + addons: '{}' + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?PageSize=50&Page=0 + next_page_url: null + key: invites description: OK security: - accountSid_authToken: [] - operationId: ListInsightsQuestionnairesQuestion - x-maturity: - - Preview - /v1/Insights/QualityManagement/Questions/{QuestionSid}: + operationId: ListInteractionChannelInvite + /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - - account_sid - - question_sid - - question - pathType: instance - mountName: insights_questionnaires_question + - sid + parent: /Interactions/{InteractionSid}/Channels/{Sid} + className: interaction_channel_participant + pathType: list post: - description: To update the question + description: Add a Participant to a Channel. + tags: + - FlexV1InteractionChannelParticipant parameters: - - name: QuestionSid + - name: InteractionSid in: path - description: The SID of the question + description: The Interaction Sid for the new Channel Participant. schema: type: string minLength: 34 maxLength: 34 - pattern: ^GE[0-9a-fA-F]{32}$ + pattern: ^KD[0-9a-fA-F]{32}$ required: true - - name: Authorization - in: header - description: The Authorization HTTP request header + - name: ChannelSid + in: path + description: The Channel Sid for the new Channel Participant. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^UO[0-9a-fA-F]{32}$ + required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' - description: OK + $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 + description: Created security: - accountSid_authToken: [] - operationId: UpdateInsightsQuestionnairesQuestion - x-maturity: - - Preview + operationId: CreateInteractionChannelParticipant requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateInsightsQuestionnairesQuestionRequest + title: CreateInteractionChannelParticipantRequest properties: - AllowNa: - type: boolean - description: The flag to enable for disable NA for answer. - CategorySid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^FY[0-9a-fA-F]{32}$ - description: The SID of the category - Question: - type: string - description: The question. - Description: - type: string - description: The description for the question. - AnswerSetId: + Type: type: string - description: The answer_set for the question. + $ref: '#/components/schemas/interaction_channel_participant_enum_type' + description: 'Participant type. Can be: `agent`, `customer`, `supervisor`, + `external` or `unknown`.' + MediaProperties: + description: JSON representing the Media Properties for the new + Participant. + RoutingProperties: + description: Object representing the Routing Properties for the + new Participant. required: - - AllowNa - delete: - description: '' + - 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"}' + get: + description: List all Participants for a Channel. + tags: + - FlexV1InteractionChannelParticipant parameters: - - name: QuestionSid + - name: InteractionSid in: path - description: The SID of the question + description: The Interaction Sid for this channel. schema: type: string minLength: 34 maxLength: 34 - pattern: ^GE[0-9a-fA-F]{32}$ + pattern: ^KD[0-9a-fA-F]{32}$ required: true - - name: Authorization - in: header - description: The Authorization HTTP request header - schema: - type: string - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteInsightsQuestionnairesQuestion - x-maturity: - - Preview - /v1/Insights/Segments: - servers: - - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - segment_id - - external_id - - account_id - - agent_id - - queue - pathType: list - mountName: insights_segments - className: insights_segments - get: - description: To get segments for given reservation Ids - parameters: - - name: Authorization - in: header - description: The Authorization HTTP request header - schema: - type: string - - name: SegmentId - in: query - description: To unique id of the segment + - name: ChannelSid + in: path + description: The Channel Sid for this Participant. schema: type: string - - name: ReservationId - in: query - description: The list of reservation Ids - schema: - type: array - items: - type: string - minLength: 34 - maxLength: 34 - pattern: ^WR[0-9a-fA-F]{32}$ + minLength: 34 + maxLength: 34 + pattern: ^UO[0-9a-fA-F]{32}$ + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2875,371 +6099,528 @@ paths: application/json: schema: type: object - title: ListInsightsSegmentsResponse + title: ListInteractionChannelParticipantResponse properties: - segments: + participants: type: array items: - $ref: '#/components/schemas/flex.v1.insights_segments' + $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + participants: + - sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: customer + 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 description: OK security: - accountSid_authToken: [] - operationId: ListInsightsSegments - x-maturity: - - Preview - /v1/Insights/Session: + operationId: ListInteractionChannelParticipant + /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - - workspace_id - - session_expiry - - session_id - - base_url + - sid + parent: /Interactions/{InteractionSid}/Channels/{Sid} + className: interaction_channel_participant pathType: instance - mountName: insights_session post: - description: To obtain session details for fetching reports and dashboards - parameters: - - name: Authorization - in: header - description: The Authorization HTTP request header - schema: - type: string - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/flex.v1.insights_session' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateInsightsSession - x-maturity: - - Preview - /v1/Insights/QualityManagement/Settings/AnswerSets: - servers: - - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - answer_sets - - answer_set_categories - - not_applicable - pathType: list - mountName: insights_settings_answer_sets - className: insights_settings_answer_sets - get: - description: To get the Answer Set Settings for an Account + description: Update an existing Channel Participant. + tags: + - FlexV1InteractionChannelParticipant parameters: - - name: Authorization - in: header - description: The Authorization HTTP request header + - name: InteractionSid + in: path + description: The Interaction Sid for this channel. schema: type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/flex.v1.insights_settings_answersets' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchInsightsSettingsAnswersets - x-maturity: - - Preview - /v1/Insights/QualityManagement/Settings/CommentTags: - servers: - - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - comments - pathType: list - mountName: insights_settings_comment - get: - description: To get the Comment Settings for an Account - parameters: - - name: Authorization - in: header - description: The Authorization HTTP request header + minLength: 34 + maxLength: 34 + pattern: ^KD[0-9a-fA-F]{32}$ + required: true + - name: ChannelSid + in: path + description: The Channel Sid for this Participant. schema: type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/flex.v1.insights_settings_comment' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchInsightsSettingsComment - x-maturity: - - Preview - /v1/Insights/UserRoles: - servers: - - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - roles - pathType: instance - mountName: insights_user_roles - className: insights_user_roles - get: - description: This is used by Flex UI and Quality Management to fetch the Flex - Insights roles for the user - parameters: - - name: Authorization - in: header - description: The Authorization HTTP request header + minLength: 34 + maxLength: 34 + pattern: ^UO[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The unique string created by Twilio to identify an Interaction + Channel resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^UT[0-9a-fA-F]{32}$ + required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.insights_user_roles' + $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 description: OK security: - accountSid_authToken: [] - operationId: FetchInsightsUserRoles - x-maturity: - - Preview - /v1/Interactions/{Sid}: + operationId: UpdateInteractionChannelParticipant + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateInteractionChannelParticipantRequest + properties: + Status: + type: string + $ref: '#/components/schemas/interaction_channel_participant_enum_status' + description: 'The Participant''s status. Can be: `closed` or `wrapup`. Participant + must be an agent.' + required: + - Status + examples: + update: + value: + Status: closed + updateStatusClosed: + value: + Status: closed + /v1/PluginService/Plugins: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance + - unique_name + - friendly_name dependentProperties: - interaction_channel: '{interaction_sid: sid}' - mountName: interaction + plugin_versions: + mapping: + plugin_sid: sid + resource_url: /v1/PluginService/Plugins/{plugin_sid}/Versions + pathType: list get: description: '' + tags: + - FlexV1Plugin parameters: - - name: Sid - in: path - description: The SID of the Interaction resource to fetch. + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^KD[0-9a-fA-F]{32}$ - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.interaction' + type: object + title: ListPluginResponse + properties: + plugins: + type: array + items: + $ref: '#/components/schemas/flex.v1.plugin' + 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: + 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 description: OK security: - accountSid_authToken: [] - operationId: FetchInteraction - x-maturity: - - GA - /v1/Interactions: - servers: - - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - pathType: list - dependentProperties: - interaction_channel: '{interaction_sid: sid}' - mountName: interaction + operationId: ListPlugin post: - description: Create a new Interaction. + description: '' + tags: + - FlexV1Plugin + parameters: + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string responses: '201': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.interaction' + $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 description: Created security: - accountSid_authToken: [] - operationId: CreateInteraction - x-maturity: - - GA + operationId: CreatePlugin requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateInteractionRequest + title: CreatePluginRequest properties: - Channel: - description: The Interaction's channel. - Routing: - description: The Interaction's routing logic. + UniqueName: + type: string + description: The Flex Plugin's unique name. + FriendlyName: + type: string + description: The Flex Plugin's friendly name. + Description: + type: string + description: A descriptive string that you create to describe the + plugin resource. It can be up to 500 characters long required: - - Channel - - Routing - /v1/Interactions/{InteractionSid}/Channels/{Sid}: + - UniqueName + examples: + create: + value: + UniqueName: unique-name + FriendlyName: friendly name + Description: description + /v1/PluginService/Plugins/{Sid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance + - unique_name + - friendly_name dependentProperties: - interaction_channel_invite: '{interaction_sid: interaction_sid, channel_sid: - sid}' - interaction_channel_participant: '{interaction_sid: interaction_sid, channel_sid: - sid}' - parent: /Interactions/{Sid} - className: interaction_channel + plugin_versions: + mapping: + plugin_sid: sid + resource_url: /v1/PluginService/Plugins/{plugin_sid}/Versions + pathType: instance get: - description: Fetch a Channel for an Interaction. + description: '' + tags: + - FlexV1Plugin parameters: - - name: InteractionSid + - name: Sid in: path - description: The unique string created by Twilio to identify an Interaction - resource, prefixed with KD. + description: The SID of the Flex Plugin resource to fetch. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^KD[0-9a-fA-F]{32}$ required: true - - name: Sid - in: path - description: The unique string created by Twilio to identify an Interaction - Channel resource, prefixed with UO. + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^UO[0-9a-fA-F]{32}$ - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.interaction.interaction_channel' + $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 description: OK security: - accountSid_authToken: [] - operationId: FetchInteractionChannel - x-maturity: - - GA + operationId: FetchPlugin post: - description: Update an existing Interaction Channel. + description: '' + tags: + - FlexV1Plugin parameters: - - name: InteractionSid + - name: Sid in: path - description: The unique string created by Twilio to identify an Interaction - resource, prefixed with KD. + description: The SID of the Flex Plugin resource to update. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^KD[0-9a-fA-F]{32}$ required: true - - name: Sid - in: path - description: The unique string created by Twilio to identify an Interaction - Channel resource, prefixed with UO. + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^UO[0-9a-fA-F]{32}$ - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.interaction.interaction_channel' + $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 description: OK security: - accountSid_authToken: [] - operationId: UpdateInteractionChannel - x-maturity: - - GA + operationId: UpdatePlugin requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateInteractionChannelRequest + title: UpdatePluginRequest properties: - Status: + FriendlyName: type: string - $ref: '#/components/schemas/interaction_channel_enum_status' - description: 'Required. Indicates the Interaction channel''s status. - When a channel is set to `closed`, all tasks are put in the `wrapping` - state by default unless the Routing status is set to `closed` - in which case the tasks will be `completed`. Value: `closed`.' - Routing: - description: Optional. The state of associated tasks. If not specified, - all tasks will be set to `wrapping`. - required: - - Status - /v1/Interactions/{InteractionSid}/Channels: + description: The Flex Plugin's friendly name. + Description: + type: string + 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 + /v1/PluginService/Plugins/{Sid}/Archive: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list - dependentProperties: - interaction_channel_invite: '{interaction_sid: interaction_sid, channel_sid: - sid}' - interaction_channel_participant: '{interaction_sid: interaction_sid, channel_sid: - sid}' - parent: /Interactions/{Sid} - className: interaction_channel - get: - description: List all Channels for an Interaction. + - unique_name + - friendly_name + mountName: plugin_archive + pathType: instance + post: + description: '' + tags: + - FlexV1PluginArchive parameters: - - name: InteractionSid + - name: Sid in: path - description: The unique string created by Twilio to identify an Interaction - resource, prefixed with KD. + description: The SID of the Flex Plugin resource to archive. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^KD[0-9a-fA-F]{32}$ required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: UpdatePluginArchive + /v1/PluginService/Configurations: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - name + - description + dependentProperties: + plugins: + mapping: + configuration_sid: sid + resource_url: /v1/PluginService/Configurations/{configuration_sid}/Plugins + mountName: plugin_configurations + pathType: list + get: + description: '' + tags: + - FlexV1PluginConfiguration + parameters: + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3265,116 +6646,260 @@ paths: application/json: schema: type: object - title: ListInteractionChannelResponse + title: ListPluginConfigurationResponse properties: - channels: + configurations: type: array items: - $ref: '#/components/schemas/flex.v1.interaction.interaction_channel' + $ref: '#/components/schemas/flex.v1.plugin_configuration' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + 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: - accountSid_authToken: [] - operationId: ListInteractionChannel - x-maturity: - - GA - /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites: - servers: - - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - pathType: list - parent: /Interactions/{InteractionSid}/Channels/{Sid} - className: interaction_channel_invite + operationId: ListPluginConfiguration post: - description: Invite an Agent or a TaskQueue to a Channel. + description: '' + tags: + - FlexV1PluginConfiguration parameters: - - name: InteractionSid - in: path - description: The Interaction SID for this Channel. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^KD[0-9a-fA-F]{32}$ - required: true - - name: ChannelSid - in: path - description: The Channel SID for this Invite. + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^UO[0-9a-fA-F]{32}$ - required: true responses: '201': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite' + $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 description: Created security: - accountSid_authToken: [] - operationId: CreateInteractionChannelInvite - x-maturity: - - GA + operationId: CreatePluginConfiguration requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateInteractionChannelInviteRequest + title: CreatePluginConfigurationRequest properties: - Routing: - description: The Interaction's routing logic. + Name: + type: string + description: The Flex Plugin Configuration's name. + Plugins: + type: array + items: {} + description: A list of objects that describe the plugin versions + included in the configuration. Each object contains the sid of + the plugin version. + Description: + type: string + description: The Flex Plugin Configuration's description. required: - - Routing + - Name + examples: + create: + value: + Name: some name + Description: description + Plugins: + - '{"plugin_version": "FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "phase": + 3}' + /v1/PluginService/Configurations/{Sid}: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - name + - description + dependentProperties: + plugins: + mapping: + configuration_sid: sid + resource_url: /v1/PluginService/Configurations/{configuration_sid}/Plugins + mountName: plugin_configurations + pathType: instance get: - description: List all Invites for a Channel. + description: '' + tags: + - FlexV1PluginConfiguration parameters: - - name: InteractionSid + - name: Sid in: path - description: The Interaction SID for this Channel. + description: The SID of the Flex Plugin Configuration resource to fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^KD[0-9a-fA-F]{32}$ + pattern: ^FJ[0-9a-fA-F]{32}$ required: true - - name: ChannelSid + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPluginConfiguration + /v1/PluginService/Configurations/{Sid}/Archive: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - name + - description + mountName: plugin_configuration_archive + pathType: instance + post: + description: '' + tags: + - FlexV1PluginConfigurationArchive + parameters: + - name: Sid in: path - description: The Channel SID for this Participant. + description: The SID of the Flex Plugin Configuration resource to archive. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FJ[0-9a-fA-F]{32}$ + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: UpdatePluginConfigurationArchive + /v1/PluginService/Releases: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - configuration_sid + - date_created + mountName: plugin_releases + pathType: list + get: + description: '' + tags: + - FlexV1PluginRelease + parameters: + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^UO[0-9a-fA-F]{32}$ - required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3400,123 +6925,193 @@ paths: application/json: schema: type: object - title: ListInteractionChannelInviteResponse + title: ListPluginReleaseResponse properties: - invites: + releases: type: array items: - $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite' + $ref: '#/components/schemas/flex.v1.plugin_release' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + 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 description: OK security: - accountSid_authToken: [] - operationId: ListInteractionChannelInvite - x-maturity: - - GA - /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants: - servers: - - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - sid - pathType: list - parent: /Interactions/{InteractionSid}/Channels/{Sid} - className: interaction_channel_participant + operationId: ListPluginRelease post: - description: Add a Participant to a Channel. + description: '' + tags: + - FlexV1PluginRelease parameters: - - name: InteractionSid - in: path - description: The Interaction Sid for the new Channel Participant. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^KD[0-9a-fA-F]{32}$ - required: true - - name: ChannelSid - in: path - description: The Channel Sid for the new Channel Participant. + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^UO[0-9a-fA-F]{32}$ - required: true responses: '201': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant' + $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 description: Created security: - accountSid_authToken: [] - operationId: CreateInteractionChannelParticipant - x-maturity: - - GA + operationId: CreatePluginRelease requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateInteractionChannelParticipantRequest + title: CreatePluginReleaseRequest properties: - Type: + ConfigurationId: type: string - $ref: '#/components/schemas/interaction_channel_participant_enum_type' - description: 'Participant type. Can be: `agent`, `customer`, `supervisor`, - `external` or `unknown`.' - MediaProperties: - description: JSON representing the Media Properties for the new - Participant. + description: The SID or the Version of the Flex Plugin Configuration + to release. required: - - Type - - MediaProperties + - ConfigurationId + examples: + create: + value: + ConfigurationId: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /v1/PluginService/Releases/{Sid}: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - configuration_sid + - date_created + mountName: plugin_releases + pathType: instance get: - description: List all Participants for a Channel. + description: '' + tags: + - FlexV1PluginRelease parameters: - - name: InteractionSid + - name: Sid in: path - description: The Interaction Sid for this channel. + description: The SID of the Flex Plugin Release resource to fetch. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^KD[0-9a-fA-F]{32}$ required: true - - name: ChannelSid + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPluginRelease + /v1/PluginService/Plugins/{PluginSid}/Versions: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - plugin_sid + - version + parent: /PluginService/Plugins/{Sid} + mountName: plugin_versions + className: plugin_versions + pathType: list + get: + description: '' + tags: + - FlexV1PluginVersions + parameters: + - name: PluginSid in: path - description: The Channel Sid for this Participant. + description: The SID of the Flex Plugin the resource to belongs to. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^UO[0-9a-fA-F]{32}$ required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3542,120 +7137,297 @@ paths: application/json: schema: type: object - title: ListInteractionChannelParticipantResponse + title: ListPluginVersionResponse properties: - participants: + plugin_versions: type: array items: - $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant' + $ref: '#/components/schemas/flex.v1.plugin.plugin_version' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + 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 + 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 description: OK security: - accountSid_authToken: [] - operationId: ListInteractionChannelParticipant - x-maturity: - - GA - /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}: + operationId: ListPluginVersion + post: + description: '' + tags: + - FlexV1PluginVersions + parameters: + - name: PluginSid + in: path + description: The SID of the Flex Plugin the resource to belongs to. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '201': + content: + 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 + date_created: '2020-01-10T20:00:00Z' + url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreatePluginVersion + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreatePluginVersionRequest + properties: + Version: + type: string + description: The Flex Plugin Version's version. + PluginUrl: + type: string + format: uri + description: The URL of the Flex Plugin Version bundle + Changelog: + type: string + description: The changelog of the Flex Plugin Version. + Private: + type: boolean + description: Whether this Flex Plugin Version requires authorization. + required: + - Version + - PluginUrl + examples: + create: + value: + Version: 1.0.0 + PluginUrl: https://sample.twil.io/plugin.js + Changelog: the changelog + Private: true + /v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid + - plugin_sid + - version + parent: /PluginService/Plugins/{Sid} + mountName: plugin_versions + className: plugin_versions pathType: instance - parent: /Interactions/{InteractionSid}/Channels/{Sid} - className: interaction_channel_participant - post: - description: Update an existing Channel Participant. + get: + description: '' + tags: + - FlexV1PluginVersions parameters: - - name: InteractionSid + - name: PluginSid in: path - description: The Interaction Sid for this channel. + description: The SID of the Flex Plugin the resource to belongs to. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^KD[0-9a-fA-F]{32}$ required: true - - name: ChannelSid + - name: Sid in: path - description: The Channel Sid for this Participant. + description: The SID of the Flex Plugin Version resource to fetch. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + 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 + date_created: '2020-01-10T20:00:00Z' + url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPluginVersion + /v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}/Archive: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - plugin_sid + - version + mountName: plugin_version_archive + pathType: instance + post: + description: '' + tags: + - FlexV1PluginVersionArchive + parameters: + - name: PluginSid + in: path + description: The SID of the Flex Plugin the resource to belongs to. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^UO[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: The unique string created by Twilio to identify an Interaction - Channel resource. + description: The SID of the Flex Plugin Version resource to archive. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^UO[0-9a-fA-F]{32}$ required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant' + $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 description: OK security: - accountSid_authToken: [] - operationId: UpdateInteractionChannelParticipant - x-maturity: - - GA - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateInteractionChannelParticipantRequest - properties: - Status: - type: string - $ref: '#/components/schemas/interaction_channel_participant_enum_status' - description: 'The Participant''s status. Can be: `closed` or `wrapup`. Participant - must be an agent.' - required: - - Status + operationId: UpdatePluginVersionArchive + /v1/account/provision/status: + servers: + - url: https://flex-api.twilio.com + description: Status for email provisioning + x-twilio: + defaultOutputProperties: + - status + mountName: provisioning_status + pathType: instance + get: + description: '' + tags: + - FlexV1ProvisioningStatus + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchProvisioningStatus /v1/WebChannels: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - flex_flow_sid - pathType: list mountName: web_channel + pathType: list get: description: '' + tags: + - FlexV1WebChannel parameters: - name: PageSize in: query @@ -3689,48 +7461,84 @@ paths: items: $ref: '#/components/schemas/flex.v1.web_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 + next_page_url: null + key: flex_chat_channels + flex_chat_channels: + - flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 + next_page_url: null + key: flex_chat_channels + flex_chat_channels: [] description: OK security: - accountSid_authToken: [] operationId: ListWebChannel - x-maturity: - - GA post: description: '' + tags: + - FlexV1WebChannel responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.web_channel' + examples: + create: + value: + flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateWebChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3764,18 +7572,28 @@ paths: - Identity - CustomerFriendlyName - ChatFriendlyName + examples: + create: + value: + FlexFlowSid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Identity: abc + ChatFriendlyName: firendly1 + CustomerFriendlyName: friendly2 + PreEngagementData: '{}' /v1/WebChannels/{Sid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - flex_flow_sid - pathType: instance mountName: web_channel + pathType: instance get: description: '' + tags: + - FlexV1WebChannel parameters: - name: Sid in: path @@ -3792,14 +7610,23 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.web_channel' + examples: + fetch: + value: + flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWebChannel - x-maturity: - - GA post: description: '' + tags: + - FlexV1WebChannel parameters: - name: Sid in: path @@ -3816,12 +7643,19 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.web_channel' + examples: + update: + value: + flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateWebChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3836,8 +7670,15 @@ paths: PostEngagementData: type: string description: The post-engagement data. + examples: + update: + value: + ChatStatus: inactive + PostEngagementData: '{}' delete: description: '' + tags: + - FlexV1WebChannel parameters: - name: Sid in: path @@ -3854,14 +7695,53 @@ paths: security: - accountSid_authToken: [] operationId: DeleteWebChannel - x-maturity: - - GA servers: - url: https://flex-api.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. +tags: +- name: FlexV1AiInsights +- name: FlexV1Assessments +- name: FlexV1Channel +- name: FlexV1ChannelUser +- name: FlexV1Configuration +- name: FlexV1ConfiguredPlugin +- name: FlexV1FlexFlow +- name: FlexV1FlexVideoOrchestration +- name: FlexV1InsightsAssessmentsComment +- name: FlexV1InsightsConversationalAi +- name: FlexV1InsightsConversations +- name: FlexV1InsightsQuestionnaires +- name: FlexV1InsightsQuestionnairesCategory +- name: FlexV1InsightsQuestionnairesQuestion +- name: FlexV1InsightsSegments +- name: FlexV1InsightsSession +- name: FlexV1InsightsSettingsAnswerSets +- name: FlexV1InsightsSettingsComment +- name: FlexV1InsightsUserRoles +- name: FlexV1Interaction +- 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: FlexV1Plugin +- name: FlexV1PluginArchive +- name: FlexV1PluginConfiguration +- name: FlexV1PluginConfigurationArchive +- name: FlexV1PluginRelease +- name: FlexV1PluginVersionArchive +- name: FlexV1PluginVersions +- name: FlexV1ProvisioningStatus +- name: FlexV1PublicConfiguration +- name: FlexV1Transfer +- name: FlexV1VirtualAgentData +- name: FlexV1WebChannel +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_flex_v2.yaml b/spec/yaml/twilio_flex_v2.yaml index 7dd30ff3..7ed6f34c 100644 --- a/spec/yaml/twilio_flex_v2.yaml +++ b/spec/yaml/twilio_flex_v2.yaml @@ -1,5 +1,24 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: + conductor_flow_enum_flow_type: + type: string + enum: + - StartInboundMessaging + - StartOutboundVoice + - AcceptInvite + - EndInboundMessaging + - EndOutboundVoice + conductor_flow_enum_name: + type: string + enum: + - AcceptInviteFlow + - EndInboundMessagingFlow + - StartInboundMessagingFlow + - StartOutboundVoiceFlow flex.v2.web_channel: type: object properties: @@ -17,10 +36,6 @@ components: description: The unique string representing the User created and should be authorized to participate in the Conversation. For more details, see [User Identity & Access Tokens](https://www.twilio.com/docs/conversations/identity). - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Flex description: This is the public Twilio REST API. @@ -32,33 +47,38 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/WebChats: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - conversation_sid - pathType: list mountName: web_channels className: web_channels + pathType: list post: description: '' + tags: + - FlexV2WebChannels responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v2.web_channel' + examples: + create: + value: + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: seinfeld description: Created security: - accountSid_authToken: [] operationId: CreateWebChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -88,8 +108,19 @@ paths: description: The pre-engagement data. required: - AddressSid + examples: + create: + value: + AddressSid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ChatFriendlyName: LoquaciousLarry + CustomerFriendlyName: LarryDavid servers: - url: https://flex-api.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: FlexV2ConductorFlow +- name: FlexV2User +- name: FlexV2WebChannels +- name: FlexV2WebchatInitToken +- name: FlexV2WebchatRefreshToken +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_frontline_v1.yaml b/spec/yaml/twilio_frontline_v1.yaml index deda0756..e1a6688d 100644 --- a/spec/yaml/twilio_frontline_v1.yaml +++ b/spec/yaml/twilio_frontline_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: frontline.v1.user: type: object @@ -16,10 +20,18 @@ components: description: The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the User. + x-twilio: + pii: + handling: standard + deleteSla: 30 avatar: type: string nullable: true @@ -45,10 +57,6 @@ components: enum: - active - deactivated - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Frontline description: This is the public Twilio REST API. @@ -60,7 +68,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Users/{Sid}: @@ -74,6 +82,8 @@ paths: pathType: instance get: description: Fetch a frontline user + tags: + - FrontlineV1User parameters: - name: Sid in: path @@ -88,14 +98,24 @@ paths: application/json: schema: $ref: '#/components/schemas/frontline.v1.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: john@example.com + friendly_name: John Doe + avatar: https://example.com/profile.png + state: active + is_available: true + url: https://frontline-api.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - Beta post: description: Update an existing frontline user + tags: + - FrontlineV1User parameters: - name: Sid in: path @@ -110,12 +130,20 @@ paths: application/json: schema: $ref: '#/components/schemas/frontline.v1.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: john@example.com + friendly_name: John Doe + avatar: https://example.com/profile.png + state: active + is_available: true + url: https://frontline-api.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -139,9 +167,16 @@ paths: description: Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing). + examples: + update: + value: + State: active + FriendlyName: Name + Avatar: https://example.com/avatar.png + IsAvailable: true servers: - url: https://frontline-api.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: FrontlineV1User +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_insights_v1.yaml b/spec/yaml/twilio_insights_v1.yaml index 5505125e..5a3a5bb3 100644 --- a/spec/yaml/twilio_insights_v1.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: insights.v1.account_settings: type: object @@ -9,16 +13,21 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Account. advanced_features: type: boolean nullable: true + description: A boolean flag indicating whether Advanced Features for Voice + Insights are enabled. voice_trace: type: boolean nullable: true + description: A boolean flag indicating whether Voice Trace is enabled. url: type: string format: uri nullable: true + description: The URL of this resource. insights.v1.call.annotation: type: object properties: @@ -40,58 +49,53 @@ components: type: string $ref: '#/components/schemas/annotation_enum_answered_by' nullable: true - description: 'Which entity answered the call as determined by Answering - Machine Detection. Use this to provide feedback on Answering Machine Detection - accuracy. Possible enumerated values, one of: human, machine. human indicates - the call was answered by a person. machine indicates the call was answered - by an answering machine.' + description: 'Specifies which entity answered the call as determined by + Answering Machine Detection. Possible enumerated values, one of: `human`, + `machine`. `human` indicates the call was answered by a person. `machine` + indicates the call was answered by an answering machine.' connectivity_issue: type: string $ref: '#/components/schemas/annotation_enum_connectivity_issue' nullable: true - description: 'Specify if the call had any connectivity issues. Possible - enumerated values, one : no_connectivity_issue, invalid_number, caller_id, - dropped_call, number_reachability.' + description: Specifies if the call had any connectivity issues. One of `no_connectivity_issue`, + `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`. quality_issues: type: array items: type: string nullable: true - description: 'Specify if the call had any subjective quality issues. Possible - values, one or more of: no_quality_issue, low_volume, choppy_robotic, - echo, dtmf, latency, owa, static_noise. Use comma separated values to - indicate multiple quality issues for the same call' + description: Specifies if the call had any subjective quality issues. Possible + values are one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, + `echo`, `dtmf`, `latency`, `owa`, or `static_noise`. spam: type: boolean nullable: true - description: 'Specify if the call was a spam call. Use this to provide feedback - on whether calls placed from your account were marked as spam, or if inbound - calls received by your account were unwanted spam. Is of type Boolean: - true, false. Use true if the call was a spam call.' + description: 'Specifies if the call was a spam call. Use this to provide + feedback on whether calls placed from your account were marked as spam, + or if inbound calls received by your account were unwanted spam. Is of + type Boolean: true, false. Use true if the call was a spam call.' call_score: type: integer nullable: true - description: 'Specify the call score. This is of type integer. Use a range - of 1-5 to indicate the call experience score, with the following mapping - as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 - : Poor, 1: Bad].' + description: 'Specifies the Call Score, if available. This is of type integer. + Use a range of 1-5 to indicate the call experience score, with the following + mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : + Fair, 2 : Poor, 1: Bad].' comment: type: string nullable: true - description: "Specify any comments pertaining to the call. This of type\ - \ string with a max limit of 100 characters. Twilio does not treat this\ - \ field as PII, so don\u2019t put any PII in here." + description: Specifies any comments pertaining to the call. Twilio does + not treat this field as PII, so no PII should be included in comments. incident: type: string nullable: true - description: "Associate this call with an incident or support ticket. This\ - \ is of type string with a max limit of 100 characters. Twilio does not\ - \ treat this field as PII, so don\u2019t put any PII in here." + description: Incident or support ticket associated with this call. The `incident` + property is of type string with a maximum character limit of 100. Twilio + does not treat this field as PII, so no PII should be included in `incident`. url: type: string format: uri nullable: true - description: The URL of this resource. annotation_enum_answered_by: type: string enum: @@ -145,73 +149,122 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Account. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Call. answered_by: type: string $ref: '#/components/schemas/call_summaries_enum_answered_by' nullable: true + description: The Answered By value for the summarized call based on `Answering + Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, + `machine_end_silence`, `machine_end_other`, `human` or `fax`. Refer to + [AMD](https://www.twilio.com/docs/voice/answering-machine-detection) for + more detail. call_type: type: string $ref: '#/components/schemas/call_summaries_enum_call_type' nullable: true + description: The Call Type of the summarized Call. One of `carrier`, `sip`, + `trunking` or `client`. call_state: type: string $ref: '#/components/schemas/call_summaries_enum_call_state' nullable: true + description: The Call State of the summarized Call. One of `ringing`, `completed`, + `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`. processing_state: type: string $ref: '#/components/schemas/call_summaries_enum_processing_state' nullable: true + description: The Processing State of the Call Summary. The Processing State + will be `partial` until the assembly of the Call Summary finishes, which + occurs approximately 30 minutes after Call end. Then the Processing State + changes to `complete` created_time: type: string format: date-time nullable: true + description: The time at which the Call was created, given in ISO 8601 format. + Can be different from `start_time` in the event of queueing due to CPS start_time: type: string format: date-time nullable: true + description: The time at which the Call was started, given in ISO 8601 format. end_time: type: string format: date-time nullable: true + description: The time at which the Call was ended, given in ISO 8601 format. duration: type: integer nullable: true + description: Duration between when the call was initiated and the call was + ended connect_duration: type: integer nullable: true + description: Duration between when the call was answered and when it ended from: nullable: true + description: The calling party. + x-twilio: + pii: + handling: standard + deleteSla: 30 to: nullable: true + description: The called party. + x-twilio: + pii: + handling: standard + deleteSla: 30 carrier_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a PSTN call. client_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a Client call. sdk_edge: nullable: true + description: Contains metrics and properties for the SDK sensor library + for Client calls. sip_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a SIP Interface or Trunking call. tags: type: array items: type: string nullable: true + description: Tags applied to calls by Voice Insights analysis indicating + a condition that could result in subjective degradation of the call quality. url: type: string format: uri nullable: true + description: The URL of this resource. attributes: nullable: true + description: Attributes capturing call-flow-specific details. properties: nullable: true + description: Contains edge-agnostic call-level details. trust: nullable: true + description: Contains trusted communications details including Branded Call + and verified caller ID. + annotation: + nullable: true call_summaries_enum_answered_by: type: string enum: @@ -286,6 +339,10 @@ components: type: string nullable: true description: Custom label for the conference resource, up to 64 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 create_time: type: string format: date-time @@ -453,6 +510,10 @@ components: type: string nullable: true description: The user-specified label of this participant. + x-twilio: + pii: + handling: standard + deleteSla: 30 conference_sid: type: string minLength: 34 @@ -484,10 +545,18 @@ components: type: string nullable: true description: Caller ID of the calling party. + x-twilio: + pii: + handling: standard + deleteSla: 30 to: type: string nullable: true description: Called party. + x-twilio: + pii: + handling: standard + deleteSla: 30 call_status: type: string $ref: '#/components/schemas/conference_participant_enum_call_status' @@ -632,40 +701,62 @@ components: timestamp: type: string nullable: true + description: Event time. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Call. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Account. edge: type: string $ref: '#/components/schemas/event_enum_twilio_edge' nullable: true + description: The Edge of this Event. One of `unknown_edge`, `carrier_edge`, + `sip_edge`, `sdk_edge` or `client_edge`. group: type: string nullable: true + description: Event group. level: type: string $ref: '#/components/schemas/event_enum_level' nullable: true + description: The Level of this Event. One of `UNKNOWN`, `DEBUG`, `INFO`, + `WARNING` or `ERROR`. name: type: string nullable: true + description: Event name. carrier_edge: nullable: true + description: Represents the connection between Twilio and our immediate + carrier partners. The events here describe the call lifecycle as reported + by Twilio's carrier media gateways. sip_edge: nullable: true + description: Represents the Twilio media gateway for SIP interface and SIP + trunking calls. The events here describe the call lifecycle as reported + by Twilio's public media gateways. sdk_edge: nullable: true + description: Represents the Voice SDK running locally in the browser or + in the Android/iOS application. The events here are emitted by the Voice + SDK in response to certain call progress events, network changes, or call + quality conditions. client_edge: nullable: true + description: Represents the Twilio media gateway for Client calls. The events + here describe the call lifecycle as reported by Twilio's Voice SDK media + gateways. event_enum_twilio_edge: type: string enum: @@ -688,34 +779,50 @@ components: timestamp: type: string nullable: true + description: Timestamp of metric sample. Samples are taken every 10 seconds + and contain the metrics for the previous 10 seconds. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Call. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Account. edge: type: string $ref: '#/components/schemas/metric_enum_twilio_edge' nullable: true + description: The Twilio media edge this Metric was captured on. One of `unknown_edge`, + `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`. direction: type: string $ref: '#/components/schemas/metric_enum_stream_direction' nullable: true + description: The Direction of the media stream from the perspective of the + Twilio media edge. One of `unknown`, `inbound`, `outbound` or `both`. carrier_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a PSTN call. sip_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a SIP Interface or Trunking call. sdk_edge: nullable: true + description: Contains metrics and properties for the SDK sensor library + for Client calls. client_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a Client call. metric_enum_twilio_edge: type: string enum: @@ -740,75 +847,126 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Account. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Call. call_type: type: string $ref: '#/components/schemas/summary_enum_call_type' nullable: true + description: The Call Type of the summarized Call. One of `carrier`, `sip`, + `trunking` or `client`. call_state: type: string $ref: '#/components/schemas/summary_enum_call_state' nullable: true + description: The Call State of the summarized Call. One of `ringing`, `completed`, + `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`. answered_by: type: string $ref: '#/components/schemas/summary_enum_answered_by' nullable: true + description: The Answered By value for the summarized call based on `Answering + Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, + `machine_end_silence`, `machine_end_other`, `human` or `fax`. Refer to + [AMD](https://www.twilio.com/docs/voice/answering-machine-detection) for + more detail. processing_state: type: string $ref: '#/components/schemas/summary_enum_processing_state' nullable: true + description: The Processing State of the Call Summary. The Processing State + will be `partial` until the assembly of the Call Summary finishes, which + occurs approximately 30 minutes after Call end. Then the Processing State + changes to `complete` created_time: type: string format: date-time nullable: true + description: The time at which the Call was created, given in ISO 8601 format. + Can be different from `start_time` in the event of queueing due to CPS start_time: type: string format: date-time nullable: true + description: The time at which the Call was started, given in ISO 8601 format. end_time: type: string format: date-time nullable: true + description: The time at which the Call was ended, given in ISO 8601 format. duration: type: integer nullable: true + description: Duration between when the call was initiated and the call was + ended connect_duration: type: integer nullable: true + description: Duration between when the call was answered and when it ended from: nullable: true + description: The calling party. + x-twilio: + pii: + handling: standard + deleteSla: 30 to: nullable: true + description: The called party. + x-twilio: + pii: + handling: standard + deleteSla: 30 carrier_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a PSTN call. client_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a Client call. sdk_edge: nullable: true + description: Contains metrics and properties for the SDK sensor library + for Client calls. sip_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a SIP Interface or Trunking call. tags: type: array items: type: string nullable: true + description: Tags applied to calls by Voice Insights analysis indicating + a condition that could result in subjective degradation of the call quality. url: type: string format: uri nullable: true + description: The URL of this resource. attributes: nullable: true + description: Attributes capturing call-flow-specific details. properties: nullable: true + description: Contains edge-agnostic call-level details. trust: nullable: true + description: Contains trusted communications details including Branded Call + and verified caller ID. annotation: nullable: true + description: Programmatically labeled annotations for the Call. Developers + can update the Call Summary records with Annotation during or after a + Call. Annotations can be updated as long as the Call Summary record is + addressable via the API. summary_enum_answered_by: type: string enum: @@ -903,7 +1061,7 @@ components: type: string nullable: true description: Reason the participant left the room. See [the list of possible - values here](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#end_reason). + values here](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#end_reason). error_code: type: integer nullable: true @@ -921,7 +1079,7 @@ components: properties: nullable: true description: Object containing information about the participant's data - from the room. See [below](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#properties) + from the room. See [below](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#properties) for more information. edge_location: type: string @@ -933,7 +1091,7 @@ components: publisher_info: nullable: true description: Object containing information about the SDK name and version. - See [below](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#publisher_info) + See [below](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#publisher_info) for more information. url: type: string @@ -1184,10 +1342,6 @@ components: - roaming - umatilla - tokyo - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Insights description: This is the public Twilio REST API. @@ -1199,24 +1353,26 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Voice/Settings: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - advanced_features - voice_trace pathType: instance get: - description: '' + description: Get the Voice Insights Settings. + tags: + - InsightsV1Setting parameters: - name: SubaccountSid in: query - description: '' + description: The unique SID identifier of the Subaccount. schema: type: string minLength: 34 @@ -1228,26 +1384,38 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.account_settings' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_trace: true + advanced_features: true + url: https://insights.twilio.com/v1/Voice/Settings description: OK security: - accountSid_authToken: [] operationId: FetchAccountSettings - x-maturity: - - GA post: - description: '' + description: Update a specific Voice Insights Setting. + tags: + - InsightsV1Setting responses: '200': content: application/json: schema: $ref: '#/components/schemas/insights.v1.account_settings' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_trace: true + advanced_features: true + url: https://insights.twilio.com/v1/Voice/Settings description: OK security: - accountSid_authToken: [] operationId: UpdateAccountSettings - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1257,28 +1425,37 @@ paths: properties: AdvancedFeatures: type: boolean - description: '' + description: A boolean flag to enable Advanced Features for Voice + Insights. VoiceTrace: type: boolean - description: '' + description: A boolean flag to enable Voice Trace. SubaccountSid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ - description: '' + description: The unique SID identifier of the Subaccount. + examples: + update: + value: + VoiceTrace: true + AdvancedFeatures: true + SubaccountSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab /v1/Voice/{CallSid}/Annotation: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - call_sid - account_sid - pathType: instance parent: /Voice/{Sid} + pathType: instance post: - description: Create/Update the annotation for the call + description: Update an Annotation for a specific Call. + tags: + - InsightsV1Annotation parameters: - name: CallSid in: path @@ -1296,12 +1473,25 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.call.annotation' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answered_by: human + connectivity_issue: invalid_number + quality_issues: + - low_volume + - choppy_robotic + spam: true + call_score: 2 + comment: this is a call + incident: https://twilio.zendesk.com/support/tickets/17353089 + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation description: OK security: - accountSid_authToken: [] operationId: UpdateAnnotation - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1312,31 +1502,32 @@ paths: AnsweredBy: type: string $ref: '#/components/schemas/annotation_enum_answered_by' - description: 'Which entity answered the call as determined by Answering - Machine Detection. Use this to provide feedback on Answering Machine - Detection accuracy. Possible enumerated values, one of: human, - machine. human indicates the call was answered by a person. machine - indicates the call was answered by an answering machine.' + description: 'Specify which entity answered the call as determined + by Answering Machine Detection. Use this to provide feedback on + Answering Machine Detection accuracy. Possible enumerated values, + one of: `human`, `machine`. `human` indicates the call was answered + by a person. `machine` indicates the call was answered by an answering + machine.' ConnectivityIssue: type: string $ref: '#/components/schemas/annotation_enum_connectivity_issue' - description: 'Specify if the call had any connectivity issues. Possible - enumerated values, one : no_connectivity_issue, invalid_number, - caller_id, dropped_call, number_reachability.' + description: Specify if the call had any connectivity issues. Possible + enumerated values, one of `no_connectivity_issue`, `invalid_number`, + `caller_id`, `dropped_call`, or `number_reachability`. QualityIssues: type: string - description: 'Specify if the call had any subjective quality issues. - Possible values, one or more of: no_quality_issue, low_volume, - choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma - separated values to indicate multiple quality issues for the same - call' + description: Specify if the call had any subjective quality issues. + Possible values, one or more of `no_quality_issue`, `low_volume`, + `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. + Use comma separated values to indicate multiple quality issues + for the same call. Spam: type: boolean - description: 'Specify if the call was a spam call. Use this to provide - feedback on whether calls placed from your account were marked - as spam, or if inbound calls received by your account were unwanted - spam. Is of type Boolean: true, false. Use true if the call was - a spam call.' + description: A boolean flag to indicate if the call was a spam call. + Use this to provide feedback on whether calls placed from your + account were marked as spam, or if inbound calls received by your + account were unwanted spam. Use `true` if the call was a spam + call. CallScore: type: integer nullable: true @@ -1346,17 +1537,29 @@ paths: 4: Good, 3 : Fair, 2 : Poor, 1: Bad].' Comment: type: string - description: "Specify any comments pertaining to the call. This\ - \ of type string with a max limit of 100 characters. Twilio does\ - \ not treat this field as PII, so don\u2019t put any PII in here." + description: Specify any comments pertaining to the call. `comment` + has a maximum character limit of 100. Twilio does not treat this + field as PII, so no PII should be included in the `comment`. Incident: type: string - description: "Associate this call with an incident or support ticket.\ - \ This is of type string with a max limit of 100 characters. Twilio\ - \ does not treat this field as PII, so don\u2019t put any PII\ - \ in here." + description: Associate this call with an incident or support ticket. + The `incident` parameter is of type string with a maximum character + limit of 100. Twilio does not treat this field as PII, so no PII + should be included in `incident`. + examples: + update: + value: + AnsweredBy: human + ConnectivityIssue: invalid_number + QualityIssues: low_volume,choppy_robotic + Spam: true + CallScore: 2 + Comment: this is a call + Incident: https://twilio.zendesk.com/support/tickets/17353089 get: - description: Fetch a specific Annotation. + description: Get the Annotation for a specific Call. + tags: + - InsightsV1Annotation parameters: - name: CallSid in: path @@ -1373,27 +1576,53 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.call.annotation' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answered_by: human + connectivity_issue: invalid_number + quality_issues: + - low_volume + spam: true + call_score: 2 + comment: this is a call + incident: https://twilio.zendesk.com/support/tickets/17353089 + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation description: OK security: - accountSid_authToken: [] operationId: FetchAnnotation - x-maturity: - - Beta /v1/Voice/{Sid}: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: - event: '{call_sid: sid}' - metric: '{call_sid: sid}' - call_summary: '{call_sid: sid}' - annotation: '{call_sid: sid}' + events: + mapping: + call_sid: sid + resource_url: /v1/Voice/{call_sid}/Events + metrics: + mapping: + call_sid: sid + resource_url: /v1/Voice/{call_sid}/Metrics + summary: + mapping: + call_sid: sid + resource_url: /v1/Voice/{call_sid}/Summary + annotation: + mapping: + call_sid: sid + resource_url: /v1/Voice/{call_sid}/Annotation mountName: calls + pathType: instance get: description: '' + tags: + - InsightsV1Call parameters: - name: Sid in: path @@ -1410,16 +1639,24 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.call' + examples: + fetch: + value: + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + events: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events + metrics: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics + summary: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Summary + annotation: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation description: OK security: - accountSid_authToken: [] operationId: FetchCall - x-maturity: - - GA /v1/Voice/Summaries: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid @@ -1431,133 +1668,220 @@ paths: - connect_duration - call_type - call_state - pathType: list mountName: call_summaries className: call_summaries + pathType: list get: - description: '' + description: Get a list of Call Summaries. + tags: + - InsightsV1CallSummaries parameters: - name: From in: query - description: '' + description: A calling party. Could be an E.164 number, a SIP URI, or a Twilio + Client registered name. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: To in: query - description: '' + description: A called party. Could be an E.164 number, a SIP URI, or a Twilio + Client registered name. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: FromCarrier in: query - description: '' + description: An origination carrier. schema: type: string - name: ToCarrier in: query - description: '' + description: A destination carrier. schema: type: string + examples: + readWithCarrier: + value: AT&T Wireless - name: FromCountryCode in: query - description: '' + description: A source country code based on phone number in From. schema: type: string - name: ToCountryCode in: query - description: '' + description: A destination country code. Based on phone number in To. schema: type: string - name: Branded in: query - description: '' + description: A boolean flag indicating whether or not the calls were branded + using Twilio Branded Calls. schema: type: boolean - name: VerifiedCaller in: query - description: '' + description: A boolean flag indicating whether or not the caller was verified + using SHAKEN/STIR. schema: type: boolean + examples: + readWithTrust: + value: true - name: HasTag in: query - description: '' + description: A boolean flag indicating the presence of one or more [Voice + Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags). schema: type: boolean + examples: + readWithSubaccount: + value: true - name: StartTime in: query - description: '' + description: A Start time of the calls. xm (x minutes), xh (x hours), xd (x + days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h. schema: type: string + examples: + readWithCarrier: + value: 4h + readWithSubaccount: + value: 7d + readWithTrust: + value: 1d + readWithAbnormalSession: + value: 15d - name: EndTime in: query - description: '' + description: An End Time of the calls. xm (x minutes), xh (x hours), xd (x + days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m. schema: type: string - name: CallType in: query - description: '' + description: A Call Type of the calls. One of `carrier`, `sip`, `trunking` + or `client`. schema: type: string + examples: + readWithSubaccount: + value: client + readWithAbnormalSession: + value: sip,trunking - name: CallState in: query - description: '' + description: A Call State of the calls. One of `ringing`, `completed`, `busy`, + `fail`, `noanswer`, `canceled`, `answered`, `undialed`. schema: type: string + examples: + readWithAbnormalSession: + value: completed - name: Direction in: query - description: '' + description: A Direction of the calls. One of `outbound_api`, `outbound_dial`, + `inbound`, `trunking_originating`, `trunking_terminating`. schema: type: string + examples: + readWithTrust: + value: outbound_api,outbound_dial,trunking_terminating - name: ProcessingState in: query - description: '' + description: A Processing State of the Call Summaries. One of `completed`, + `partial` or `all`. schema: type: string $ref: '#/components/schemas/call_summaries_enum_processing_state_request' - name: SortBy in: query - description: '' + description: A Sort By criterion for the returned list of Call Summaries. + One of `start_time` or `end_time`. schema: type: string $ref: '#/components/schemas/call_summaries_enum_sort_by' - name: Subaccount in: query - description: '' + description: A unique SID identifier of a Subaccount. schema: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ + examples: + readWithSubaccount: + value: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - name: AbnormalSession in: query - description: '' + description: A boolean flag indicating an abnormal session where the last + SIP response was not 200 OK. schema: type: boolean + examples: + readWithAbnormalSession: + value: true - name: AnsweredBy in: query - description: '' + description: An Answered By value for the calls based on `Answering Machine + Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, + `machine_end_silence`, `machine_end_other`, `human` or `fax`. schema: type: string $ref: '#/components/schemas/call_summaries_enum_answered_by' - - name: ConnectivityIssues + examples: + readWithCarrier: + value: machine_start + - name: AnsweredByAnnotation in: query - description: '' + description: Either machine or human. schema: type: string - - name: QualityIssues + examples: + readWithAnnotationParameters: + value: human + - name: ConnectivityIssueAnnotation in: query - description: '' + description: A Connectivity Issue with the calls. One of `no_connectivity_issue`, + `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`. schema: type: string - - name: Spam + examples: + readWithAnnotationParameters: + value: invalid_number,dropped_call + - name: QualityIssueAnnotation in: query - description: '' + description: A subjective Quality Issue with the calls. One of `no_quality_issue`, + `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. + schema: + type: string + examples: + readWithAnnotationParameters: + value: choppy_robotic,echo + - name: SpamAnnotation + in: query + description: A boolean flag indicating spam calls. schema: type: boolean - - name: CallScores + examples: + readWithAnnotationParameters: + value: true + - name: CallScoreAnnotation in: query - description: '' + description: 'A Call Score of the calls. Use a range of 1-5 to indicate the + call experience score, with the following mapping as a reference for the + rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].' schema: type: string + examples: + readWithAnnotationParameters: + value: 1,2 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1590,47 +1914,879 @@ paths: items: $ref: '#/components/schemas/insights.v1.call_summaries' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?PageSize=25&Page=0 + previous_page_url: null + next_page_url: null + key: call_summaries + url: https://insights.twilio.com/v1/Voice/Summaries?PageSize=25&Page=0 + call_summaries: [] + readWithCarrier: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0 + previous_page_url: null + next_page_url: null + key: call_summaries + url: https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0 + call_summaries: + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T03:40:25Z' + start_time: '2021-08-25T03:40:25Z' + end_time: '2021-08-25T03:40:45Z' + duration: 20 + connect_duration: 20 + call_type: carrier + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: T-Mobile USA, Inc. + connection: mobile + number_prefix: '1555' + location: + lat: 40.83885 + lon: -74.04568 + country_code: US + to: + callee: '+15555555556' + carrier: AT&T Wireless + connection: mobile + number_prefix: '1555' + location: + lat: 33.42767 + lon: -86.886475 + country_code: US + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxxx + direction: inbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 202 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.48209 + avg: 0.483035 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 218 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.51868 + avg: 0.364434 + tags: + - high_packet_loss + - high_jitter + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 121 + disconnected_by: callee + direction: inbound + trust: + verified_caller: + verified: true + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T02:20:25Z' + start_time: '2021-08-25T02:20:25Z' + end_time: '2021-08-25T02:40:45Z' + duration: 18 + connect_duration: 18 + call_type: carrier + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: T-Mobile USA, Inc. + connection: mobile + number_prefix: '1555' + location: + lat: 40.83885 + lon: -74.04568 + country_code: US + to: + callee: '+15555555556' + carrier: AT&T Wireless + connection: mobile + number_prefix: '1555' + location: + lat: 33.42767 + lon: -86.886475 + country_code: US + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxxx + direction: inbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 100 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.48209 + avg: 0.483035 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 102 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.51868 + avg: 0.364434 + tags: null + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 121 + disconnected_by: callee + direction: inbound + trust: + verified_caller: + verified: true + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + readWithSubaccount: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?CallType=client&StartTime=7d&HasTag=True&Subaccount=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab&PageSize=25&Page=0 + previous_page_url: null + next_page_url: null + key: call_summaries + url: https://insights.twilio.com/v1/Voice/Summaries?CallType=client&StartTime=7d&HasTag=True&Subaccount=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab&PageSize=25&Page=0 + call_summaries: + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + created_time: '2021-08-25T04:16:35Z' + start_time: '2021-08-25T04:16:36Z' + end_time: '2021-08-25T04:16:42Z' + duration: 7 + connect_duration: 6 + call_type: client + call_state: completed + answered_by: machine_start + from: + caller: client:+15555555555 + connection: twilio_sdk + to: + callee: client:TBBXXXXXXXXXXXX + connection: twilio_sdk + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: 54.xxx.xx.xxx + external_media_ip: 54.xxx.xx.xxx + edge_location: xxxxxx + direction: inbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 252 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 5.60994 + avg: 0.933334 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 229 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.960786 + avg: 0.399859 + carrier_edge: null + tags: + - high_pdd + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 58 + disconnected_by: callee + direction: inbound + trust: null + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + created_time: '2021-08-25T04:16:35Z' + start_time: '2021-08-25T04:16:37Z' + end_time: '2021-08-25T04:16:40Z' + duration: 5 + connect_duration: 3 + call_type: client + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: Verizon + connection: landline + number_prefix: '1555' + location: + lat: 40.83885 + lon: -74.04568 + country_code: US + to: + callee: client:TBBTXXXXXX + connection: twilio_sdk + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: 54.xxx.xx.xxx + external_media_ip: 54.xxx.xx.xxx + edge_location: xxxxx + direction: outbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 110 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.05918 + avg: 0.461966 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 147 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.869174 + avg: 0.319674 + carrier_edge: null + tags: null + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 35 + disconnected_by: callee + direction: outbound_api + trust: null + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + readWithTrust: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?Direction=outbound_api%2Coutbound_dial%2Ctrunking_terminating&StartTime=1d&VerifiedCaller=True&PageSize=25&Page=0 + previous_page_url: null + next_page_url: null + key: call_summaries + url: https://insights.twilio.com/v1/Voice/Summaries?Direction=outbound_api%2Coutbound_dial%2Ctrunking_terminating&StartTime=1d&VerifiedCaller=True&PageSize=25&Page=0 + call_summaries: + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T14:31:18Z' + start_time: '2021-08-25T14:31:22Z' + end_time: '2021-08-25T14:32:02Z' + duration: 44 + connect_duration: 41 + call_type: trunking + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: ACS + connection: landline + number_prefix: '1555' + location: + lat: 60.268353 + lon: -141.13632 + country_code: US + to: + callee: '+15555555556' + carrier: Hawaiian Telcom, Inc. - HI + connection: landline + number_prefix: '1555' + location: + lat: 20.956036 + lon: -157.23793 + country_code: US + processing_state: complete + sdk_edge: null + sip_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: 54.xxx.xx.xx + twilio_signaling_ip: 54.xxx.xx.xx + external_signaling_ip: 54.xxx.xx.xx + sip_call_id: xxxxx@0.0.0.0 + user_agent: xxxx + edge_location: xxxxx + trunk_sid: xxxxxxx + direction: inbound + metrics: + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 1953 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.76407 + avg: 0.23138 + latency: + max: 0.386 + avg: 0.3765 + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxx + direction: outbound + tags: + - silence + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 1990 + disconnected_by: caller + direction: trunking_terminating + trust: + verified_caller: + verified: true + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T14:03:31Z' + start_time: '2021-08-25T14:03:32Z' + end_time: '2021-08-25T14:03:38Z' + duration: 7 + connect_duration: 6 + call_type: carrier + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: T-Mobile USA, Inc. + connection: mobile + number_prefix: '1555' + location: + lat: 40.83885 + lon: -74.04568 + country_code: US + to: + callee: '+15555555556' + carrier: T-Mobile USA, Inc. + connection: mobile + number_prefix: '1555' + location: + lat: 34.186115 + lon: -118.43555 + country_code: US + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxx + direction: outbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 229 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.10303 + avg: 0.449886 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 273 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.410031 + avg: 0.295951 + tags: null + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 315 + disconnected_by: callee + direction: outbound_api + trust: + verified_caller: + verified: true + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-24T22:28:17Z' + start_time: '2021-08-24T22:28:20Z' + end_time: '2021-08-24T22:28:23Z' + duration: 4 + connect_duration: 3 + call_type: carrier + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: Hawaiian Telcom, Inc. - HI + connection: landline + number_prefix: '1555' + location: + lat: 20.956036 + lon: -157.23793 + country_code: US + to: + callee: '+15555555556' + connection: pstn + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxx + direction: outbound + metrics: + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 103 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.596712 + avg: 0.251725 + tags: + - silence + attributes: null + properties: + last_sip_response_num: 200 + pdd_ms: 105 + disconnected_by: caller + direction: outbound_dial + trust: null + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + readWithAbnormalSession: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?CallType=sip%2Ctrunking&CallState=completed&StartTime=15d&AbnormalSession=True&PageSize=25&Page=0 + previous_page_url: null + next_page_url: null + key: call_summaries + url: https://insights.twilio.com/v1/Voice/Summaries?CallType=sip%2Ctrunking&CallState=completed&StartTime=15d&AbnormalSession=True&PageSize=25&Page=0 + call_summaries: + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T14:46:40Z' + start_time: '2021-08-25T14:46:40Z' + end_time: '2021-08-25T14:46:52Z' + duration: 12 + connect_duration: 12 + call_type: sip + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: XO Communications, Inc. + connection: landline + number_prefix: '1555' + location: + lat: 40.83885 + lon: -74.04568 + country_code: US + to: + callee: sip:xxxx@xx.xxx.xx.xxx + connection: sip_interface + processing_state: complete + sdk_edge: null + sip_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: xx.xxx.xx.xxx + twilio_signaling_ip: xx.xx.xx.xx + external_media_ip: xx.xxx.xx.xxx + external_signaling_ip: xx.xxx.xx.xxx + sip_call_id: xxxxxxxx@0.0.0.0 + edge_location: xxxxx + direction: outbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 525 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.554729 + avg: 0.229541 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 245 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.03548 + avg: 0.344092 + client_edge: null + carrier_edge: null + tags: null + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 255 + disconnected_by: callee + direction: outbound_dial + trust: null + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T14:31:18Z' + start_time: '2021-08-25T14:31:22Z' + end_time: '2021-08-25T14:32:02Z' + duration: 44 + connect_duration: 41 + call_type: trunking + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: ACS + connection: landline + number_prefix: '1555' + location: + lat: 60.268353 + lon: -141.13632 + country_code: US + to: + callee: '+15555555556' + carrier: Hawaiian Telcom, Inc. - HI + connection: landline + number_prefix: '1555' + location: + lat: 20.956036 + lon: -157.23793 + country_code: US + processing_state: complete + sdk_edge: null + sip_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: 54.xxx.xx.xx + twilio_signaling_ip: 54.xxx.xx.xx + external_signaling_ip: 54.xxx.xx.xx + sip_call_id: xxxxx@0.0.0.0 + user_agent: xxxx + edge_location: xxxxx + trunk_sid: xxxxxxx + direction: inbound + metrics: + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 1953 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.76407 + avg: 0.23138 + latency: + max: 0.386 + avg: 0.3765 + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxx + direction: outbound + tags: + - silence + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 1990 + disconnected_by: caller + direction: trunking_terminating + trust: + verified_caller: + verified: true + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + readWithAnnotationParameters: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?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 description: OK security: - accountSid_authToken: [] operationId: ListCallSummaries - x-maturity: - - GA /v1/Conferences/{ConferenceSid}: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - conference_sid - account_sid - pathType: instance dependentProperties: - conference_participant: '{conference_sid: conference_sid}' + conference_participants: + mapping: + conference_sid: conference_sid + resource_url: /v1/Conferences/{conference_sid}/Participants + pathType: instance get: - description: Fetch a specific Conference. + description: Get a specific Conference Summary. + tags: + - InsightsV1Conference parameters: - name: ConferenceSid in: path @@ -1647,25 +2803,66 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.conference' + examples: + fetch: + value: + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference1 + start_time: '2021-10-08T02:58:51Z' + create_time: '2021-10-08T02:58:47Z' + end_time: '2021-10-08T03:00:02Z' + duration_seconds: 76 + connect_duration_seconds: 72 + status: completed + max_participants: 250 + max_concurrent_participants: 4 + unique_participants: 4 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: us1 + mixer_region_requested: us1 + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 1 + region_configuration: 0 + participant_behavior: 3 + tags: + - duplicate_identity + - detected_silence + - participant_behavior_issues + tag_info: + duplicate_identity: + - participant_identity: client:+10000000000 + participant_sids: + - CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: FetchConference - x-maturity: - - GA /v1/Conferences: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - conference_sid - account_sid - pathType: list dependentProperties: - conference_participant: '{conference_sid: conference_sid}' + conference_participants: + mapping: + conference_sid: conference_sid + resource_url: /v1/Conferences/{conference_sid}/Participants + pathType: list get: - description: Retrieve a list of Conferences. + description: Get a list of Conference Summaries. + tags: + - InsightsV1Conference parameters: - name: ConferenceSid in: query @@ -1677,34 +2874,58 @@ paths: description: Custom label for the conference resource, up to 64 characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readWithFriendlynameStartfailure: + value: outboundConfCallTransferThrice_1 - name: Status in: query description: Conference status. schema: type: string + examples: + readWithRegion: + value: completed + readWithFriendlynameStartfailure: + value: not_started - name: CreatedAfter in: query description: Conferences created after the provided timestamp specified in ISO 8601 format schema: type: string + examples: + readFull: + value: '2021-10-09T17:20:53Z' - name: CreatedBefore in: query description: Conferences created before the provided timestamp specified in ISO 8601 format. schema: type: string + examples: + readFull: + value: '2021-10-12T18:37:53Z' - name: MixerRegion in: query description: Twilio region where the conference media was mixed. schema: type: string + examples: + readWithRegion: + value: au1 - name: Tags in: query description: Tags applied by Twilio for common potential configuration, quality, or performance issues. schema: type: string + examples: + readWithDuplicateIdentity: + value: duplicate_identity - name: Subaccount in: query description: Account SID for the subaccount whose resources you wish to retrieve. @@ -1719,12 +2940,18 @@ paths: during the conference. schema: type: string + examples: + readWithDetectedIssueEndreason: + value: call_quality - name: EndReason in: query description: Conference end reason; e.g. last participant left, modified by API, etc. schema: type: string + examples: + readWithDetectedIssueEndreason: + value: participant_with_end_conference_on_exit_left - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1757,49 +2984,318 @@ paths: items: $ref: '#/components/schemas/insights.v1.conference' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0 + next_page_url: null + key: conferences + conferences: + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 1 + start_time: '2021-10-12T18:11:10Z' + create_time: '2021-10-12T18:11:09Z' + end_time: '2021-10-12T18:11:15Z' + duration_seconds: 7 + connect_duration_seconds: 5 + status: completed + max_participants: 250 + max_concurrent_participants: 2 + unique_participants: 2 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: us1 + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 1 + region_configuration: 0 + participant_behavior: 0 + tags: null + tag_info: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 2 + start_time: null + create_time: '2021-10-12T18:09:21Z' + end_time: '2021-10-12T18:09:21Z' + duration_seconds: 1 + connect_duration_seconds: 0 + status: completed + max_participants: 250 + max_concurrent_participants: 2 + unique_participants: 3 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + mixer_region: us1 + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 1 + region_configuration: 0 + participant_behavior: 0 + tags: + - detected_silence + - participant_behavior_issues + tag_info: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants + readWithRegion: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences?MixerRegion=au1&Status=completed&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences?MixerRegion=au1&Status=completed&PageSize=25&Page=0 + next_page_url: null + key: conferences + conferences: + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 1 + start_time: '2021-10-12T18:19:10Z' + create_time: '2021-10-12T18:19:09Z' + end_time: '2021-10-12T18:20:17Z' + duration_seconds: 7 + connect_duration_seconds: 5 + status: completed + max_participants: 250 + max_concurrent_participants: 2 + unique_participants: 2 + end_reason: participant_with_end_conference_on_exit_kicked + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: au1 + mixer_region_requested: au1 + recording_enabled: true + processing_state: complete + detected_issues: + call_quality: 0 + region_configuration: 2 + participant_behavior: 0 + tags: + - region_configuration_issues + tag_info: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 2 + start_time: '2021-10-12T18:16:53Z' + create_time: '2021-10-12T18:16:51Z' + end_time: '2021-10-12T18:17:20Z' + duration_seconds: 30 + connect_duration_seconds: 27 + status: completed + max_participants: 250 + max_concurrent_participants: 2 + unique_participants: 2 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + mixer_region: au1 + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 0 + region_configuration: 2 + participant_behavior: 3 + tags: + - detected_silence + - region_configuration_issues + - participant_behavior_issues + tag_info: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants + readWithFriendlynameStartfailure: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences?FriendlyName=outboundConfCallTransferThrice_1&Status=not_started&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences?FriendlyName=outboundConfCallTransferThrice_1&Status=not_started&PageSize=25&Page=0 + next_page_url: null + key: conferences + conferences: + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: outboundConfCallTransferThrice_1 + start_time: null + create_time: '2021-11-18T00:09:09Z' + end_time: '2021-11-18T00:09:52Z' + duration_seconds: 7 + connect_duration_seconds: 0 + status: not_started + max_participants: 250 + max_concurrent_participants: 1 + unique_participants: 1 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: null + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 0 + region_configuration: 0 + participant_behavior: 0 + tags: + - participant_behavior_issues + - start_failure + tag_info: + start_failure: + reason: no_concurrent_participants + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + readWithDuplicateIdentity: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences?Tags=duplicate_identity&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences?Tags=duplicate_identity&PageSize=25&Page=0 + next_page_url: null + key: conferences + conferences: + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 1 + start_time: '2021-11-17T16:21:45Z' + create_time: '2021-11-17T16:21:40Z' + end_time: '2021-11-17T16:22:11Z' + duration_seconds: 32 + connect_duration_seconds: 27 + status: not_started + max_participants: 250 + max_concurrent_participants: 3 + unique_participants: 4 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: us1 + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 0 + region_configuration: 0 + participant_behavior: 0 + tags: + - duplicate_identity + - detected_silence + - participant_behavior_issues + tag_info: + duplicate_identity: + - participant_identity: client:+10000000000 + participant_sids: + - CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + readWithDetectedIssueEndreason: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences?DetectedIssues=call_quality&EndReason=participant_with_end_conference_on_exit_left&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences?DetectedIssues=call_quality&EndReason=participant_with_end_conference_on_exit_left&PageSize=25&Page=0 + next_page_url: null + key: conferences + conferences: + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 1 + start_time: '2021-11-17T16:21:45Z' + create_time: '2021-11-17T16:21:40Z' + end_time: '2021-11-17T16:22:11Z' + duration_seconds: 32 + connect_duration_seconds: 27 + status: not_started + max_participants: 250 + max_concurrent_participants: 3 + unique_participants: 3 + end_reason: participant_with_end_conference_on_exit_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: us1 + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 3 + region_configuration: 0 + participant_behavior: 1 + tags: + - high_packet_loss + - low_mos + - participant_behavior_issues + - quality_warnings + - high_jitter + - detected_silence + tag_info: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: ListConference - x-maturity: - - GA /v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - participant_sid - conference_sid - call_sid - account_sid - pathType: instance parent: /Conferences/{ConferenceSid} mountName: conference_participants + pathType: instance get: - description: Fetch a specific Conference Participant Summary. + description: Get a specific Conference Participant Summary for a Conference. + tags: + - InsightsV1ConferenceParticipant parameters: - name: ConferenceSid in: path @@ -1836,27 +3332,87 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.conference.conference_participant' + examples: + fetch: + value: + participant_sid: CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_direction: outbound + from: '+10000000000' + to: '+1000000001' + call_status: completed + country_code: US + is_moderator: true + join_time: '2021-10-08T02:58:59Z' + leave_time: '2021-10-08T03:00:02Z' + duration_seconds: 64 + outbound_queue_length: 0 + outbound_time_in_queue: 965 + jitter_buffer_size: null + is_coach: false + coached_participants: null + participant_region: us1 + conference_region: us1 + call_type: carrier + processing_state: complete + properties: + start_conference_on_enter: false + end_conference_on_exit: false + play_early_media: false + enter_muted: true + beep_on_enter: false + beep_on_exit: false + events: + mute: + - 1633705131000 + metrics: + inbound: + total_packets_lost: 0 + total_packets_received: 49 + packet_loss_percentage: 0.0 + jitter: + avg: 0.34 + max: 0.53 + latency: + avg: 0.0 + max: 0.0 + mos: 4.4 + outbound: + total_packets_lost: 0 + total_packets_received: 126 + packet_loss_percentage: 0 + jitter: + avg: 0.01 + max: 0.01 + latency: + avg: 0 + max: 0 + mos: 4.4 + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConferenceParticipant - x-maturity: - - GA /v1/Conferences/{ConferenceSid}/Participants: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - participant_sid - conference_sid - call_sid - account_sid - pathType: list parent: /Conferences/{ConferenceSid} mountName: conference_participants + pathType: list get: - description: List Conference Participants. + description: Get a list of Conference Participants Summaries for a Conference. + tags: + - InsightsV1ConferenceParticipant parameters: - name: ConferenceSid in: path @@ -1877,6 +3433,13 @@ paths: description: User-specified label for a participant. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readWithLabel: + value: client - name: Events in: query description: Conference events generated by application or participant activity; @@ -1915,38 +3478,228 @@ paths: items: $ref: '#/components/schemas/insights.v1.conference.conference_participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0 + next_page_url: null + key: participants + participants: + - participant_sid: CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_direction: outbound + from: '+10000000000' + to: '+10000000001' + call_status: completed + country_code: US + is_moderator: true + join_time: '2021-10-08T02:58:51Z' + leave_time: '2021-10-08T02:59:55Z' + duration_seconds: 65 + outbound_queue_length: 0 + outbound_time_in_queue: 3361 + jitter_buffer_size: null + is_coach: false + coached_participants: null + participant_region: us1 + conference_region: us1 + call_type: carrier + processing_state: complete + properties: + start_conference_on_enter: true + end_conference_on_exit: false + play_early_media: true + enter_muted: false + beep_on_enter: false + beep_on_exit: false + metrics: + inbound: + total_packets_lost: 0 + total_packets_received: 70 + packet_loss_percentage: 0.0 + jitter: + avg: 0.41 + max: 0.84 + latency: + avg: 0.0 + max: 0.0 + mos: 4.4 + outbound: + total_packets_lost: 0 + total_packets_received: 126 + packet_loss_percentage: 0 + jitter: + avg: 0.01 + max: 0.01 + latency: + avg: 0 + max: 0 + mos: 4.4 + events: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - participant_sid: CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_direction: outbound + from: '+10000000000' + to: '+10000000002' + call_status: completed + country_code: US + is_moderator: true + join_time: '2021-10-08T02:58:52Z' + leave_time: '2021-10-08T02:59:54Z' + duration_seconds: 63 + outbound_queue_length: 0 + outbound_time_in_queue: 321 + jitter_buffer_size: null + is_coach: false + coached_participants: null + participant_region: us1 + conference_region: us1 + call_type: carrier + processing_state: complete + properties: + start_conference_on_enter: false + end_conference_on_exit: false + early_media: false + enter_muted: true + beep_on_enter: false + beep_on_exit: false + metrics: + inbound: + total_packets_lost: 0 + total_packets_received: 16 + packet_loss_percentage: 0 + jitter: + avg: 0.26 + max: 0.45 + latency: + avg: 0 + max: 0 + mos: 4.4 + outbound: + total_packets_lost: 0 + total_packets_received: 42 + packet_loss_percentage: 0 + jitter: + avg: 0.03 + max: 0.08 + latency: + avg: 0 + max: 0 + mos: 4.4 + tags: + - silent + events: + mute: + - 1633705131000 + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + readWithLabel: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0 + next_page_url: null + key: participants + participants: + - participant_sid: CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_direction: outbound + from: '+10000000000' + to: '+10000000001' + call_status: completed + country_code: US + is_moderator: true + join_time: '2021-10-08T02:58:51Z' + leave_time: '2021-10-08T02:59:55Z' + duration_seconds: 65 + label: client + outbound_queue_length: 0 + outbound_time_in_queue: 3361 + jitter_buffer_size: null + is_coach: false + coached_participants: null + participant_region: us1 + conference_region: us1 + call_type: carrier + processing_state: complete + properties: + start_conference_on_enter: true + end_conference_on_exit: false + play_early_media: true + enter_muted: false + beep_on_enter: false + beep_on_exit: false + metrics: + inbound: + total_packets_lost: 0 + total_packets_received: 70 + packet_loss_percentage: 0.0 + jitter: + avg: 0.41 + max: 0.84 + latency: + avg: 0.0 + max: 0.0 + mos: 4.4 + outbound: + total_packets_lost: 0 + total_packets_received: 96 + packet_loss_percentage: 0 + jitter: + avg: 0.01 + max: 0.01 + latency: + avg: 0 + max: 0 + mos: 4.4 + events: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListConferenceParticipant - x-maturity: - - GA /v1/Voice/{CallSid}/Events: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - timestamp @@ -1954,14 +3707,16 @@ paths: - account_sid - edge - name - pathType: list parent: /Voice/{Sid} + pathType: list get: - description: '' + description: Get a list of Call Insight Events for a Call. + tags: + - InsightsV1Event parameters: - name: CallSid in: path - description: '' + description: The unique SID identifier of the Call. schema: type: string minLength: 34 @@ -1970,7 +3725,8 @@ paths: required: true - name: Edge in: query - description: '' + description: The Edge of this Event. One of `unknown_edge`, `carrier_edge`, + `sip_edge`, `sdk_edge` or `client_edge`. schema: type: string $ref: '#/components/schemas/event_enum_twilio_edge' @@ -2006,38 +3762,129 @@ paths: items: $ref: '#/components/schemas/insights.v1.call.event' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: events + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0 + events: + - timestamp: '2019-09-19T22:15:23Z' + call_sid: CA03a02b156c6faa96c86906f7e9ad0f38 + account_sid: AC998c10b68cbfda9f67277f7d8f4439c9 + edge: sdk_edge + group: connection + name: error + level: ERROR + sdk_edge: + error: + code: 31600 + metadata: + client_name: GTI9300323095d271b890c91568931321395 + location: + lat: 37.4192 + lon: -122.0574 + city: Mountain View + country_code: US + country_subdivision: California + ip_address: 108.177.7.83 + sdk: + type: twilio-voice-android + version: 4.5.1 + platform: android + selected_region: gll + os: + name: android + version: '4.3' + device: + model: GT-I9300 + type: GT-I9300 + vendor: samsung + arch: armeabi-v7a + client_edge: null + carrier_edge: null + sip_edge: null + readDeep: + value: + meta: + page: 10 + page_size: 5 + first_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=0 + previous_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=9&PageToken=DP10 + next_page_url: null + key: events + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=10 + events: + - timestamp: '2019-09-19T22:15:23Z' + call_sid: CA03a02b156c6faa96c86906f7e9ad0f38 + account_sid: AC998c10b68cbfda9f67277f7d8f4439c9 + edge: sdk_edge + group: connection + name: error + level: ERROR + sdk_edge: + error: + code: 31600 + metadata: + client_name: GTI9300323095d271b890c91568931321395 + location: + lat: 37.4192 + lon: -122.0574 + city: Mountain View + country_code: US + country_subdivision: California + ip_address: 108.177.7.83 + sdk: + type: twilio-voice-android + version: 4.5.1 + platform: android + selected_region: gll + os: + name: android + version: '4.3' + device: + model: GT-I9300 + type: GT-I9300 + vendor: samsung + arch: armeabi-v7a + client_edge: null + carrier_edge: null + sip_edge: null description: OK security: - accountSid_authToken: [] operationId: ListEvent - x-maturity: - - Preview /v1/Voice/{CallSid}/Metrics: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - timestamp @@ -2045,14 +3892,16 @@ paths: - account_sid - edge - direction - pathType: list parent: /Voice/{Sid} + pathType: list get: - description: '' + description: Get a list of Call Metrics for a Call. + tags: + - InsightsV1Metric parameters: - name: CallSid in: path - description: '' + description: The unique SID identifier of the Call. schema: type: string minLength: 34 @@ -2061,16 +3910,24 @@ paths: required: true - name: Edge in: query - description: '' + description: The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, + `sip_edge`, `sdk_edge` or `client_edge`. schema: type: string $ref: '#/components/schemas/metric_enum_twilio_edge' + examples: + readFull: + value: sdk_edge - name: Direction in: query - description: '' + description: The Direction of this Metric. One of `unknown`, `inbound`, `outbound` + or `both`. schema: type: string $ref: '#/components/schemas/metric_enum_stream_direction' + examples: + readFull: + value: both - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2103,53 +3960,132 @@ paths: items: $ref: '#/components/schemas/insights.v1.call.metric' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: metrics + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?PageSize=50&Page=0 + metrics: + - timestamp: '2019-10-07T22:32:06Z' + call_sid: CA7569efe0253644fa4a88aa97beca3310 + account_sid: AC998c10b68cbfda9f67277f7d8f4439c9 + edge: sdk_edge + direction: both + sdk_edge: + interval: + packets_received: 50 + packets_lost: 0 + audio_in: + value: 81.0 + audio_out: + value: 5237.0 + jitter: + value: 9 + mos: + value: 4.39 + rtt: + value: 81 + cumulative: + bytes_received: 547788 + bytes_sent: 329425 + packets_received: 3900 + packets_lost: 0 + packets_sent: 3934 + client_edge: null + carrier_edge: null + sip_edge: null + readFull: + value: + meta: + page: 10 + page_size: 5 + first_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=0 + previous_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=9&PageToken=DP10 + next_page_url: null + key: metrics + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=10 + metrics: + - timestamp: '2019-10-07T22:32:06Z' + call_sid: CA7569efe0253644fa4a88aa97beca3310 + account_sid: AC998c10b68cbfda9f67277f7d8f4439c9 + edge: sdk_edge + direction: both + sdk_edge: + interval: + packets_received: 50 + packets_lost: 0 + audio_in: + value: 81.0 + audio_out: + value: 5237.0 + jitter: + value: 9 + mos: + value: 4.39 + rtt: + value: 81 + cumulative: + bytes_received: 547788 + bytes_sent: 329425 + packets_received: 3900 + packets_lost: 0 + packets_sent: 3934 + client_edge: null + carrier_edge: null + sip_edge: null description: OK security: - accountSid_authToken: [] operationId: ListMetric - x-maturity: - - Preview /v1/Voice/{CallSid}/Summary: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - call_type - call_state - processing_state - duration - pathType: instance parent: /Voice/{Sid} className: call_summary + pathType: instance get: - description: '' + description: Get a specific Call Summary. + tags: + - InsightsV1CallSummary parameters: - name: CallSid in: path - description: '' + description: The unique SID identifier of the Call. schema: type: string minLength: 34 @@ -2158,7 +4094,8 @@ paths: required: true - name: ProcessingState in: query - description: '' + description: The Processing State of this Call Summary. One of `complete`, + `partial` or `all`. schema: type: string $ref: '#/components/schemas/summary_enum_processing_state' @@ -2168,23 +4105,60 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.call.summary' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_type: carrier + call_state: ringing + answered_by: machine_start + processing_state: complete + created_time: '2015-07-30T20:00:00Z' + start_time: '2015-07-30T20:00:00Z' + end_time: '2015-07-30T20:00:00Z' + duration: 100 + connect_duration: 99 + from: {} + to: {} + carrier_edge: {} + client_edge: {} + sdk_edge: {} + sip_edge: {} + tags: + - tags + attributes: {} + properties: {} + trust: {} + annotation: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answered_by: human + connectivity_issue: invalid_number + quality_issues: + - low_volume + spam: true + call_score: 2 + comment: this is a call + incident: https://twilio.zendesk.com/support/tickets/17353089 + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Summary description: OK security: - accountSid_authToken: [] operationId: FetchSummary - x-maturity: - - GA /v1/Video/Rooms/{RoomSid}/Participants/{ParticipantSid}: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - participant_sid - pathType: instance parent: /Video/Rooms/{RoomSid} + pathType: instance get: description: Get Video Log Analyzer data for a Room Participant. + tags: + - InsightsV1Participant parameters: - name: RoomSid in: path @@ -2204,23 +4178,44 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.video_room_summary.video_participant_summary' + examples: + fetch: + value: + publisher_info: {} + edge_location: ashburn + join_time: '2015-07-30T20:00:00Z' + leave_time: '2015-07-30T20:00:00Z' + end_reason: disconnected_via_api + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + error_code: 0 + media_region: us1 + properties: {} + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + error_code_url: error_code_url + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + codecs: + - VP8 + status: in_progress + duration_sec: 50000000 + participant_identity: participant_identity + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchVideoParticipantSummary - x-maturity: - - Beta /v1/Video/Rooms/{RoomSid}/Participants: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - participant_sid - pathType: list parent: /Video/Rooms/{RoomSid} + pathType: list get: description: Get a list of room participants. + tags: + - InsightsV1Participant parameters: - name: RoomSid in: path @@ -2260,47 +4255,91 @@ paths: items: $ref: '#/components/schemas/insights.v1.video_room_summary.video_participant_summary' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + key: participants + first_page_url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + page_size: 50 + next_page_url: null + page: 0 + previous_page_url: null + participants: [] + readFull: + value: + meta: + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + key: participants + first_page_url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + page_size: 50 + next_page_url: null + page: 0 + previous_page_url: null + participants: + - publisher_info: {} + edge_location: ashburn + join_time: '2015-07-30T20:00:00Z' + leave_time: '2015-07-30T20:00:00Z' + end_reason: disconnected_via_api + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + error_code: 53205 + media_region: us1 + properties: {} + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + error_code_url: error_code_url + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + codecs: + - VP8 + status: in_progress + duration_sec: 50000000 + participant_identity: participant_identity + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListVideoParticipantSummary - x-maturity: - - Beta /v1/Video/Rooms/{RoomSid}: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - room_sid - create_time - pathType: instance dependentProperties: - participant: '{room_sid: room_sid}' + participants: + mapping: + room_sid: room_sid + resource_url: /v1/Video/Rooms/{room_sid}/Participants + pathType: instance get: description: Get Video Log Analyzer data for a Room. + tags: + - InsightsV1Room parameters: - name: RoomSid in: path @@ -2314,25 +4353,59 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.video_room_summary' + examples: + fetch: + value: + room_type: go + unique_participant_identities: 0 + codecs: + - VP8 + max_participants: 0 + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + create_time: '2015-07-30T20:00:00Z' + end_reason: room_ended_via_api + duration_sec: 50000000 + room_status: in_progress + media_region: us1 + recording_enabled: false + edge_location: ashburn + max_concurrent_participants: 0 + unique_participants: 0 + room_name: room_name + created_method: sdk + total_participant_duration_sec: 50000000 + status_callback_method: GET + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + end_time: '2015-07-30T20:00:00Z' + total_recording_duration_sec: 50000000 + processing_state: complete + concurrent_participants: 0 + status_callback: http://www.example.com + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: FetchVideoRoomSummary - x-maturity: - - Beta /v1/Video/Rooms: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - room_sid - create_time - pathType: list dependentProperties: - participant: '{room_sid: room_sid}' + participants: + mapping: + room_sid: room_sid + resource_url: /v1/Video/Rooms/{room_sid}/Participants + pathType: list get: description: Get a list of Programmable Video Rooms. + tags: + - InsightsV1Room parameters: - name: RoomType in: query @@ -2400,43 +4473,96 @@ paths: items: $ref: '#/components/schemas/insights.v1.video_room_summary' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0 + url: https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0 + page_size: 50 + next_page_url: null + key: rooms + page: 0 + previous_page_url: null + rooms: [] + readFull: + value: + meta: + first_page_url: https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0 + url: https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0 + page_size: 50 + next_page_url: null + key: rooms + page: 0 + previous_page_url: null + rooms: + - room_type: go + unique_participant_identities: 0 + codecs: + - VP8 + max_participants: 0 + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + create_time: '2015-07-30T20:00:00Z' + end_reason: room_ended_via_api + duration_sec: 50000000 + room_status: in_progress + media_region: us1 + recording_enabled: false + edge_location: ashburn + max_concurrent_participants: 0 + unique_participants: 0 + room_name: room_name + created_method: sdk + total_participant_duration_sec: 50000000 + status_callback_method: GET + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + end_time: '2015-07-30T20:00:00Z' + total_recording_duration_sec: 50000000 + processing_state: complete + concurrent_participants: 0 + status_callback: http://www.example.com + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: ListVideoRoomSummary - x-maturity: - - Beta servers: - url: https://insights.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. +tags: +- name: InsightsV1Annotation +- name: InsightsV1Call +- name: InsightsV1CallSummaries +- name: InsightsV1CallSummary +- name: InsightsV1Conference +- name: InsightsV1ConferenceParticipant +- name: InsightsV1Event +- name: InsightsV1Metric +- name: InsightsV1Participant +- name: InsightsV1Room +- name: InsightsV1Setting +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_intelligence_v2.yaml b/spec/yaml/twilio_intelligence_v2.yaml index 64d70d05..a405b948 100644 --- a/spec/yaml/twilio_intelligence_v2.yaml +++ b/spec/yaml/twilio_intelligence_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: intelligence.v2.transcript.media: type: object @@ -97,6 +101,10 @@ components: nullable: true description: List of text extraction results. This might be available on classify-extract model outputs. + text_generation_results: + nullable: true + description: Output of a text generation operator for example Conversation + Sumamary. transcript_sid: type: string minLength: 34 @@ -142,6 +150,10 @@ components: type: string nullable: true description: Transcript text. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 sid: type: string minLength: 34 @@ -182,9 +194,12 @@ components: data_logging: type: boolean nullable: true - description: Data logging allows Twilio to improve the quality of the speech - recognition through using customer data to refine its speech recognition - models. + description: 'Data logging allows Twilio to improve the quality of the speech + recognition & language understanding services through using customer data + to refine, fine tune and evaluate machine learning models. + + Note: Data logging cannot be activated via API, only via www.twilio.com, + as it requires additional consent.' date_created: type: string format: date-time @@ -286,9 +301,12 @@ components: data_logging: type: boolean nullable: true - description: Data logging allows Twilio to improve the quality of the speech - recognition through using customer data to refine its speech recognition - models. + description: 'Data logging allows Twilio to improve the quality of the speech + recognition & language understanding services through using customer data + to refine, fine tune and evaluate machine learning models. + + Note: Data logging cannot be activated via API, only via www.twilio.com, + as it requires additional consent.' language_code: type: string nullable: true @@ -335,10 +353,6 @@ components: - outbound - internal - unknown - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Intelligence description: This is the public Twilio REST API. @@ -350,22 +364,24 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Transcripts/{Sid}/Media: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - service_sid - sid - pathType: instance parent: /Transcripts/{Sid} + pathType: instance get: description: Get download URLs for media if possible + tags: + - IntelligenceV2Media parameters: - name: Sid in: path @@ -378,33 +394,51 @@ paths: required: true - name: Redacted in: query - description: Grant access to PII Redacted/Unredacted Media. The default is - `true` to access redacted media. + 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' responses: '200': content: application/json: schema: $ref: '#/components/schemas/intelligence.v2.transcript.media' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_url: https://media.server.com/media.wav + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + fetchParams: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_url: https://media.server.com/media.wav + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media description: OK security: - accountSid_authToken: [] operationId: FetchMedia - x-maturity: - - Beta /v2/Transcripts/{TranscriptSid}/OperatorResults: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - operator_sid - pathType: list parent: /Transcripts/{Sid} + pathType: list get: description: Retrieve a list of Operator Results for the given Transcript. + tags: + - IntelligenceV2OperatorResult parameters: - name: TranscriptSid in: path @@ -418,9 +452,12 @@ paths: - name: Redacted in: query description: Grant access to PII redacted/unredacted Language Understanding - operator. The default is True. + operator. If redaction is enabled, the default is True. schema: type: boolean + examples: + readFull: + value: 'True' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -453,45 +490,84 @@ paths: items: $ref: '#/components/schemas/intelligence.v2.transcript.operator_result' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + operator_results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0 + previous_page_url: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0 + next_page_url: null + key: operator_results + readFull: + value: + operator_results: + - operator_type: conversation_classify + name: name + operator_sid: LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + extract_match: false + match_probability: '0.05' + normalized_result: normalized_result + utterance_results: + - {} + utterance_match: false + predicted_label: predicted_label + predicted_probability: '0.05' + label_probabilities: {} + extract_results: {} + 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 description: OK security: - accountSid_authToken: [] operationId: ListOperatorResult - x-maturity: - - Beta /v2/Transcripts/{TranscriptSid}/OperatorResults/{OperatorSid}: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - operator_sid - pathType: instance parent: /Transcripts/{Sid} + pathType: instance get: description: Fetch a specific Operator Result for the given Transcript. + tags: + - IntelligenceV2OperatorResult parameters: - name: TranscriptSid in: path @@ -515,25 +591,45 @@ paths: - name: Redacted in: query description: Grant access to PII redacted/unredacted Language Understanding - operator. The default is True. + operator. If redaction is enabled, the default is True. schema: type: boolean + examples: + fetch: + value: 'False' responses: '200': content: application/json: schema: $ref: '#/components/schemas/intelligence.v2.transcript.operator_result' + examples: + fetch: + value: + operator_type: conversation_classify + name: name + operator_sid: LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + extract_match: false + match_probability: '0.05' + normalized_result: normalized_result + utterance_results: + - {} + utterance_match: false + predicted_label: predicted_label + predicted_probability: '0.05' + label_probabilities: {} + extract_results: {} + text_generation_results: {} + transcript_sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchOperatorResult - x-maturity: - - Beta /v2/Transcripts/{TranscriptSid}/Sentences: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -543,10 +639,12 @@ paths: - start_time - end_time - confidence - pathType: list parent: /Transcripts/{Sid} + pathType: list get: description: Get all Transcript Sentences by TranscriptSid + tags: + - IntelligenceV2Sentence parameters: - name: TranscriptSid in: path @@ -559,10 +657,13 @@ paths: required: true - name: Redacted in: query - description: Grant access to PII Redacted/Unredacted Sentences. The default - is `true` to access redacted sentences. + 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' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -595,38 +696,73 @@ paths: items: $ref: '#/components/schemas/intelligence.v2.transcript.sentence' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + sentences: + - media_channel: 1 + sentence_index: 0 + start_time: null + end_time: null + transcript: test test + sid: GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + confidence: null + meta: + key: sentences + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0 + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + readParams: + value: + sentences: + - media_channel: 1 + sentence_index: 0 + start_time: null + end_time: null + transcript: test test + sid: GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + confidence: null + meta: + key: sentences + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0 + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0 + next_page_url: null + previous_page_url: null description: OK security: - accountSid_authToken: [] operationId: ListSentence - x-maturity: - - Beta /v2/Services: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -638,18 +774,36 @@ paths: pathType: list post: description: Create a new Service for the given Account + tags: + - IntelligenceV2Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/intelligence.v2.service' + examples: + create: + value: + sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: something + friendly_name: some friendly name + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + auto_redaction: false + media_redaction: false + auto_transcribe: true + data_logging: true + language_code: en-US + webhook_url: https://www.twilio.com + webhook_http_method: POST + version: 1 + url: https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -668,9 +822,13 @@ paths: transcribe all recordings made on the account. DataLogging: type: boolean - description: Data logging allows Twilio to improve the quality of - the speech recognition through using customer data to refine its - speech recognition models. + description: 'Data logging allows Twilio to improve the quality + of the speech recognition & language understanding services through + using customer data to refine, fine tune and evaluate machine + learning models. + + Note: Data logging cannot be activated via API, only via www.twilio.com, + as it requires additional consent.' FriendlyName: type: string description: A human readable description of this resource, up to @@ -696,8 +854,18 @@ paths: description: The HTTP method for the Webhook. One of `GET` or `POST`. required: - UniqueName + examples: + create: + value: + UniqueName: something + FriendlyName: some friendly name + LanguageCode: en-US + WebhookUrl: https://www.twilio.com + WebhookHttpMethod: POST get: description: Retrieves a list of all Services for an account. + tags: + - IntelligenceV2Service parameters: - name: PageSize in: query @@ -731,38 +899,74 @@ paths: items: $ref: '#/components/schemas/intelligence.v2.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + services: + - sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: something + friendly_name: some friendly name + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + auto_redaction: false + media_redaction: false + auto_transcribe: true + data_logging: true + language_code: en-US + webhook_url: https://www.twilio.com + webhook_http_method: POST + version: 1 + url: https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + key: services + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + url: https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0 + readEmpty: + value: + services: [] + meta: + key: services + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + url: https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - Beta /v2/Services/{Sid}: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -774,6 +978,8 @@ paths: pathType: instance delete: description: Delete a specific Service. + tags: + - IntelligenceV2Service parameters: - name: Sid in: path @@ -787,10 +993,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - Beta get: description: Fetch a specific Service. + tags: + - IntelligenceV2Service parameters: - name: Sid in: path @@ -804,14 +1010,32 @@ paths: application/json: schema: $ref: '#/components/schemas/intelligence.v2.service' + examples: + fetch: + value: + sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: something + friendly_name: some friendly name + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + auto_redaction: false + media_redaction: false + auto_transcribe: true + data_logging: true + language_code: en-US + webhook_url: https://www.twilio.com + webhook_http_method: POST + version: 1 + url: https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - Beta post: description: Update a specific Service. + tags: + - IntelligenceV2Service parameters: - name: Sid in: path @@ -830,12 +1054,28 @@ paths: application/json: schema: $ref: '#/components/schemas/intelligence.v2.service' + examples: + update: + value: + sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: something + friendly_name: some friendly name + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + auto_redaction: false + media_redaction: false + auto_transcribe: true + data_logging: true + webhook_url: https://www.sendgrid.com + webhook_http_method: GET + language_code: en-US + version: 2 + url: https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -849,9 +1089,13 @@ paths: transcribe all recordings made on the account. DataLogging: type: boolean - description: Data logging allows Twilio to improve the quality of - the speech recognition through using customer data to refine its - speech recognition models. + description: 'Data logging allows Twilio to improve the quality + of the speech recognition & language understanding services through + using customer data to refine, fine tune and evaluate machine + learning models. + + Note: Data logging cannot be activated via API, only via www.twilio.com, + as it requires additional consent.' FriendlyName: type: string description: A human readable description of this resource, up to @@ -880,10 +1124,17 @@ paths: type: string $ref: '#/components/schemas/service_enum_http_method' description: The HTTP method for the Webhook. One of `GET` or `POST`. + examples: + update: + value: + UniqueName: something + FriendlyName: some friendly name + WebhookUrl: https://www.sendgrid.com + WebhookHttpMethod: GET /v2/Transcripts: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -891,25 +1142,79 @@ paths: - media_start_time - duration - status - pathType: list dependentProperties: - sentence: '{transcript_sid: sid}' - media: '{sid: sid}' - operator_result: '{transcript_sid: sid}' + sentences: + mapping: + transcript_sid: sid + resource_url: /v2/Transcripts/{transcript_sid}/Sentences + media: + mapping: + sid: sid + resource_url: /v2/Transcripts/{sid}/Media + operator_results: + mapping: + transcript_sid: sid + resource_url: /v2/Transcripts/{transcript_sid}/OperatorResults + pathType: list post: description: Create a new Transcript for the service + tags: + - IntelligenceV2Transcript responses: '202': content: application/json: schema: $ref: '#/components/schemas/intelligence.v2.transcript' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + status: queued + channel: + media_properties: + media_url: http://foobar.test/ClusterTests/call1.wav + data_logging: false + language_code: en-US + media_start_time: null + duration: 0 + customer_key: aaaaaaaa + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + redaction: true + links: + sentences: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences + media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults + createParams: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + status: queued + channel: + media_properties: + media_url: http://foobar.test/ClusterTests/call1.wav + data_logging: false + language_code: en-US + media_start_time: null + duration: 0 + customer_key: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + redaction: true + links: + sentences: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences + media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults description: Accepted security: - accountSid_authToken: [] operationId: CreateTranscript - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -938,8 +1243,21 @@ paths: required: - ServiceSid - Channel + examples: + create: + value: + ServiceSid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Channel: '{ "media_properties" : { "media_url": "http://foobar.test/ClusterTests/call1.wav"}}' + CustomerKey: aaaaaaaa + createParams: + value: + ServiceSid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Channel: '{ "media_properties" : { "media_url": "http://foobar.test/ClusterTests/call1.wav"}}' + CustomerKey: aaaaaaaa get: description: Retrieve a list of Transcripts for a given service. + tags: + - IntelligenceV2Transcript parameters: - name: ServiceSid in: query @@ -949,6 +1267,13 @@ paths: minLength: 34 maxLength: 34 pattern: ^GA[0-9a-fA-F]{32}$ + examples: + readFull: + value: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readQuery: + value: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: BeforeStartTime in: query description: Filter by before StartTime. @@ -969,6 +1294,9 @@ paths: description: Filter by after DateCreated. schema: type: string + examples: + readFull: + value: '2019-11-22T23:46:00Z' - name: Status in: query description: Filter by status. @@ -979,11 +1307,17 @@ paths: description: Filter by Language Code. schema: type: string + examples: + readFull: + value: en-US - name: SourceSid in: query description: Filter by SourceSid. schema: type: string + examples: + readFull: + value: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1016,38 +1350,106 @@ paths: items: $ref: '#/components/schemas/intelligence.v2.transcript' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + transcripts: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + status: queued + channel: {} + data_logging: false + language_code: en-US + media_start_time: null + duration: 0 + customer_key: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + redaction: true + links: + sentences: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences + media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults + meta: + key: transcripts + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + url: https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0 + readEmpty: + value: + transcripts: [] + meta: + key: transcripts + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + url: https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readQuery: + value: + transcripts: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + status: queued + channel: {} + data_logging: false + language_code: en-US + media_start_time: null + duration: 0 + customer_key: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + redaction: true + links: + sentences: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences + media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults + meta: + key: transcripts + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + url: https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListTranscript - x-maturity: - - Beta /v2/Transcripts/{Sid}: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1055,13 +1457,24 @@ paths: - media_start_time - duration - status - pathType: instance dependentProperties: - sentence: '{transcript_sid: sid}' - media: '{sid: sid}' - operator_result: '{transcript_sid: sid}' + sentences: + mapping: + transcript_sid: sid + resource_url: /v2/Transcripts/{transcript_sid}/Sentences + media: + mapping: + sid: sid + resource_url: /v2/Transcripts/{sid}/Media + operator_results: + mapping: + transcript_sid: sid + resource_url: /v2/Transcripts/{transcript_sid}/OperatorResults + pathType: instance get: description: Fetch a specific Transcript. + tags: + - IntelligenceV2Transcript parameters: - name: Sid in: path @@ -1072,26 +1485,41 @@ paths: maxLength: 34 pattern: ^GT[0-9a-fA-F]{32}$ required: true - - name: Redacted - in: query - description: Grant access to PII Redacted/Unredacted Transcript. The default - is `true` to access redacted Transcript. - schema: - type: boolean responses: '200': content: application/json: schema: $ref: '#/components/schemas/intelligence.v2.transcript' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + status: queued + channel: {} + data_logging: false + language_code: en-US + media_start_time: null + duration: 0 + customer_key: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + redaction: true + links: + sentences: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences + media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults description: OK security: - accountSid_authToken: [] operationId: FetchTranscript - x-maturity: - - Beta delete: description: Delete a specific Transcript. + tags: + - IntelligenceV2Transcript parameters: - name: Sid in: path @@ -1108,11 +1536,13 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTranscript - x-maturity: - - Beta servers: - url: https://intelligence.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: IntelligenceV2Media +- name: IntelligenceV2OperatorResult +- name: IntelligenceV2Sentence +- name: IntelligenceV2Service +- name: IntelligenceV2Transcript +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_ip_messaging_v1.yaml b/spec/yaml/twilio_ip_messaging_v1.yaml index 9bd67582..1d0f1c37 100644 --- a/spec/yaml/twilio_ip_messaging_v1.yaml +++ b/spec/yaml/twilio_ip_messaging_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: ip_messaging.v1.service.channel: type: object @@ -520,10 +524,6 @@ components: - joined - invited - not_participating - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Ip_messaging description: This is the public Twilio REST API. @@ -535,26 +535,40 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Channels/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: instance dependentProperties: - member: '{service_sid: service_sid, channel_sid: sid}' - message: '{service_sid: service_sid, channel_sid: sid}' - invite: '{service_sid: service_sid, channel_sid: sid}' + members: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Members + messages: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Messages + invites: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Invites parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV1Channel parameters: - name: ServiceSid in: path @@ -577,14 +591,35 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: OK security: - accountSid_authToken: [] operationId: FetchChannel - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV1Channel parameters: - name: ServiceSid in: path @@ -607,10 +642,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannel - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV1Channel parameters: - name: ServiceSid in: path @@ -633,12 +668,31 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: OK security: - accountSid_authToken: [] operationId: UpdateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -655,23 +709,44 @@ paths: Attributes: type: string description: '' + examples: + update: + value: + Type: channel + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' /v1/Services/{ServiceSid}/Channels: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: list dependentProperties: - member: '{service_sid: service_sid, channel_sid: sid}' - message: '{service_sid: service_sid, channel_sid: sid}' - invite: '{service_sid: service_sid, channel_sid: sid}' + members: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Members + messages: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Messages + invites: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Invites parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV1Channel parameters: - name: ServiceSid in: path @@ -688,12 +763,31 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: Created security: - accountSid_authToken: [] operationId: CreateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -714,8 +808,17 @@ paths: type: string $ref: '#/components/schemas/channel_enum_channel_type' description: '' + examples: + create: + value: + Type: public + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' get: description: '' + tags: + - IpMessagingV1Channel parameters: - name: ServiceSid in: path @@ -766,38 +869,77 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + channels: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + readEmpty: + value: + channels: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels description: OK security: - accountSid_authToken: [] operationId: ListChannel - x-maturity: - - GA /v1/Credentials: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -806,6 +948,8 @@ paths: pathType: list get: description: '' + tags: + - IpMessagingV1Credential parameters: - name: PageSize in: query @@ -839,48 +983,88 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV1Credential responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -912,10 +1096,14 @@ paths: description: '' required: - Type + examples: + create: + value: + Type: apn /v1/Credentials/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -924,6 +1112,8 @@ paths: pathType: instance get: description: '' + tags: + - IpMessagingV1Credential parameters: - name: Sid in: path @@ -940,14 +1130,25 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV1Credential parameters: - name: Sid in: path @@ -964,12 +1165,21 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -995,8 +1205,14 @@ paths: Secret: type: string description: '' + examples: + update: + value: + FriendlyName: Test slow create delete: description: '' + tags: + - IpMessagingV1Credential parameters: - name: Sid in: path @@ -1013,21 +1229,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV1Invite parameters: - name: ServiceSid in: path @@ -1059,14 +1275,27 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchInvite - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV1Invite parameters: - name: ServiceSid in: path @@ -1098,21 +1327,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInvite - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV1Invite parameters: - name: ServiceSid in: path @@ -1135,12 +1364,23 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInvite - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1159,8 +1399,15 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: identity + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - IpMessagingV1Invite parameters: - name: ServiceSid in: path @@ -1184,6 +1431,13 @@ paths: type: array items: type: string + examples: + readEmpty: + value: + - identity + readFull: + value: + - identity - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1216,47 +1470,80 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + invites: [] + meta: + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + readFull: + value: + invites: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListInvite - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV1Member parameters: - name: ServiceSid in: path @@ -1288,14 +1575,28 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' + examples: + fetch: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMember - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV1Member parameters: - name: ServiceSid in: path @@ -1327,10 +1628,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMember - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV1Member parameters: - name: ServiceSid in: path @@ -1362,12 +1663,37 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' + examples: + updateRoleSid: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: 666 + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1385,19 +1711,28 @@ paths: type: integer nullable: true description: '' + examples: + updateRoleSid: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + LastConsumedMessageIndex: 666 /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV1Member parameters: - name: ServiceSid in: path @@ -1420,12 +1755,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' + examples: + create: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1444,8 +1791,14 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: Twilio get: description: '' + tags: + - IpMessagingV1Member parameters: - name: ServiceSid in: path @@ -1501,48 +1854,82 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: + - sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: [] description: OK security: - accountSid_authToken: [] operationId: ListMember - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - from - to - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV1Message parameters: - name: ServiceSid in: path @@ -1577,14 +1964,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMessage - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV1Message parameters: - name: ServiceSid in: path @@ -1619,10 +2022,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessage - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV1Message parameters: - name: ServiceSid in: path @@ -1657,12 +2060,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{"test": "test"}' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + body: Hello + index: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1676,20 +2093,26 @@ paths: Attributes: type: string description: '' + examples: + update: + value: + Body: Hello /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - from - to - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV1Message parameters: - name: ServiceSid in: path @@ -1715,12 +2138,41 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + body: Hello + index: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithAttributes: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1739,8 +2191,18 @@ paths: description: '' required: - Body + examples: + create: + value: + Body: Hello + createWithAttributes: + value: + Body: Hello + Attributes: '{"test": "test"}' get: description: '' + tags: + - IpMessagingV1Message parameters: - name: ServiceSid in: path @@ -1798,47 +2260,83 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: [] description: OK security: - accountSid_authToken: [] operationId: ListMessage - x-maturity: - - GA /v1/Services/{ServiceSid}/Roles/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV1Role parameters: - name: ServiceSid in: path @@ -1864,14 +2362,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRole - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV1Role parameters: - name: ServiceSid in: path @@ -1897,10 +2411,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRole - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV1Role parameters: - name: ServiceSid in: path @@ -1926,12 +2440,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1946,19 +2474,25 @@ paths: description: '' required: - Permission + examples: + update: + value: + Permission: sendMessage /v1/Services/{ServiceSid}/Roles: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV1Role parameters: - name: ServiceSid in: path @@ -1975,12 +2509,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2004,8 +2552,16 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: friendly_name + Type: channel + Permission: sendMessage get: description: '' + tags: + - IpMessagingV1Role parameters: - name: ServiceSid in: path @@ -2048,50 +2604,95 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListRole - x-maturity: - - GA /v1/Services/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance dependentProperties: - channel: '{service_sid: sid}' - role: '{service_sid: sid}' - user: '{service_sid: sid}' + channels: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Channels + roles: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Roles + users: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Users + pathType: instance get: description: '' + tags: + - IpMessagingV1Service parameters: - name: Sid in: path @@ -2108,14 +2709,44 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: {} description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV1Service parameters: - name: Sid in: path @@ -2132,10 +2763,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV1Service parameters: - name: Sid in: path @@ -2152,12 +2783,116 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 500 + user_channels: 600 + links: + channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: + added_to_channel: + enabled: false + template: notifications.added_to_channel.template + invited_to_channel: + enabled: false + template: notifications.invited_to_channel.template + new_message: + enabled: false + template: notifications.new_message.template + removed_from_channel: + enabled: false + template: notifications.removed_from_channel.template + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: + on_channel_add: + format: webhooks.on_channel_add.format + method: webhooks.on_channel_add.method + url: webhooks.on_channel_add.url + on_channel_added: + format: webhooks.on_channel_added.format + method: webhooks.on_channel_added.method + url: webhooks.on_channel_added.url + on_channel_destroy: + format: webhooks.on_channel_destroy.format + method: webhooks.on_channel_destroy.method + url: webhooks.on_channel_destroy.url + on_channel_destroyed: + format: webhooks.on_channel_destroyed.format + method: webhooks.on_channel_destroyed.method + url: webhooks.on_channel_destroyed.url + on_channel_update: + format: webhooks.on_channel_update.format + method: webhooks.on_channel_update.method + url: webhooks.on_channel_update.url + on_channel_updated: + format: webhooks.on_channel_updated.format + method: webhooks.on_channel_updated.method + url: webhooks.on_channel_updated.url + on_member_add: + format: webhooks.on_member_add.format + method: webhooks.on_member_add.method + url: webhooks.on_member_add.url + on_member_added: + format: webhooks.on_member_added.format + method: webhooks.on_member_added.method + url: webhooks.on_member_added.url + on_member_remove: + format: webhooks.on_member_remove.format + method: webhooks.on_member_remove.method + url: webhooks.on_member_remove.url + on_member_removed: + format: webhooks.on_member_removed.format + method: webhooks.on_member_removed.method + url: webhooks.on_member_removed.url + on_message_remove: + format: webhooks.on_message_remove.format + method: webhooks.on_message_remove.method + url: webhooks.on_message_remove.url + on_message_removed: + format: webhooks.on_message_removed.format + method: webhooks.on_message_removed.method + url: webhooks.on_message_removed.url + on_message_send: + format: webhooks.on_message_send.format + method: webhooks.on_message_send.method + url: webhooks.on_message_send.url + on_message_sent: + format: webhooks.on_message_sent.format + method: webhooks.on_message_sent.method + url: webhooks.on_message_sent.url + on_message_update: + format: webhooks.on_message_update.format + method: webhooks.on_message_update.method + url: webhooks.on_message_update.url + on_message_updated: + format: webhooks.on_message_updated.format + method: webhooks.on_message_updated.method + url: webhooks.on_message_updated.url description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2492,34 +3227,147 @@ paths: Limits.UserChannels: type: integer description: '' + examples: + update: + value: + ConsumptionReportInterval: 100 + DefaultChannelCreatorRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultChannelRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultServiceRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + Notifications.AddedToChannel.Enabled: false + Notifications.AddedToChannel.Template: notifications.added_to_channel.template + Notifications.InvitedToChannel.Enabled: false + Notifications.InvitedToChannel.Template: notifications.invited_to_channel.template + Notifications.NewMessage.Enabled: false + Notifications.NewMessage.Template: notifications.new_message.template + Notifications.RemovedFromChannel.Enabled: false + Notifications.RemovedFromChannel.Template: notifications.removed_from_channel.template + Limits.ChannelMembers: 600 + Limits.UserChannels: 500 + PostWebhookUrl: post_webhook_url + PreWebhookUrl: pre_webhook_url + ReachabilityEnabled: false + ReadStatusEnabled: false + TypingIndicatorTimeout: 100 + WebhookFilters: + - webhook_filters + WebhookMethod: webhook_method + Webhooks.OnChannelAdd.Format: webhooks.on_channel_add.format + Webhooks.OnChannelAdd.Method: webhooks.on_channel_add.method + Webhooks.OnChannelAdd.Url: webhooks.on_channel_add.url + Webhooks.OnChannelAdded.Format: webhooks.on_channel_added.format + Webhooks.OnChannelAdded.Method: webhooks.on_channel_added.method + Webhooks.OnChannelAdded.Url: webhooks.on_channel_added.url + Webhooks.OnChannelDestroy.Format: webhooks.on_channel_destroy.format + Webhooks.OnChannelDestroy.Method: webhooks.on_channel_destroy.method + Webhooks.OnChannelDestroy.Url: webhooks.on_channel_destroy.url + Webhooks.OnChannelDestroyed.Format: webhooks.on_channel_destroyed.format + Webhooks.OnChannelDestroyed.Method: webhooks.on_channel_destroyed.method + Webhooks.OnChannelDestroyed.Url: webhooks.on_channel_destroyed.url + Webhooks.OnChannelUpdate.Format: webhooks.on_channel_update.format + Webhooks.OnChannelUpdate.Method: webhooks.on_channel_update.method + Webhooks.OnChannelUpdate.Url: webhooks.on_channel_update.url + Webhooks.OnChannelUpdated.Format: webhooks.on_channel_updated.format + Webhooks.OnChannelUpdated.Method: webhooks.on_channel_updated.method + Webhooks.OnChannelUpdated.Url: webhooks.on_channel_updated.url + Webhooks.OnMemberAdd.Format: webhooks.on_member_add.format + Webhooks.OnMemberAdd.Method: webhooks.on_member_add.method + Webhooks.OnMemberAdd.Url: webhooks.on_member_add.url + Webhooks.OnMemberAdded.Format: webhooks.on_member_added.format + Webhooks.OnMemberAdded.Method: webhooks.on_member_added.method + Webhooks.OnMemberAdded.Url: webhooks.on_member_added.url + Webhooks.OnMemberRemove.Format: webhooks.on_member_remove.format + Webhooks.OnMemberRemove.Method: webhooks.on_member_remove.method + Webhooks.OnMemberRemove.Url: webhooks.on_member_remove.url + Webhooks.OnMemberRemoved.Format: webhooks.on_member_removed.format + Webhooks.OnMemberRemoved.Method: webhooks.on_member_removed.method + Webhooks.OnMemberRemoved.Url: webhooks.on_member_removed.url + Webhooks.OnMessageRemove.Format: webhooks.on_message_remove.format + Webhooks.OnMessageRemove.Method: webhooks.on_message_remove.method + Webhooks.OnMessageRemove.Url: webhooks.on_message_remove.url + Webhooks.OnMessageRemoved.Format: webhooks.on_message_removed.format + Webhooks.OnMessageRemoved.Method: webhooks.on_message_removed.method + Webhooks.OnMessageRemoved.Url: webhooks.on_message_removed.url + Webhooks.OnMessageSend.Format: webhooks.on_message_send.format + Webhooks.OnMessageSend.Method: webhooks.on_message_send.method + Webhooks.OnMessageSend.Url: webhooks.on_message_send.url + Webhooks.OnMessageSent.Format: webhooks.on_message_sent.format + Webhooks.OnMessageSent.Method: webhooks.on_message_sent.method + Webhooks.OnMessageSent.Url: webhooks.on_message_sent.url + Webhooks.OnMessageUpdate.Format: webhooks.on_message_update.format + Webhooks.OnMessageUpdate.Method: webhooks.on_message_update.method + Webhooks.OnMessageUpdate.Url: webhooks.on_message_update.url + Webhooks.OnMessageUpdated.Format: webhooks.on_message_updated.format + Webhooks.OnMessageUpdated.Method: webhooks.on_message_updated.method + Webhooks.OnMessageUpdated.Url: webhooks.on_message_updated.url /v1/Services: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list dependentProperties: - channel: '{service_sid: sid}' - role: '{service_sid: sid}' - user: '{service_sid: sid}' + channels: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Channels + roles: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Roles + users: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Users + pathType: list post: description: '' + tags: + - IpMessagingV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: {} description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2532,8 +3380,14 @@ paths: description: '' required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name get: description: '' + tags: + - IpMessagingV1Service parameters: - name: PageSize in: query @@ -2567,49 +3421,103 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: {} description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v1/Services/{ServiceSid}/Users/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance dependentProperties: - user_channel: '{service_sid: service_sid, user_sid: sid}' + user_channels: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v1/Services/{service_sid}/Users/{user_sid}/Channels parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV1User parameters: - name: ServiceSid in: path @@ -2632,14 +3540,32 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV1User parameters: - name: ServiceSid in: path @@ -2662,10 +3588,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUser - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV1User parameters: - name: ServiceSid in: path @@ -2688,12 +3614,28 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2713,21 +3655,33 @@ paths: FriendlyName: type: string description: '' + examples: + update: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name /v1/Services/{ServiceSid}/Users: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list dependentProperties: - user_channel: '{service_sid: service_sid, user_sid: sid}' + user_channels: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v1/Services/{service_sid}/Users/{user_sid}/Channels parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV1User parameters: - name: ServiceSid in: path @@ -2744,12 +3698,28 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2774,8 +3744,17 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: jing + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name get: description: '' + tags: + - IpMessagingV1User parameters: - name: ServiceSid in: path @@ -2818,47 +3797,85 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + joined_channels_count: 0 + links: + user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: [] description: OK security: - accountSid_authToken: [] operationId: ListUser - x-maturity: - - GA /v1/Services/{ServiceSid}/Users/{UserSid}/Channels: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - channel_sid - status - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: list get: description: '' + tags: + - IpMessagingV1UserChannel parameters: - name: ServiceSid in: path @@ -2907,36 +3924,76 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.user.user_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + links: + channel: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: [] description: OK security: - accountSid_authToken: [] operationId: ListUserChannel - x-maturity: - - GA servers: - url: https://ip-messaging.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: IpMessagingV1Channel +- name: IpMessagingV1Credential +- name: IpMessagingV1Invite +- name: IpMessagingV1Member +- name: IpMessagingV1Message +- name: IpMessagingV1Role +- name: IpMessagingV1Service +- name: IpMessagingV1User +- name: IpMessagingV1UserChannel +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_ip_messaging_v2.yaml b/spec/yaml/twilio_ip_messaging_v2.yaml index a3e37b1a..40dfd8d7 100644 --- a/spec/yaml/twilio_ip_messaging_v2.yaml +++ b/spec/yaml/twilio_ip_messaging_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: ip_messaging.v2.service.binding: type: object @@ -761,10 +765,6 @@ components: enum: - default - muted - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Ip_messaging description: This is the public Twilio REST API. @@ -776,22 +776,24 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/Bindings: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - endpoint - identity - pathType: list parent: /Services/{Sid} + pathType: list get: description: '' + tags: + - IpMessagingV2Binding parameters: - name: ServiceSid in: path @@ -849,47 +851,87 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: + - sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: [] description: OK security: - accountSid_authToken: [] operationId: ListBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Bindings/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - endpoint - identity - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV2Binding parameters: - name: ServiceSid in: path @@ -915,14 +957,34 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.binding' + examples: + fetch: + value: + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser description: OK security: - accountSid_authToken: [] operationId: FetchBinding - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV2Binding parameters: - name: ServiceSid in: path @@ -948,26 +1010,42 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: instance dependentProperties: - member: '{service_sid: service_sid, channel_sid: sid}' - message: '{service_sid: service_sid, channel_sid: sid}' - invite: '{service_sid: service_sid, channel_sid: sid}' - webhook: '{service_sid: service_sid, channel_sid: sid}' + members: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Members + messages: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Messages + invites: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Invites + webhooks: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV2Channel parameters: - name: ServiceSid in: path @@ -990,14 +1068,36 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: OK security: - accountSid_authToken: [] operationId: FetchChannel - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV2Channel parameters: - name: ServiceSid in: path @@ -1026,10 +1126,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannel - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV2Channel parameters: - name: ServiceSid in: path @@ -1058,12 +1158,32 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + created_by: username + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: OK security: - accountSid_authToken: [] operationId: UpdateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1091,24 +1211,52 @@ paths: CreatedBy: type: string description: '' + examples: + update: + value: + Type: channel + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + CreatedBy: username /v2/Services/{ServiceSid}/Channels: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: list dependentProperties: - member: '{service_sid: service_sid, channel_sid: sid}' - message: '{service_sid: service_sid, channel_sid: sid}' - invite: '{service_sid: service_sid, channel_sid: sid}' - webhook: '{service_sid: service_sid, channel_sid: sid}' + members: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Members + messages: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Messages + invites: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Invites + webhooks: + mapping: + service_sid: service_sid + channel_sid: sid + resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV2Channel parameters: - name: ServiceSid in: path @@ -1131,12 +1279,32 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + created_by: username + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: Created security: - accountSid_authToken: [] operationId: CreateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1168,8 +1336,20 @@ paths: CreatedBy: type: string description: '' + examples: + create: + value: + Type: public + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + CreatedBy: username get: description: '' + tags: + - IpMessagingV2Channel parameters: - name: ServiceSid in: path @@ -1220,46 +1400,88 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + channels: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + readEmpty: + value: + channels: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels description: OK security: - accountSid_authToken: [] operationId: ListChannel - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - configuration - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list get: description: '' + tags: + - IpMessagingV2Webhook parameters: - name: ServiceSid in: path @@ -1308,36 +1530,99 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + next_page_url: null + key: webhooks + webhooks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: webhook + configuration: + url: dummy + method: GET + filters: + - onMessageSent + - onChannelDestroyed + retry_count: 2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: trigger + configuration: + url: dummy + method: POST + filters: + - keyword1 + - keyword2 + retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + next_page_url: null + key: webhooks + webhooks: [] description: OK security: - accountSid_authToken: [] operationId: ListChannelWebhook - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV2Webhook parameters: - name: ServiceSid in: path @@ -1360,12 +1645,28 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: webhook + configuration: + url: dummy + method: GET + filters: + - onMessageSent + - onChannelDestroyed + retry_count: 2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateChannelWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1405,18 +1706,30 @@ paths: description: '' required: - Type + examples: + create: + value: + Type: webhook + Configuration.Url: dummy + Configuration.Method: GET + Configuration.Filters: + - onMessageSent + - onChannelDestroyed + Configuration.RetryCount: 2 /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - configuration - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV2Webhook parameters: - name: ServiceSid in: path @@ -1448,14 +1761,27 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchChannelWebhook - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV2Webhook parameters: - name: ServiceSid in: path @@ -1487,12 +1813,28 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: trigger + configuration: + url: dummy + method: POST + filters: + - keyword1 + - keyword2 + retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateChannelWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1526,8 +1868,19 @@ paths: Configuration.RetryCount: type: integer description: '' + examples: + update: + value: + Configuration.Url: dummy + Configuration.Method: POST + Configuration.Triggers: + - keyword1 + - keyword2 + Configuration.RetryCount: 5 delete: description: '' + tags: + - IpMessagingV2Webhook parameters: - name: ServiceSid in: path @@ -1559,12 +1912,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannelWebhook - x-maturity: - - GA /v2/Credentials: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1573,6 +1924,8 @@ paths: pathType: list get: description: '' + tags: + - IpMessagingV2Credential parameters: - name: PageSize in: query @@ -1606,48 +1959,88 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV2Credential responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1679,10 +2072,14 @@ paths: description: '' required: - Type + examples: + create: + value: + Type: apn /v2/Credentials/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1691,6 +2088,8 @@ paths: pathType: instance get: description: '' + tags: + - IpMessagingV2Credential parameters: - name: Sid in: path @@ -1707,14 +2106,25 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV2Credential parameters: - name: Sid in: path @@ -1731,12 +2141,21 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1762,8 +2181,14 @@ paths: Secret: type: string description: '' + examples: + update: + value: + FriendlyName: Test slow create delete: description: '' + tags: + - IpMessagingV2Credential parameters: - name: Sid in: path @@ -1780,21 +2205,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV2Invite parameters: - name: ServiceSid in: path @@ -1826,14 +2251,27 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.invite' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchInvite - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV2Invite parameters: - name: ServiceSid in: path @@ -1865,21 +2303,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInvite - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV2Invite parameters: - name: ServiceSid in: path @@ -1902,12 +2340,23 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.invite' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInvite - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1926,8 +2375,15 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: identity + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - IpMessagingV2Invite parameters: - name: ServiceSid in: path @@ -1951,6 +2407,13 @@ paths: type: array items: type: string + examples: + readEmpty: + value: + - identity + readFull: + value: + - identity - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1983,47 +2446,80 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.invite' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + invites: [] + meta: + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + readFull: + value: + invites: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListInvite - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV2Member parameters: - name: ServiceSid in: path @@ -2052,14 +2548,29 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' + examples: + fetch: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMember - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV2Member parameters: - name: ServiceSid in: path @@ -2094,10 +2605,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMember - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV2Member parameters: - name: ServiceSid in: path @@ -2132,12 +2643,25 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' + examples: + updateRoleSid: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: 20 + last_consumption_timestamp: '2016-03-24T21:05:52Z' + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + attributes: '{}' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2170,19 +2694,30 @@ paths: Attributes: type: string description: '' + examples: + updateRoleSid: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2016-03-24T21:05:50Z' + DateUpdated: '2016-03-24T21:05:51Z' + LastConsumedMessageIndex: 20 + LastConsumptionTimestamp: '2016-03-24T21:05:52Z' + Attributes: '{}' /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV2Member parameters: - name: ServiceSid in: path @@ -2211,12 +2746,25 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' + examples: + create: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2254,8 +2802,15 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: Twilio + Attributes: '{}' get: description: '' + tags: + - IpMessagingV2Member parameters: - name: ServiceSid in: path @@ -2311,48 +2866,83 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: + - sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: [] description: OK security: - accountSid_authToken: [] operationId: ListMember - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - from - to - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV2Message parameters: - name: ServiceSid in: path @@ -2384,14 +2974,55 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: text + media: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchMedia: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: media + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMessage - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV2Message parameters: - name: ServiceSid in: path @@ -2429,10 +3060,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessage - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV2Message parameters: - name: ServiceSid in: path @@ -2470,12 +3101,29 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "foo": "bar" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + last_updated_by: username + was_edited: true + from: fromUser + body: Hello + index: 0 + type: text + media: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2503,20 +3151,31 @@ paths: From: type: string description: '' + examples: + update: + value: + Body: Hello + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + LastUpdatedBy: username + From: fromUser /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - from - to - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV2Message parameters: - name: ServiceSid in: path @@ -2545,12 +3204,69 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: system + was_edited: false + from: system + body: Hello + index: 0 + type: text + media: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithAll: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + last_updated_by: username + was_edited: true + from: system + attributes: '{"test": "test"}' + body: Hello + index: 0 + type: text + media: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createMedia: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: system + was_edited: false + from: system + body: Hello + index: 0 + type: text + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2584,8 +3300,24 @@ paths: maxLength: 34 pattern: ^ME[0-9a-fA-F]{32}$ description: '' + examples: + create: + value: + Body: Hello + createWithAll: + value: + Body: Hello + Attributes: '{"test": "test"}' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + LastUpdatedBy: username + createMedia: + value: + MediaSid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - IpMessagingV2Message parameters: - name: ServiceSid in: path @@ -2640,47 +3372,106 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: text + media: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: media + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: [] description: OK security: - accountSid_authToken: [] operationId: ListMessage - x-maturity: - - GA /v2/Services/{ServiceSid}/Roles/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV2Role parameters: - name: ServiceSid in: path @@ -2706,14 +3497,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRole - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV2Role parameters: - name: ServiceSid in: path @@ -2739,10 +3546,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRole - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV2Role parameters: - name: ServiceSid in: path @@ -2768,12 +3575,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2788,19 +3609,25 @@ paths: description: '' required: - Permission + examples: + update: + value: + Permission: sendMessage /v2/Services/{ServiceSid}/Roles: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV2Role parameters: - name: ServiceSid in: path @@ -2817,12 +3644,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2846,8 +3687,16 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: friendly_name + Type: channel + Permission: sendMessage get: description: '' + tags: + - IpMessagingV2Role parameters: - name: ServiceSid in: path @@ -2890,51 +3739,99 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListRole - x-maturity: - - GA /v2/Services/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance dependentProperties: - channel: '{service_sid: sid}' - role: '{service_sid: sid}' - user: '{service_sid: sid}' - binding: '{service_sid: sid}' + channels: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Channels + roles: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Roles + users: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Users + bindings: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Bindings + pathType: instance get: description: '' + tags: + - IpMessagingV2Service parameters: - name: Sid in: path @@ -2951,14 +3848,49 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV2Service parameters: - name: Sid in: path @@ -2975,10 +3907,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV2Service parameters: - name: Sid in: path @@ -2995,12 +3927,59 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 500 + user_channels: 600 + links: + channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: + log_enabled: true + added_to_channel: + enabled: false + template: notifications.added_to_channel.template + invited_to_channel: + enabled: false + template: notifications.invited_to_channel.template + new_message: + enabled: false + template: notifications.new_message.template + badge_count_enabled: true + removed_from_channel: + enabled: false + template: notifications.removed_from_channel.template + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: new media compatibility message description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3122,35 +4101,113 @@ paths: Notifications.LogEnabled: type: boolean description: '' + examples: + update: + value: + ConsumptionReportInterval: 100 + DefaultChannelCreatorRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultChannelRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultServiceRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + Notifications.AddedToChannel.Enabled: false + Notifications.AddedToChannel.Template: notifications.added_to_channel.template + Notifications.InvitedToChannel.Enabled: false + Notifications.InvitedToChannel.Template: notifications.invited_to_channel.template + Notifications.NewMessage.Enabled: false + Notifications.NewMessage.Template: notifications.new_message.template + Notifications.NewMessage.BadgeCountEnabled: true + Notifications.RemovedFromChannel.Enabled: false + Notifications.RemovedFromChannel.Template: notifications.removed_from_channel.template + Notifications.LogEnabled: true + Limits.ChannelMembers: 600 + Limits.UserChannels: 500 + PostWebhookUrl: post_webhook_url + PreWebhookUrl: pre_webhook_url + PreWebhookRetryCount: 2 + PostWebhookRetryCount: 3 + ReachabilityEnabled: false + ReadStatusEnabled: false + TypingIndicatorTimeout: 100 + WebhookFilters: + - webhook_filters + WebhookMethod: webhook_method + Media.CompatibilityMessage: new media compatibility message /v2/Services: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list dependentProperties: - channel: '{service_sid: sid}' - role: '{service_sid: sid}' - user: '{service_sid: sid}' - binding: '{service_sid: sid}' + channels: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Channels + roles: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Roles + users: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Users + bindings: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Bindings + pathType: list post: description: '' + tags: + - IpMessagingV2Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3163,8 +4220,14 @@ paths: description: '' required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name get: description: '' + tags: + - IpMessagingV2Service parameters: - name: PageSize in: query @@ -3198,51 +4261,114 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - identity - date_created - pathType: instance dependentProperties: - user_channel: '{service_sid: service_sid, user_sid: sid}' - user_binding: '{service_sid: service_sid, user_sid: sid}' + user_channels: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Channels + user_bindings: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Bindings parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - IpMessagingV2User parameters: - name: ServiceSid in: path @@ -3265,14 +4391,33 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV2User parameters: - name: ServiceSid in: path @@ -3295,10 +4440,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUser - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV2User parameters: - name: ServiceSid in: path @@ -3327,12 +4472,29 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3352,23 +4514,39 @@ paths: FriendlyName: type: string description: '' + examples: + update: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name /v2/Services/{ServiceSid}/Users: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - identity - date_created - pathType: list dependentProperties: - user_channel: '{service_sid: service_sid, user_sid: sid}' - user_binding: '{service_sid: service_sid, user_sid: sid}' + user_channels: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Channels + user_bindings: + mapping: + service_sid: service_sid + user_sid: sid + resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Bindings parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - IpMessagingV2User parameters: - name: ServiceSid in: path @@ -3391,12 +4569,29 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3421,8 +4616,17 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: jing + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name get: description: '' + tags: + - IpMessagingV2User parameters: - name: ServiceSid in: path @@ -3465,49 +4669,88 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + joined_channels_count: 0 + links: + user_channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: [] description: OK security: - accountSid_authToken: [] operationId: ListUser - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - endpoint - identity - binding_type - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_bindings + pathType: list get: description: '' + tags: + - IpMessagingV2UserBinding parameters: - name: ServiceSid in: path @@ -3564,49 +4807,88 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: + - sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: [] description: OK security: - accountSid_authToken: [] operationId: ListUserBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - endpoint - identity - binding_type - pathType: instance parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_bindings + pathType: instance get: description: '' + tags: + - IpMessagingV2UserBinding parameters: - name: ServiceSid in: path @@ -3638,14 +4920,33 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_binding' + examples: + fetch: + value: + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUserBinding - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV2UserBinding parameters: - name: ServiceSid in: path @@ -3677,21 +4978,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Channels: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - channel_sid - status - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: list get: description: '' + tags: + - IpMessagingV2UserChannel parameters: - name: ServiceSid in: path @@ -3740,47 +5041,83 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: default + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: [] description: OK security: - accountSid_authToken: [] operationId: ListUserChannel - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - channel_sid - status - pathType: instance parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: instance get: description: '' + tags: + - IpMessagingV2UserChannel parameters: - name: ServiceSid in: path @@ -3809,14 +5146,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_channel' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: default + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUserChannel - x-maturity: - - GA delete: description: '' + tags: + - IpMessagingV2UserChannel parameters: - name: ServiceSid in: path @@ -3845,10 +5198,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserChannel - x-maturity: - - GA post: description: '' + tags: + - IpMessagingV2UserChannel parameters: - name: ServiceSid in: path @@ -3877,12 +5230,41 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_channel' + examples: + updateNotificationLevel: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: muted + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 10 + unread_messages_count: 5 + notification_level: muted + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUserChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3902,8 +5284,27 @@ paths: type: string format: date-time description: '' + examples: + updateNotificationLevel: + value: + NotificationLevel: muted + updateLastConsumedMessageIndex: + value: + LastConsumedMessageIndex: 10 servers: - url: https://ip-messaging.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: IpMessagingV2Binding +- name: IpMessagingV2Channel +- name: IpMessagingV2Credential +- name: IpMessagingV2Invite +- name: IpMessagingV2Member +- name: IpMessagingV2Message +- name: IpMessagingV2Role +- name: IpMessagingV2Service +- name: IpMessagingV2User +- name: IpMessagingV2UserBinding +- name: IpMessagingV2UserChannel +- name: IpMessagingV2Webhook +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_lookups_v1.yaml b/spec/yaml/twilio_lookups_v1.yaml index 53794eff..6cba4dc5 100644 --- a/spec/yaml/twilio_lookups_v1.yaml +++ b/spec/yaml/twilio_lookups_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: lookups.v1.phone_number: type: object @@ -7,11 +11,19 @@ components: nullable: true description: The name of the phone number's owner. If `null`, that information was not available. + x-twilio: + pii: + handling: standard + deleteSla: 30 country_code: type: string nullable: true description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for the phone number. + x-twilio: + pii: + handling: standard + deleteSla: 30 phone_number: type: string format: phone-number @@ -19,10 +31,18 @@ components: description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. + x-twilio: + pii: + handling: standard + deleteSla: 30 national_format: type: string nullable: true description: The phone number, in national format. + x-twilio: + pii: + handling: standard + deleteSla: 30 carrier: nullable: true description: The telecom company that provides the phone number. @@ -31,6 +51,10 @@ components: description: A JSON string with the results of the Add-ons you specified in the `add_ons` parameters. For the format of the object, see [Using Add-ons](https://www.twilio.com/docs/add-ons). + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -42,10 +66,6 @@ components: - landline - mobile - voip - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Lookups description: This is the public Twilio REST API. @@ -57,7 +77,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/PhoneNumbers/{PhoneNumber}: @@ -69,9 +89,12 @@ paths: - caller_name - country_code - carrier + - url pathType: instance get: description: '' + tags: + - LookupsV1PhoneNumber parameters: - name: PhoneNumber in: path @@ -80,7 +103,10 @@ paths: number. schema: type: string - format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: CountryCode in: query @@ -89,6 +115,23 @@ paths: phone number is provided in a national format. schema: type: string + x-twilio: + pii: + 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 - name: Type in: query description: 'The type of information to return. Can be: `carrier` or `caller-name`. @@ -101,6 +144,31 @@ paths: type: array items: type: string + examples: + fetch: + value: [] + fetchCarrier: + value: + - carrier + fetchCarrierInternational: + value: + - carrier + fetchCallerName: + value: + - caller-name + fetchCarrierAndCallerName: + value: + - carrier + - caller-name + fetchAddonsWhitepagesPro: + value: + - caller-name + fetchAddonsNomorobo: + value: + - carrier + fetchAddonsPayfone: + value: + - carrier - name: AddOns in: query description: The `unique_name` of an Add-on you would like to invoke. Can @@ -111,6 +179,20 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + fetchAddonsWhitepagesPro: + value: + - whitepages_pro_caller_id + fetchAddonsNomorobo: + value: + - nomorobo_spamscore + fetchAddonsPayfone: + value: + - payfone_tcpa_compliance - name: AddOnsData in: query description: Data specific to the add-on you would like to invoke. The content @@ -124,14 +206,203 @@ paths: application/json: schema: $ref: '#/components/schemas/lookups.v1.phone_number' + examples: + fetch: + value: + caller_name: null + carrier: null + fraud: null + add_ons: null + country_code: US + national_format: (510) 867-5310 + phone_number: '+15108675310' + url: https://lookups.twilio.com/v1/PhoneNumbers/+15108675310 + fetchCarrier: + value: + caller_name: null + carrier: + error_code: null + mobile_country_code: '310' + mobile_network_code: '456' + name: verizon + type: mobile + country_code: US + national_format: (510) 867-5310 + phone_number: '+15108675310' + fraud: null + add_ons: null + url: https://lookups.twilio.com/v1/PhoneNumbers/+15108675310 + fetchCarrierInternational: + value: + caller_name: null + carrier: + error_code: null + mobile_country_code: null + mobile_network_code: null + name: Vodafone Business Solutions + type: landline + country_code: GB + national_format: 020 7765 1182 + phone_number: '+4402077651182' + fraud: null + add_ons: null + url: https://lookups.twilio.com/v1/PhoneNumbers/+4402077651182 + fetchCallerName: + value: + caller_name: + caller_name: Delicious Cheese Cake + caller_type: CONSUMER + error_code: null + carrier: null + fraud: null + country_code: US + national_format: (510) 867-5310 + phone_number: '+15108675310' + add_ons: null + url: https://lookups.twilio.com/v1/PhoneNumbers/+15108675310 + fetchCarrierAndCallerName: + value: + caller_name: + caller_name: Delicious Cheese Cake + caller_type: CONSUMER + error_code: null + carrier: + error_code: null + mobile_country_code: '310' + mobile_network_code: '456' + name: verizon + type: mobile + fraud: null + country_code: US + national_format: (510) 867-5310 + phone_number: '+15108675310' + add_ons: + status: successful + message: null + code: null + results: {} + url: https://lookups.twilio.com/v1/PhoneNumbers/+15108675310 + fetchAddonsWhitepagesPro: + value: + caller_name: + caller_name: EMPIRE STATE BUILDING + caller_type: BUSINESS + error_code: null + country_code: US + phone_number: '+12127363100' + national_format: (212) 736-3100 + carrier: null + fraud: null + add_ons: + status: successful + message: null + code: null + results: + whitepages_pro_caller_id: + status: successful + request_sid: XR28b8f152ae12345605b0b3cc34123456 + message: null + code: null + result: + phone_number: '2127363100' + warnings: [] + historical_addresses: [] + alternate_phones: [] + error: null + is_commercial: true + associated_people: [] + country_calling_code: '1' + belongs_to: [] + is_valid: true + line_type: NonFixedVOIP + carrier: Level 3 Communications + current_addresses: + - city: New York + lat_long: + latitude: 40.748731 + longitude: -73.986413 + accuracy: RoofTop + is_active: null + location_type: Address + street_line_2: null + link_to_person_start_date: '2018-08-28' + street_line_1: 350 5th Ave + postal_code: '10118' + delivery_point: MultiUnit + country_code: US + state_code: NY + id: Location.4e81b857-1234-5678-31d29a3301e1 + zip4: '0110' + id: Phone.f8396fef-1234-5678-bc7128b6fd99 + is_prepaid: false + url: https://lookups.twilio.com/v1/PhoneNumbers/+12127363100 + fetchAddonsNomorobo: + value: + caller_name: null + country_code: US + phone_number: '+19892008374' + national_format: (989) 200-8374 + carrier: + mobile_country_code: '310' + mobile_network_code: null + name: Ytel/Blitz + type: mobile + error_code: null + fraud: null + add_ons: + status: successful + message: null + code: null + results: + nomorobo_spamscore: + status: successful + request_sid: XR763c8acc4c56d5e3e18d2f0f12345bc1 + message: null + code: null + result: + status: success + message: success + score: 1 + url: https://lookups.twilio.com/v1/PhoneNumbers/+19892008374 + fetchAddonsPayfone: + value: + caller_name: null + country_code: US + phone_number: '+16502530000' + national_format: (650) 253-0000 + carrier: + mobile_country_code: null + mobile_network_code: null + name: Level 3 Communications, LLC + type: landline + error_code: null + fraud: null + add_ons: + status: successful + message: null + code: null + results: + payfone_tcpa_compliance: + status: successful + request_sid: XRd3a2991c9108bde3ca9589ed84d31463 + message: null + code: null + result: + Status: 0 + Response: + MSISDNType: NonFixedVoIP + NumberMatch: I + VerifyNumberTransactionId: '2019459819' + RequestId: XRd3a2991c9108bde3ca9589ed84d31463 + Description: Success. + url: https://lookups.twilio.com/v1/PhoneNumbers/+16502530000 description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - GA servers: - url: https://lookups.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: LookupsV1PhoneNumber +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_lookups_v2.yaml b/spec/yaml/twilio_lookups_v2.yaml index a0281e5f..06148cbf 100644 --- a/spec/yaml/twilio_lookups_v2.yaml +++ b/spec/yaml/twilio_lookups_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: lookups.v2.phone_number: type: object @@ -12,6 +16,10 @@ components: type: string nullable: true description: The phone number's [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + x-twilio: + pii: + handling: standard + deleteSla: 30 phone_number: type: string format: phone-number @@ -19,10 +27,18 @@ components: description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. + x-twilio: + pii: + handling: standard + deleteSla: 30 national_format: type: string nullable: true description: The phone number in [national format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers). + x-twilio: + pii: + handling: standard + deleteSla: 30 valid: type: boolean nullable: true @@ -40,6 +56,10 @@ components: caller_name: nullable: true description: An object that contains caller name information based on [CNAM](https://support.twilio.com/hc/en-us/articles/360051670533-Getting-Started-with-CNAM-Caller-ID). + x-twilio: + pii: + handling: standard + deleteSla: 30 sim_swap: nullable: true description: An object that contains information on the last date the subscriber @@ -48,9 +68,9 @@ components: nullable: true description: An object that contains information on the unconditional call forwarding status of mobile phone number. - live_activity: + line_status: nullable: true - description: An object that contains live activity information for a mobile + description: An object that contains line status information for a mobile phone number. line_type_intelligence: nullable: true @@ -61,12 +81,22 @@ components: description: An object that contains identity match information. The result of comparing user-provided information including name, address, date of birth, national ID, against authoritative phone-based data sources + reassigned_number: + nullable: true + description: An object that contains reassigned number information. Reassigned + Numbers will return a phone number's reassignment status given a phone + number and date sms_pumping_risk: nullable: true description: An object that contains information on if a phone number has been currently or previously blocked by Verify Fraud Guard for receiving malicious SMS pumping traffic as well as other signals associated with risky carriers and low conversion rates. + phone_number_quality_score: + nullable: true + description: An object that contains information of a mobile phone number + quality score. Quality score will return a risk score about the phone + number. url: type: string format: uri @@ -87,10 +117,6 @@ components: - INVALID_COUNTRY_CODE - INVALID_LENGTH - NOT_A_NUMBER - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Lookups description: This is the public Twilio REST API. @@ -102,7 +128,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/PhoneNumbers/{PhoneNumber}: @@ -120,6 +146,8 @@ paths: pathType: instance get: description: '' + tags: + - LookupsV2PhoneNumber parameters: - name: PhoneNumber in: path @@ -127,50 +155,104 @@ paths: country code is +1 (North America). schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Fields in: query description: A comma-separated list of fields to return. Possible values are - caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, - identity_match. + validation, caller_name, sim_swap, call_forwarding, line_status, line_type_intelligence, + identity_match, reassigned_number, sms_pumping_risk, phone_number_quality_score. 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 - name: CountryCode in: query description: The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: FirstName in: query description: "User\u2019s first name. This query parameter is only used (optionally)\ \ for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: John - name: LastName in: query description: "User\u2019s last name. This query parameter is only used (optionally)\ \ for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: Doe - name: AddressLine1 in: query description: "User\u2019s first address line. This query parameter is only\ \ used (optionally) for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: 321 Main Street - name: AddressLine2 in: query description: "User\u2019s second address line. This query parameter is only\ \ used (optionally) for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: Suite 2 - name: City in: query description: "User\u2019s city. This query parameter is only used (optionally)\ \ for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: New York - name: State in: query description: "User\u2019s country subdivision, such as state, province, or\ @@ -178,12 +260,18 @@ paths: \ package requests." schema: type: string + examples: + fetchIdentityMatch: + value: NY - name: PostalCode in: query description: "User\u2019s postal zip code. This query parameter is only used\ \ (optionally) for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: '10021' - name: AddressCountryCode in: query description: "User\u2019s country, up to two characters. This query parameter\ @@ -191,33 +279,458 @@ paths: schema: type: string format: iso-country-code + examples: + fetchIdentityMatch: + value: US - name: NationalId in: query description: "User\u2019s national ID, such as SSN or Passport ID. This query\ \ parameter is only used (optionally) for identity_match package requests." schema: type: string + x-twilio: + pii: + handling: sensitive + deleteSla: 30 + examples: + fetchIdentityMatch: + value: YZ3456883 - name: DateOfBirth in: query description: "User\u2019s date of birth, in YYYYMMDD format. This query parameter\ \ is only used (optionally) for identity_match package requests." schema: type: string + x-twilio: + pii: + handling: sensitive + deleteSla: 30 + examples: + fetchIdentityMatch: + value: '19901214' + - name: LastVerifiedDate + in: query + description: The date you obtained consent to call or text the end-user of + the phone number or a date on which you are reasonably certain that the + end-user could still be reached at that number. This query parameter is + only used (optionally) for reassigned_number package requests. + schema: + type: string + examples: + fetchReassignedNumberWithNumberReassigned: + value: '20201227' + fetchReassignedNumberWithNumberNoReassigned: + value: '20190924' + fetchReassignedNumberWithNoDataAvailable: + value: '20211224' responses: '200': content: application/json: schema: $ref: '#/components/schemas/lookups.v2.phone_number' + examples: + fetch: + value: + calling_country_code: '1' + country_code: US + phone_number: '+14159929960' + national_format: (415) 992-9960 + valid: true + validation_errors: null + caller_name: null + sim_swap: null + call_forwarding: null + line_status: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: null + phone_number_quality_score: 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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: + mobile_country_code: '452' + mobile_network_code: '05' + carrier_risk_score: 17 + carrier_risk_category: low + line_type: mobile + name: Twilio Carrier + quality_score: 0 + quality_category: low + velocity_risk_score: 0 + velocity_risk_category: low + error_code: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+14159929960 description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - Beta servers: - url: https://lookups.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: LookupsV2PhoneNumber +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_media_v1.yaml b/spec/yaml/twilio_media_v1.yaml index 3280a8c0..319296f1 100644 --- a/spec/yaml/twilio_media_v1.yaml +++ b/spec/yaml/twilio_media_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: media.v1.media_processor: type: object @@ -34,13 +38,17 @@ components: extension: type: string nullable: true - description: 'The [Media Extension](/docs/live/api/media-extensions-overview) + description: 'The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`' + x-twilio: + pii: + handling: standard + deleteSla: 30 extension_context: type: string nullable: true description: The context of the Media Extension, represented as a JSON dictionary. - See the documentation for the specific [Media Extension](/docs/live/api/media-extensions-overview) + See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send. status: type: string @@ -66,7 +74,7 @@ components: format: uri nullable: true description: The URL to which Twilio will send asynchronous webhook requests - for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) + for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details. status_callback_method: type: string @@ -184,7 +192,7 @@ components: format: uri nullable: true description: The URL to which Twilio will send asynchronous webhook requests - for every MediaRecording event. See [Status Callbacks](/docs/live/status-callbacks) + for every MediaRecording event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details. status_callback_method: type: string @@ -279,7 +287,7 @@ components: format: uri nullable: true description: The URL to which Twilio will send asynchronous webhook requests - for every PlayerStreamer event. See [Status Callbacks](/docs/live/status-callbacks) + for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details. status_callback_method: type: string @@ -368,10 +376,25 @@ components: nullable: true description: The grant that authorizes the player sdk to connect to the livestream - securitySchemes: - accountSid_authToken: - type: http - scheme: basic + transcription_enum_status: + type: string + enum: + - completed + - deleted + - enqueued + - failed + - processing + transcription_configuration_enum_method: + type: string + enum: + - get + - post + transcription_result_enum_format: + type: string + enum: + - json + - raw + - txt info: title: Twilio - Media description: This is the public Twilio REST API. @@ -383,7 +406,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/MediaProcessors: @@ -397,22 +420,37 @@ paths: - status - extension - extension_context - pathType: list mountName: media_processor + pathType: list post: description: '' + tags: + - MediaV1MediaProcessor responses: '201': content: application/json: schema: $ref: '#/components/schemas/media.v1.media_processor' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: started + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: null + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 description: Created security: - accountSid_authToken: [] operationId: CreateMediaProcessor - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -422,25 +460,25 @@ paths: properties: Extension: type: string - description: 'The [Media Extension](/docs/live/api/media-extensions-overview) + description: 'The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`' ExtensionContext: type: string description: The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media - Extension](/docs/live/api/media-extensions-overview) you are using + Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send. ExtensionEnvironment: description: User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the - documentation for the specific [Media Extension](/docs/live/api/media-extensions-overview) + documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about whether you need to provide this. StatusCallback: type: string format: uri description: The URL to which Twilio will send asynchronous webhook - requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) + requests for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details. StatusCallbackMethod: type: string @@ -464,8 +502,19 @@ paths: required: - Extension - ExtensionContext + examples: + create: + value: + Extension: video-composer-v2 + ExtensionContext: '{}' + ExtensionEnvironment: '{}' + StatusCallback: http://www.example.com + StatusCallbackMethod: POST + MaxDuration: 300 get: description: Returns a list of MediaProcessors. + tags: + - MediaV1MediaProcessor parameters: - name: Order in: query @@ -474,6 +523,15 @@ paths: schema: type: string $ref: '#/components/schemas/media_processor_enum_order' + examples: + readEmpty: + value: asc + readItems: + value: desc + readItemsUsingPageToken: + value: desc + readItemsPageLargerThanMax: + value: desc - name: Status in: query description: Status to filter by, with possible values `started`, `ended` @@ -481,6 +539,15 @@ paths: schema: type: string $ref: '#/components/schemas/media_processor_enum_status' + examples: + readEmpty: + value: started + readItems: + value: ended + readItemsUsingPageToken: + value: ended + readItemsPageLargerThanMax: + value: ended - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -513,34 +580,113 @@ paths: items: $ref: '#/components/schemas/media.v1.media_processor' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/MediaProcessors?Status=started&Order=asc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaProcessors?Status=started&Order=asc&PageSize=10&Page=0 + next_page_url: null + key: media_processors + media_processors: [] + readItems: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0 + next_page_url: null + key: media_processors + media_processors: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: ended + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 + readItemsUsingPageToken: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0&PageToken=PTTUszYTgyOGFhNDIzZWExNzA0OTkwODNlMDlkZTg3M2NiNDoxOjI%253D + next_page_url: null + key: media_processors + media_processors: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: ended + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 + readItemsPageLargerThanMax: + value: + meta: + page: 0 + page_size: 100 + first_page_url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=100&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=100&Page=0 + next_page_url: null + key: media_processors + media_processors: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: ended + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 description: OK security: - accountSid_authToken: [] operationId: ListMediaProcessor - x-maturity: - - GA /v1/MediaProcessors/{Sid}: servers: - url: https://media.twilio.com @@ -552,10 +698,12 @@ paths: - status - extension - extension_context - pathType: instance mountName: media_processor + pathType: instance get: description: Returns a single MediaProcessor resource identified by a SID. + tags: + - MediaV1MediaProcessor parameters: - name: Sid in: path @@ -572,14 +720,29 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.media_processor' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: started + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: null + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 description: OK security: - accountSid_authToken: [] operationId: FetchMediaProcessor - x-maturity: - - GA post: description: Updates a MediaProcessor resource identified by a SID. + tags: + - MediaV1MediaProcessor parameters: - name: Sid in: path @@ -596,12 +759,25 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.media_processor' + examples: + updateEnded: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: ended + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 description: OK security: - accountSid_authToken: [] operationId: UpdateMediaProcessor - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -615,6 +791,10 @@ paths: description: The status of the MediaProcessor. Can be `ended`. required: - Status + examples: + updateEnded: + value: + Status: ended /v1/MediaRecordings/{Sid}: servers: - url: https://media.twilio.com @@ -624,13 +804,21 @@ paths: defaultOutputProperties: - sid - status - pathType: instance dependentProperties: - media/v1/media_recording_timed_metadata: '{media_recording_sid: sid}' - media/v1/media_recording_media: '{media_recording_sid: sid}' + timed_metadata: + mapping: + media_recording_sid: sid + resource_url: /v1/MediaRecordings/{media_recording_sid}/TimedMetadata + media: + mapping: + media_recording_sid: sid + resource_url: /v1/MediaRecordings/{media_recording_sid}/Media mountName: media_recording + pathType: instance delete: description: Deletes a MediaRecording resource identified by a SID. + tags: + - MediaV1MediaRecording parameters: - name: Sid in: path @@ -647,10 +835,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMediaRecording - x-maturity: - - Preview get: description: Returns a single MediaRecording resource identified by a SID. + tags: + - MediaV1MediaRecording parameters: - name: Sid in: path @@ -667,12 +855,30 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.media_recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + duration: 2147483647 + format: mp4 + links: + media: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/Media + timed_metadata: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/TimedMetadata + processor_sid: ZXcafebabecafebabecafebabecafebabe + resolution: 640x480 + source_sid: RMcafebabecafebabecafebabecafebabe + sid: KVcafebabecafebabecafebabecafebabe + media_size: 2147483648 + status: completed + status_callback: https://www.example.com + status_callback_method: POST + url: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe description: OK security: - accountSid_authToken: [] operationId: FetchMediaRecording - x-maturity: - - Preview /v1/MediaRecordings: servers: - url: https://media.twilio.com @@ -682,13 +888,21 @@ paths: defaultOutputProperties: - sid - status - pathType: list dependentProperties: - media/v1/media_recording_timed_metadata: '{media_recording_sid: sid}' - media/v1/media_recording_media: '{media_recording_sid: sid}' + timed_metadata: + mapping: + media_recording_sid: sid + resource_url: /v1/MediaRecordings/{media_recording_sid}/TimedMetadata + media: + mapping: + media_recording_sid: sid + resource_url: /v1/MediaRecordings/{media_recording_sid}/Media mountName: media_recording + pathType: list get: description: Returns a list of MediaRecordings. + tags: + - MediaV1MediaRecording parameters: - name: Order in: query @@ -697,6 +911,11 @@ paths: schema: type: string $ref: '#/components/schemas/media_recording_enum_order' + examples: + readEmpty: + value: asc + readItems: + value: desc - name: Status in: query description: Status to filter by, with possible values `processing`, `completed`, @@ -704,6 +923,11 @@ paths: schema: type: string $ref: '#/components/schemas/media_recording_enum_status' + examples: + readEmpty: + value: processing + readItems: + value: completed - name: ProcessorSid in: query description: SID of a MediaProcessor to filter by. @@ -712,6 +936,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^ZX[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readItems: + value: ZXcafebabecafebabecafebabecafebabe - name: SourceSid in: query description: SID of a MediaRecording source to filter by. @@ -720,6 +949,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readItems: + value: RMcafebabecafebabecafebabecafebabe - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -752,34 +986,72 @@ paths: items: $ref: '#/components/schemas/media.v1.media_recording' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/MediaRecordings?Status=processing&SourceSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ProcessorSid=ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Order=asc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaRecordings?Status=processing&SourceSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ProcessorSid=ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Order=asc&PageSize=10&Page=0 + next_page_url: null + key: media_recordings + media_recordings: [] + readItems: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/MediaRecordings?Status=completed&SourceSid=RMcafebabecafebabecafebabecafebabe&ProcessorSid=ZXcafebabecafebabecafebabecafebabe&Order=desc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaRecordings?Status=completed&SourceSid=RMcafebabecafebabecafebabecafebabe&ProcessorSid=ZXcafebabecafebabecafebabecafebabe&Order=desc&PageSize=10&Page=0 + next_page_url: null + key: media_recordings + media_recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + duration: 1000 + format: mp4 + links: + media: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/Media + timed_metadata: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/TimedMetadata + processor_sid: ZXcafebabecafebabecafebabecafebabe + resolution: 640x480 + source_sid: RMcafebabecafebabecafebabecafebabe + sid: KVcafebabecafebabecafebabecafebabe + media_size: 1000 + status: completed + status_callback: https://www.example.com + status_callback_method: POST + url: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe description: OK security: - accountSid_authToken: [] operationId: ListMediaRecording - x-maturity: - - Preview /v1/PlayerStreamers/{Sid}: servers: - url: https://media.twilio.com @@ -789,14 +1061,25 @@ paths: defaultOutputProperties: - sid - status - pathType: instance dependentProperties: - media/v1/player_streamer_timed_metadata: '{player_streamer_sid: sid}' - playback_grant: '{sid: sid}' - media/v1/player_streamer_recording_playback_grant: '{sid: sid}' + timed_metadata: + mapping: + player_streamer_sid: sid + resource_url: /v1/PlayerStreamers/{player_streamer_sid}/TimedMetadata + playback_grant: + mapping: + sid: sid + resource_url: /v1/PlayerStreamers/{sid}/PlaybackGrant + recording_playback_grant: + mapping: + sid: sid + resource_url: /v1/PlayerStreamers/{sid}/RecordingPlaybackGrant mountName: player_streamer + pathType: instance get: description: Returns a single PlayerStreamer resource identified by a SID. + tags: + - MediaV1PlayerStreamer parameters: - name: Sid in: path @@ -813,14 +1096,31 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.player_streamer' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: created + video: true + sid: VJcafebabecafebabecafebabecafebabe + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: null + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe + max_duration: 300 + links: + timed_metadata: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata + playback_grant: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant description: OK security: - accountSid_authToken: [] operationId: FetchPlayerStreamer - x-maturity: - - GA post: description: Updates a PlayerStreamer resource identified by a SID. + tags: + - MediaV1PlayerStreamer parameters: - name: Sid in: path @@ -837,12 +1137,27 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.player_streamer' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + status: ended + video: true + sid: VJcafebabecafebabecafebabecafebabe + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe + max_duration: 300 + links: + timed_metadata: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata + playback_grant: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant description: OK security: - accountSid_authToken: [] operationId: UpdatePlayerStreamer - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -857,6 +1172,10 @@ paths: to. Can be: `ended`.' required: - Status + examples: + update: + value: + Status: ended /v1/PlayerStreamers: servers: - url: https://media.twilio.com @@ -866,26 +1185,52 @@ paths: defaultOutputProperties: - sid - status - pathType: list dependentProperties: - media/v1/player_streamer_timed_metadata: '{player_streamer_sid: sid}' - playback_grant: '{sid: sid}' - media/v1/player_streamer_recording_playback_grant: '{sid: sid}' + timed_metadata: + mapping: + player_streamer_sid: sid + resource_url: /v1/PlayerStreamers/{player_streamer_sid}/TimedMetadata + playback_grant: + mapping: + sid: sid + resource_url: /v1/PlayerStreamers/{sid}/PlaybackGrant + recording_playback_grant: + mapping: + sid: sid + resource_url: /v1/PlayerStreamers/{sid}/RecordingPlaybackGrant mountName: player_streamer + pathType: list post: description: '' + tags: + - MediaV1PlayerStreamer responses: '201': content: application/json: schema: $ref: '#/components/schemas/media.v1.player_streamer' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: created + video: true + sid: VJcafebabecafebabecafebabecafebabe + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: null + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe + max_duration: 300 + links: + timed_metadata: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata + playback_grant: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant description: Created security: - accountSid_authToken: [] operationId: CreatePlayerStreamer - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -901,7 +1246,7 @@ paths: type: string format: uri description: The URL to which Twilio will send asynchronous webhook - requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/status-callbacks) + requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details. StatusCallbackMethod: type: string @@ -922,8 +1267,13 @@ paths: The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the PlayerStreamer, regardless of whether media is still streaming. + examples: + create: + value: {} get: description: Returns a list of PlayerStreamers. + tags: + - MediaV1PlayerStreamer parameters: - name: Order in: query @@ -932,6 +1282,13 @@ paths: schema: type: string $ref: '#/components/schemas/player_streamer_enum_order' + examples: + readEmpty: + value: asc + readItems: + value: desc + readItemsPageLargerThanMax: + value: desc - name: Status in: query description: Status to filter by, with possible values `created`, `started`, @@ -939,6 +1296,13 @@ paths: schema: type: string $ref: '#/components/schemas/player_streamer_enum_status' + examples: + readEmpty: + value: started + readItems: + value: ended + readItemsPageLargerThanMax: + value: ended - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -971,34 +1335,94 @@ paths: items: $ref: '#/components/schemas/media.v1.player_streamer' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/PlayerStreamers?Status=started&Order=asc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/PlayerStreamers?Status=started&Order=asc&PageSize=10&Page=0 + next_page_url: null + key: player_streamers + player_streamers: [] + readItems: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=10&Page=0 + next_page_url: null + key: player_streamers + player_streamers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + status: ended + video: true + sid: VJcafebabecafebabecafebabecafebabe + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe + max_duration: 300 + links: + timed_metadata: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata + playback_grant: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant + readItemsPageLargerThanMax: + value: + meta: + page: 0 + page_size: 100 + first_page_url: https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=100&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=100&Page=0 + next_page_url: null + key: player_streamers + player_streamers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + status: ended + video: true + sid: VJcafebabecafebabecafebabecafebabe + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe + max_duration: 300 + links: + timed_metadata: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata + playback_grant: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant description: OK security: - accountSid_authToken: [] operationId: ListPlayerStreamer - x-maturity: - - GA /v1/PlayerStreamers/{Sid}/PlaybackGrant: servers: - url: https://media.twilio.com @@ -1006,10 +1430,12 @@ paths: initialize the Twilio Live Player SDK and connect to a livestream. x-twilio: defaultOutputProperties: [] - pathType: instance parent: /PlayerStreamers/{Sid} + pathType: instance post: description: '' + tags: + - MediaV1PlaybackGrant parameters: - name: Sid in: path @@ -1027,12 +1453,21 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.player_streamer.player_streamer_playback_grant' + examples: + create: + value: + sid: VJcafebabecafebabecafebabecafebabe + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + grant: + playbackUrl: http://video.net/123/blabla?token=123 + playerStreamerSid: VJcafebabecafebabecafebabecafebabe + requestCredentials: null description: Created security: - accountSid_authToken: [] operationId: CreatePlayerStreamerPlaybackGrant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1048,9 +1483,16 @@ paths: type: string description: The full origin URL where the livestream can be streamed. If this is not provided, it can be streamed from any domain. + examples: + create: + value: + Ttl: 100 + AccessControlAllowOrigin: youraccess_control_allow_origin.com get: description: '**This method is not enabled.** Returns a single PlaybackGrant resource identified by a SID.' + tags: + - MediaV1PlaybackGrant parameters: - name: Sid in: path @@ -1067,18 +1509,35 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.player_streamer.player_streamer_playback_grant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant + sid: VJcafebabecafebabecafebabecafebabe + grant: + playbackUrl: http://video.net/123/blabla?token=123 + playerStreamerSid: VJcafebabecafebabecafebabecafebabe + requestCredentials: null description: OK security: - accountSid_authToken: [] operationId: FetchPlayerStreamerPlaybackGrant - x-maturity: - - GA servers: - url: https://media.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. +tags: +- name: MediaV1MediaProcessor +- name: MediaV1MediaRecording +- name: MediaV1MediaRecordingMedia +- name: MediaV1PlaybackGrant +- name: MediaV1PlayerStreamer +- name: MediaV1RecordingPlaybackGrant +- name: MediaV1RecordingTimedMetadata +- name: MediaV1Result +- name: MediaV1TimedMetadata +- name: MediaV1Transcription +- name: MediaV1TranscriptionConfigurations +- name: MediaV1TranscriptionDefaultSettings +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_messaging_bulk_v1.yaml b/spec/yaml/twilio_messaging_bulk_v1.yaml new file mode 100644 index 00000000..e407bc4c --- /dev/null +++ b/spec/yaml/twilio_messaging_bulk_v1.yaml @@ -0,0 +1,522 @@ +openapi: 3.0.3 +security: +- accountSid_authToken: [] +info: + title: Bulk Messaging and Broadcast + description: Bulk Sending is a public Twilio REST API for 1:Many Message creation + up to 100 recipients. Broadcast is a public Twilio REST API for 1:Many Message + creation up to 10,000 recipients via file upload. + termsOfService: https://www.twilio.com/legal/tos + version: 1.0.0-alpha.1 + contact: + name: Twilio Support + url: https://support.twilio.com + email: support@twilio.com + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html +servers: +- url: https://preview.messaging.twilio.com +paths: + /v1/Messages: + post: + description: Send messages to multiple recipients + operationId: CreateMessages + requestBody: + required: true + content: + application/json: + schema: + type: object + title: CreateMessagesRequest + properties: + Messages: + type: array + items: + $ref: '#/components/schemas/messaging.v1.Message' + From: + type: string + format: phone-number + description: A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) + format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), + or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) + that is enabled for the type of message you want to send. Phone + numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) + purchased from Twilio also work here. You cannot, for example, + spoof messages from a private cell phone number. If you are using + `messaging_service_sid`, this parameter must be empty. + MessagingServiceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^MG[0-9a-fA-F]{32}$ + description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) + you want to associate with the Message. Set this parameter to + use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) + you have configured and leave the `from` parameter empty. When + only this parameter is set, Twilio will use your enabled Copilot + Features to select the `from` phone number for delivery. + Body: + type: string + description: The text of the message you want to send. Can be up + to 1,600 characters in length. + ContentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + description: The SID of the preconfigured [Content Template](https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template) + you want to associate with the Message. Must be used in conjuction + with a preconfigured [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) + When this parameter is set, Twilio will use your configured content + template and the provided `ContentVariables`. This Twilio product + is currently in Private Beta. + MediaUrl: + type: array + items: + type: string + format: uri + description: The URL of the media to send with the message. The + media can be of type `gif`, `png`, and `jpeg` and will be formatted + correctly on the recipient's device. The media size limit is 5MB + for supported file types (JPEG, PNG, GIF) and 500KB for [other + types](https://www.twilio.com/docs/sms/accepted-mime-types) of + accepted media. To send more than one image in the message body, + provide multiple `media_url` parameters in the POST request. You + can include up to 10 `media_url` parameters per message. You can + send images in an SMS message in only the US and Canada. + StatusCallback: + type: string + format: uri + description: The URL we should call using the "status_callback_method" + to send status information to your application. If specified, + we POST these message status changes to the URL - queued, failed, + sent, delivered, or undelivered. Twilio will POST its [standard + request parameters](https://www.twilio.com/docs/messaging/twiml#request-parameters) + as well as some additional parameters including "MessageSid", + "MessageStatus", and "ErrorCode". If you include this parameter + with the "messaging_service_sid", we use this URL instead of the + Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api). + URLs must contain a valid hostname and underscores are not allowed. + ValidityPeriod: + type: integer + description: How long in seconds the message can remain in our outgoing + message queue. After this period elapses, the message fails and + we call your status callback. Can be between 1 and the default + value of 14,400 seconds. After a message has been accepted by + a carrier, however, we cannot guarantee that the message will + not be queued after this period. We recommend that this value + be at least 5 seconds. + SendAt: + type: string + description: The time at which Twilio will send the message. This + parameter can be used to schedule a message to be sent at a particular + time. Must be in ISO 8601 format. + ScheduleType: + type: string + description: This parameter indicates your intent to schedule a + message. Pass the value `fixed` to schedule a message at a fixed + time. This parameter works in conjuction with the `SendAt` parameter. + ShortenUrls: + type: boolean + description: Determines the usage of Click Tracking. Setting it + to `true` will instruct Twilio to replace all links in the Message + with a shortened version based on the associated Domain Sid and + track clicks on them. If this parameter is not set on an API call, + we will use the value set on the Messaging Service. If this parameter + is not set and the value is not configured on the Messaging Service + used this will default to `false`. + SendAsMms: + type: boolean + description: If set to True, Twilio will deliver the message as + a single MMS message, regardless of the presence of media. + MaxPrice: + type: number + description: The maximum total price in US dollars that you will + pay for the message to be delivered. Can be a decimal value that + has up to 4 decimal places. All messages are queued for delivery + and the message cost is checked before the message is sent. If + the cost exceeds max_price, the message will fail and a status + of Failed is sent to the status callback. If MaxPrice is not set, + the message cost is not checked. + Attempt: + type: integer + description: Total number of attempts made ( including this ) to + send out the message regardless of the provider used + SmartEncoded: + type: boolean + description: This parameter indicates whether to detect Unicode + characters that have a similar GSM-7 character and replace them. + Can be true or false. + ForceDelivery: + type: boolean + description: This parameter allows Twilio to send SMS traffic to + carriers without checking/caring whether the destination number + is a mobile or a landline. + ApplicationSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AP[0-9a-fA-F]{32}$ + description: The SID of the application that should receive message + status. We POST a message_sid parameter and a message_status parameter + with a value of sent or failed to the application's message_status_callback. + If a status_callback parameter is also passed, it will be ignored + and the application's message_status_callback parameter will be + used. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/messaging.v1.CreateMessagesResult' + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/messaging.v1.Error' + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + security: + - accountSid_authToken: [] + /v1/Broadcasts/{BroadcastSid}: + parameters: + - schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BC[0-9a-fA-F]{32}$ + name: BroadcastSid + description: Id of an existing Broadcast. + in: path + required: true + /v1/Broadcasts: + post: + description: Create a new Broadcast + operationId: CreateBroadcast + responses: + '201': + description: Broadcast Created + content: + application/json: + schema: + $ref: '#/components/schemas/messaging.v1.Broadcast' + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + '400': + description: Missing Required Information + content: + application/json: + schema: + $ref: '#/components/schemas/messaging.v1.Error' + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + '429': + description: Broadcast Upload Limit Reached + content: + application/json: + schema: + $ref: '#/components/schemas/messaging.v1.Error' + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/messaging.v1.Error' + headers: + Access-Control-Allow-Origin: + description: Specify the origin(s) allowed to access the resource + schema: + type: string + example: '*' + Access-Control-Allow-Methods: + description: Specify the HTTP methods allowed when accessing the resource + schema: + type: string + example: POST, OPTIONS + Access-Control-Allow-Headers: + description: Specify the headers allowed when accessing the resource + schema: + type: string + example: Content-Type, Authorization + Access-Control-Allow-Credentials: + description: Indicates whether the browser should include credentials + schema: + type: boolean + Access-Control-Expose-Headers: + description: Headers exposed to the client + schema: + type: string + example: X-Custom-Header1, X-Custom-Header2 + parameters: + - schema: + type: string + format: uuid + in: header + name: X-Twilio-Request-Key + description: Idempotency key provided by the client + security: + - accountSid_authToken: [] + /v1/Broadcasts/{BroadcastSid}/Cancel: + parameters: + - schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BC[0-9a-fA-F]{32}$ + name: BroadcastSid + description: Id of an existing Broadcast. + in: path + required: true +components: + schemas: + messaging.v1.Message: + type: object + properties: + To: + type: string + format: phone-number + description: The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) + format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) + for other 3rd-party channels. + Body: + type: string + description: The text of the message you want to send. Can be up to 1,600 + characters in length. Overrides the request-level body and content template + if provided. + ContentVariables: + type: object + additionalProperties: + type: string + description: Key-value pairs of variable names to substitution values. Refer + to the [Twilio Content API Resources](https://www.twilio.com/docs/content-api/content-api-resources#send-a-message-with-preconfigured-content) + for more details. + messaging.v1.MessageReceipt: + type: object + properties: + to: + type: string + nullable: true + description: The recipient phone number + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^(SM|MM)[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that identifies the resource + messaging.v1.FailedMessageReceipt: + type: object + properties: + to: + type: string + description: The recipient phone number + error_message: + type: string + description: The description of the error_code + error_code: + type: integer + description: The error code associated with the message creation attempt + messaging.v1.CreateMessagesResult: + properties: + total_message_count: + type: integer + description: The number of Messages processed in the request, equal to the + sum of success_count and error_count. + success_count: + type: integer + description: The number of Messages successfully created. + error_count: + type: integer + description: The number of Messages unsuccessfully processed in the request. + message_receipts: + type: array + items: + $ref: '#/components/schemas/messaging.v1.MessageReceipt' + failed_message_receipts: + type: array + items: + $ref: '#/components/schemas/messaging.v1.FailedMessageReceipt' + messaging.v1.Broadcast: + title: Broadcast + type: object + description: Details of a Broadcast + properties: + broadcast_sid: + type: string + description: Numeric ID indentifying individual Broadcast requests + created_date: + type: string + format: date-time + description: Timestamp of when the Broadcast was created + updated_date: + type: string + format: date-time + description: Timestamp of when the Broadcast was last updated + broadcast_status: + type: string + description: Status of the Broadcast request. Valid values are None, Pending-Upload, + Uploaded, Queued, Executing, Execution-Failure, Execution-Completed, Cancelation-Requested, + and Canceled + execution_details: + type: object + description: Details on the statuses of messages sent to recipients + properties: + total_records: + type: integer + description: Number of recipients in the Broadcast request + total_completed: + type: integer + description: Number of recipients with messages successfully sent to + them + total_errors: + type: integer + description: Number of recipients with messages unsuccessfully sent + to them, producing an error + results_file: + type: string + format: uri + description: Path to a file detailing successful requests and errors from + Broadcast execution + messaging.v1.Error: + title: Error + type: object + description: Standard Error Body + properties: + code: + type: integer + description: The Twilio error code + message: + type: string + description: The error message details + status: + type: integer + description: The HTTP status code + more_info: + type: string + description: More information on the error + securitySchemes: + accountSid_authToken: + scheme: basic + type: http diff --git a/spec/yaml/twilio_messaging_v1.yaml b/spec/yaml/twilio_messaging_v1.yaml index e4bb5b2f..5449ea8a 100644 --- a/spec/yaml/twilio_messaging_v1.yaml +++ b/spec/yaml/twilio_messaging_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: messaging.v1.service.alpha_sender: type: object @@ -140,8 +144,14 @@ components: failure_reason: type: string nullable: true - description: A reason why brand registration has failed. Only applicable - when status is FAILED. + description: DEPRECATED. A reason why brand registration has failed. Only + applicable when status is FAILED. + errors: + type: array + items: {} + nullable: true + description: A list of errors that occurred during the brand registration + process. url: type: string format: uri @@ -159,7 +169,7 @@ components: type: string $ref: '#/components/schemas/brand_registrations_enum_brand_feedback' nullable: true - description: Feedback on how to improve brand score + description: DEPRECATED. Feedback on how to improve brand score identity_status: type: string $ref: '#/components/schemas/brand_registrations_enum_identity_status' @@ -284,6 +294,64 @@ components: type: string enum: - campaign-verify + messaging.v1.service.channel_sender: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the ChannelSender resource. + messaging_service_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^MG[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Service](https://www.twilio.com/docs/messaging/services) + the resource is associated with. + 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 ChannelSender + resource. + sender: + type: string + nullable: true + description: The unique string that identifies the sender e.g whatsapp:+123456XXXX. + sender_type: + type: string + nullable: true + description: A string value that identifies the sender type e.g WhatsApp, + Messenger. + country_code: + type: string + nullable: true + description: The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) + of the number. + 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 ChannelSender resource. messaging.v1.deactivation: type: object properties: @@ -489,7 +557,7 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with. date_created: type: string @@ -691,17 +759,17 @@ components: sticky_sender: type: boolean nullable: true - description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) + description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance. mms_converter: type: boolean nullable: true - description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) + description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance. smart_encoding: type: boolean nullable: true - description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) + description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance. scan_message_content: type: string @@ -711,12 +779,12 @@ components: fallback_to_long_code: type: boolean nullable: true - description: Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) - for messages sent through the Service instance. + description: '[OBSOLETE] Former feature used to fallback to long code sender + after certain short code message failures.' area_code_geomatch: type: boolean nullable: true - description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) + description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance. synchronous_validation: type: boolean @@ -740,9 +808,9 @@ components: usecase: type: string nullable: true - description: 'A string that describes the scenario in which the Messaging - Service will be used. Examples: [notification, marketing, verification, - poll ..]' + description: A string that describes the scenario in which the Messaging + Service will be used. Possible values are `notifications`, `marketing`, + `verification`, `discussion`, `poll`, `undeclared`. us_app_to_person_registered: type: boolean nullable: true @@ -823,6 +891,227 @@ components: format: uri nullable: true description: The absolute URL of the ShortCode resource. + messaging.v1.tollfree_verification: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HH[0-9a-fA-F]{32}$ + nullable: true + description: The unique string to identify Tollfree Verification. + 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 Tollfree Verification resource. + customer_profile_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BU[0-9a-fA-F]{32}$ + nullable: true + description: Customer's Profile Bundle BundleSid. + trust_product_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BU[0-9a-fA-F]{32}$ + nullable: true + description: Tollfree TrustProduct Bundle BundleSid. + 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. + regulated_item_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Regulated Item. + business_name: + type: string + nullable: true + description: The name of the business or organization using the Tollfree + number. + business_street_address: + type: string + nullable: true + description: The address of the business or organization using the Tollfree + number. + business_street_address2: + type: string + nullable: true + description: The address of the business or organization using the Tollfree + number. + business_city: + type: string + nullable: true + description: The city of the business or organization using the Tollfree + number. + business_state_province_region: + type: string + nullable: true + description: The state/province/region of the business or organization using + the Tollfree number. + business_postal_code: + type: string + nullable: true + description: The postal code of the business or organization using the Tollfree + number. + business_country: + type: string + nullable: true + description: The country of the business or organization using the Tollfree + number. + business_website: + type: string + nullable: true + description: The website of the business or organization using the Tollfree + number. + business_contact_first_name: + type: string + nullable: true + description: The first name of the contact for the business or organization + using the Tollfree number. + business_contact_last_name: + type: string + nullable: true + description: The last name of the contact for the business or organization + using the Tollfree number. + business_contact_email: + type: string + nullable: true + description: The email address of the contact for the business or organization + using the Tollfree number. + business_contact_phone: + type: string + format: phone-number + nullable: true + description: The E.164 formatted phone number of the contact for the business + or organization using the Tollfree number. + notification_email: + type: string + nullable: true + description: The email address to receive the notification about the verification + result. . + use_case_categories: + type: array + items: + type: string + nullable: true + description: The category of the use case for the Tollfree Number. List + as many are applicable.. + use_case_summary: + type: string + nullable: true + description: Use this to further explain how messaging is used by the business + or organization. + production_message_sample: + type: string + nullable: true + description: An example of message content, i.e. a sample message. + opt_in_image_urls: + type: array + items: + type: string + nullable: true + description: Link to an image that shows the opt-in workflow. Multiple images + allowed and must be a publicly hosted URL. + opt_in_type: + type: string + $ref: '#/components/schemas/tollfree_verification_enum_opt_in_type' + nullable: true + description: Describe how a user opts-in to text messages. + message_volume: + type: string + nullable: true + description: Estimate monthly volume of messages from the Tollfree Number. + additional_information: + type: string + nullable: true + description: Additional information to be provided for verification. + tollfree_phone_number_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Phone Number associated with the Tollfree Verification. + status: + type: string + $ref: '#/components/schemas/tollfree_verification_enum_status' + nullable: true + description: The compliance status of the Tollfree Verification record. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Tollfree Verification resource. + rejection_reason: + type: string + nullable: true + description: The rejection reason given when a Tollfree Verification has + been rejected. + error_code: + type: integer + nullable: true + description: The error code given when a Tollfree Verification has been + rejected. + edit_expiration: + type: string + format: date-time + nullable: true + description: The date and time when the ability to edit a rejected verification + expires. + edit_allowed: + type: boolean + nullable: true + description: If a rejected verification is allowed to be edited/resubmitted. + Some rejection reasons allow editing and some do not. + rejection_reasons: + type: array + items: {} + nullable: true + description: A list of rejection reasons and codes describing why a Tollfree + Verification has been rejected. + resource_links: + nullable: true + description: The URLs of the documents associated with the Tollfree Verification + resource. + external_reference_id: + type: string + nullable: true + description: An optional external reference ID supplied by customer and + echoed back on status retrieval. + tollfree_verification_enum_status: + type: string + enum: + - PENDING_REVIEW + - IN_REVIEW + - TWILIO_APPROVED + - TWILIO_REJECTED + tollfree_verification_enum_opt_in_type: + type: string + enum: + - VERBAL + - WEB_FORM + - PAPER_FORM + - VIA_TEXT + - MOBILE_QR_CODE messaging.v1.service.us_app_to_person: type: object properties: @@ -855,7 +1144,7 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with. description: type: string @@ -867,8 +1156,9 @@ components: items: type: string nullable: true - description: Message samples, at least 1 and up to 5 sample messages (at - least 2 for starter/sole proprietor), >=20 chars, <=1024 chars each. + description: 'An array of sample message strings, min two and max five. + Min length for each sample: 20 chars. Max length for each sample: 1024 + chars.' us_app_to_person_usecase: type: string nullable: true @@ -886,6 +1176,20 @@ components: nullable: true description: Indicates that this SMS campaign will send messages that contain phone numbers. + subscriber_opt_in: + type: boolean + nullable: true + description: A boolean that specifies whether campaign has Subscriber Optin + or not. + age_gated: + type: boolean + nullable: true + description: A boolean that specifies whether campaign is age gated or not. + direct_lending: + type: boolean + nullable: true + description: A boolean that specifies whether campaign allows direct lending + or not. campaign_status: type: string nullable: true @@ -1017,10 +1321,33 @@ components: nullable: true description: Human readable use case details (usecase, description and purpose) of Messaging Service Use Cases. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic + whatsapp_sender_enum_status: + type: string + enum: + - Configuring + - PendingVerification + - Configured + - ConfigurationError + - VerificationError + whatsapp_template_enum_category: + type: string + enum: + - ACCOUNT_UPDATE + - ALERT_UPDATE + - AUTO_REPLY + - APPOINTMENT_UPDATE + - ISSUE_RESOLUTION + - PAYMENT_UPDATE + - PERSONAL_FINANCE_UPDATE + - RESERVATION_UPDATE + - SHIPPING_UPDATE + - TICKET_UPDATE + - TRANSPORTATION_UPDATE + - MARKETING + - OTP + - TRANSACTIONAL + - AUTHENTICATION + - UTILITY info: title: Twilio - Messaging description: This is the public Twilio REST API. @@ -1032,7 +1359,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/AlphaSenders: @@ -1044,10 +1371,12 @@ paths: defaultOutputProperties: - sid - alpha_sender - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - MessagingV1AlphaSender parameters: - name: ServiceSid in: path @@ -1065,12 +1394,22 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' + examples: + create: + value: + sid: AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + alpha_sender: Twilio + capabilities: + - SMS + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateAlphaSender - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1086,8 +1425,14 @@ paths: contain only numbers. required: - AlphaSender + examples: + create: + value: + AlphaSender: Twilio get: description: '' + tags: + - MessagingV1AlphaSender parameters: - name: ServiceSid in: path @@ -1131,34 +1476,53 @@ paths: items: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 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 description: OK security: - accountSid_authToken: [] operationId: ListAlphaSender - x-maturity: - - Beta /v1/Services/{ServiceSid}/AlphaSenders/{Sid}: servers: - url: https://messaging.twilio.com @@ -1168,10 +1532,12 @@ paths: defaultOutputProperties: - sid - alpha_sender - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - MessagingV1AlphaSender parameters: - name: ServiceSid in: path @@ -1195,14 +1561,26 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' + examples: + fetch: + value: + sid: AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + alpha_sender: Twilio + capabilities: + - SMS + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchAlphaSender - x-maturity: - - Beta delete: description: '' + tags: + - MessagingV1AlphaSender parameters: - name: ServiceSid in: path @@ -1226,8 +1604,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteAlphaSender - x-maturity: - - Beta /v1/a2p/BrandRegistrations/{BrandRegistrationSid}/SmsOtp: servers: - url: https://messaging.twilio.com @@ -1237,11 +1613,13 @@ paths: defaultOutputProperties: - account_sid - brand_registration_sid - pathType: list parent: /a2p/BrandRegistrations/{Sid} mountName: brand_registration_otps + pathType: list post: description: '' + tags: + - MessagingV1BrandRegistrationOtp parameters: - name: BrandRegistrationSid in: path @@ -1258,12 +1636,15 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_registration_otp' + examples: + create: + value: + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + brand_registration_sid: BN0044409f7e067e279523808d267e2d85 description: Created security: - accountSid_authToken: [] operationId: CreateBrandRegistrationOtp - x-maturity: - - Beta /v1/a2p/BrandRegistrations/{Sid}: servers: - url: https://messaging.twilio.com @@ -1272,12 +1653,20 @@ paths: defaultOutputProperties: - sid - date_created - pathType: instance dependentProperties: - brand_vetting: '{brand_sid: sid}' - brand_registration_otp: '{brand_registration_sid: sid}' + brand_vettings: + mapping: + brand_sid: sid + resource_url: /v1/a2p/BrandRegistrations/{brand_sid}/Vettings + brand_registration_otps: + mapping: + brand_registration_sid: sid + resource_url: /v1/a2p/BrandRegistrations/{brand_registration_sid}/SmsOtp + pathType: instance get: description: '' + tags: + - MessagingV1BrandRegistration parameters: - name: Sid in: path @@ -1294,14 +1683,142 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations' + examples: + fetch: + value: + sid: BN0044409f7e067e279523808d267e2d85 + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:36Z' + brand_type: STANDARD + status: PENDING + tcr_id: BXXXXXX + failure_reason: Registration error + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85 + brand_score: 42 + brand_feedback: + - TAX_ID + - NONPROFIT + identity_status: VERIFIED + russell_3000: true + government_entity: false + tax_exempt_status: 501c3 + skip_automatic_sec_vet: false + mock: false + 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 description: OK security: - accountSid_authToken: [] operationId: FetchBrandRegistrations - x-maturity: - - Beta post: description: '' + tags: + - MessagingV1BrandRegistration parameters: - name: Sid in: path @@ -1318,12 +1835,63 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations' + examples: + update: + value: + sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:36Z' + brand_type: STANDARD + status: PENDING + tcr_id: BXXXXXX + failure_reason: Registration error + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_score: 42 + brand_feedback: + - TAX_ID + - NONPROFIT + identity_status: VERIFIED + russell_3000: false + government_entity: false + tax_exempt_status: 501c3 + skip_automatic_sec_vet: false + 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 description: Accepted security: - accountSid_authToken: [] operationId: UpdateBrandRegistrations - x-maturity: - - Beta /v1/a2p/BrandRegistrations: servers: - url: https://messaging.twilio.com @@ -1332,12 +1900,20 @@ paths: defaultOutputProperties: - sid - date_created - pathType: list dependentProperties: - brand_vetting: '{brand_sid: sid}' - brand_registration_otp: '{brand_registration_sid: sid}' + brand_vettings: + mapping: + brand_sid: sid + resource_url: /v1/a2p/BrandRegistrations/{brand_sid}/Vettings + brand_registration_otps: + mapping: + brand_registration_sid: sid + resource_url: /v1/a2p/BrandRegistrations/{brand_registration_sid}/SmsOtp + pathType: list get: description: '' + tags: + - MessagingV1BrandRegistration parameters: - name: PageSize in: query @@ -1371,48 +1947,180 @@ paths: items: $ref: '#/components/schemas/messaging.v1.brand_registrations' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: data + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0 + data: + - sid: BN0044409f7e067e279523808d267e2d85 + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:36Z' + brand_type: STANDARD + status: APPROVED + tcr_id: BXXXXXX + failure_reason: Registration error + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85 + brand_score: 42 + brand_feedback: + - TAX_ID + - NONPROFIT + identity_status: VERIFIED + russell_3000: true + tax_exempt_status: 501c3 + government_entity: false + skip_automatic_sec_vet: false + 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 description: OK security: - accountSid_authToken: [] operationId: ListBrandRegistrations - x-maturity: - - Beta post: description: '' + tags: + - MessagingV1BrandRegistration responses: '201': content: 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 description: Created security: - accountSid_authToken: [] operationId: CreateBrandRegistrations - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1449,6 +2157,21 @@ paths: required: - CustomerProfileBundleSid - A2PProfileBundleSid + examples: + create: + value: + CustomerProfileBundleSid: BU0000009f7e067e279523808d267e2d90 + A2PProfileBundleSid: BU1111109f7e067e279523808d267e2d85 + BrandType: STANDARD + SkipAutomaticSecVet: false + Mock: false + createSoleProprietorBrand: + value: + CustomerProfileBundleSid: BU0000009f7e067e279523808d267e2d90 + A2PProfileBundleSid: BU1111109f7e067e279523808d267e2d85 + BrandType: STANDARD + SkipAutomaticSecVet: false + Mock: false /v1/a2p/BrandRegistrations/{BrandSid}/Vettings: servers: - url: https://messaging.twilio.com @@ -1462,11 +2185,13 @@ paths: - date_updated - vetting_status - vetting_class - pathType: list parent: /a2p/BrandRegistrations/{Sid} mountName: brand_vettings + pathType: list post: description: '' + tags: + - MessagingV1BrandVetting parameters: - name: BrandSid in: path @@ -1484,12 +2209,23 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_vetting' + examples: + create: + value: + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + brand_sid: BN0044409f7e067e279523808d267e2d85 + brand_vetting_sid: VT12445353 + vetting_provider: campaign-verify + vetting_id: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY + vetting_class: POLITICAL + vetting_status: IN_PROGRESS + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:35Z' + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353 description: Created security: - accountSid_authToken: [] operationId: CreateBrandVetting - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1507,8 +2243,15 @@ paths: description: The unique ID of the vetting required: - VettingProvider + examples: + create: + value: + VettingProvider: campaign-verify + VettingId: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY get: description: '' + tags: + - MessagingV1BrandVetting parameters: - name: BrandSid in: path @@ -1558,34 +2301,54 @@ paths: items: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_vetting' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: data + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0 + data: + - account_sid: AC78e8e67fc0246521490fb9907fd0c165 + brand_sid: BN0044409f7e067e279523808d267e2d85 + brand_vetting_sid: VT12445353 + vetting_provider: campaign-verify + vetting_id: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY + vetting_class: POLITICAL + vetting_status: IN_PROGRESS + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:35Z' + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353 description: OK security: - accountSid_authToken: [] operationId: ListBrandVetting - x-maturity: - - Beta /v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid}: servers: - url: https://messaging.twilio.com @@ -1599,11 +2362,13 @@ paths: - date_updated - vetting_status - vetting_class - pathType: instance parent: /a2p/BrandRegistrations/{Sid} mountName: brand_vettings + pathType: instance get: description: '' + tags: + - MessagingV1BrandVetting parameters: - name: BrandSid in: path @@ -1630,25 +2395,199 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_vetting' + examples: + fetch: + value: + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + brand_sid: BN0044409f7e067e279523808d267e2d85 + brand_vetting_sid: VT12445353 + vetting_provider: campaign-verify + vetting_id: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY + vetting_class: POLITICAL + vetting_status: IN_PROGRESS + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:35Z' + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353 description: OK security: - accountSid_authToken: [] operationId: FetchBrandVetting - x-maturity: - - Beta - /v1/Deactivations: + /v1/Services/{MessagingServiceSid}/ChannelSenders: servers: - url: https://messaging.twilio.com - description: A Deactivation resource to retrieve a list of United States phone - numbers that have been deactivated by mobile carriers on a specific date. + description: A Messaging Service resource to read, fetch all Channel Senders associated + with a Messaging Service. x-twilio: defaultOutputProperties: - - redirect_to - pathType: instance - className: deactivations + - sid + - sender + - sender_type + parent: /Services/{Sid} + pathType: list get: - description: Fetch a list of all United States numbers that have been deactivated - on a specific date. + description: '' + tags: + - MessagingV1ChannelSender + parameters: + - name: MessagingServiceSid + in: path + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + to read the resources from. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^MG[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: ListChannelSenderResponse + properties: + senders: + type: array + items: + $ref: '#/components/schemas/messaging.v1.service.channel_sender' + 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: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: ListChannelSender + /v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}: + servers: + - url: https://messaging.twilio.com + description: A Messaging Service resource to read, fetch all Channel Senders associated + with a Messaging Service. + x-twilio: + defaultOutputProperties: + - sid + - sender + - sender_type + parent: /Services/{Sid} + pathType: instance + get: + description: '' + tags: + - MessagingV1ChannelSender + parameters: + - name: MessagingServiceSid + in: path + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + to fetch the resource from. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^MG[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The SID of the ChannelSender resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchChannelSender + /v1/Deactivations: + servers: + - url: https://messaging.twilio.com + description: A Deactivation resource to retrieve a list of United States phone + numbers that have been deactivated by mobile carriers on a specific date. + x-twilio: + defaultOutputProperties: + - redirect_to + className: deactivations + pathType: instance + get: + description: Fetch a list of all United States numbers that have been deactivated + on a specific date. + tags: + - MessagingV1Deactivations parameters: - name: Date in: query @@ -1664,16 +2603,18 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.deactivation' + examples: + fetch: + value: + redirect_to: https://com-twilio-dev-messaging-deactivations.s3.amazonaws.com description: Temporary Redirect security: - accountSid_authToken: [] operationId: FetchDeactivation - x-maturity: - - GA /v1/LinkShortening/Domains/{DomainSid}/Certificate: servers: - url: https://messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - certificate_sid @@ -1683,11 +2624,13 @@ paths: - date_created - date_updated - url - pathType: instance mountName: domain_certs className: domain_certs + pathType: instance post: description: '' + tags: + - MessagingV1DomainCerts parameters: - name: DomainSid in: path @@ -1705,18 +2648,42 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_cert_v4' + examples: + update: + value: + certificate_sid: CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: https://api.example.com + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_expires: '2021-02-06T18:02:04Z' + date_created: '2021-02-06T18:02:04Z' + date_updated: '2021-02-06T18:02:04Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate + cert_in_validation: + date_expires: '2021-02-06T18:02:04Z' + status: pending description: OK '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_cert_v4' + examples: + create: + value: + certificate_sid: CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: https://api.example.com + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_expires: null + date_created: '2021-02-06T18:02:04Z' + date_updated: '2021-02-06T18:02:04Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate + cert_in_validation: + date_expires: '2021-02-06T18:02:04Z' + status: pending description: Created security: - accountSid_authToken: [] operationId: UpdateDomainCertV4 - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1732,8 +2699,123 @@ paths: your domain.' required: - TlsCert + examples: + update: + value: + TlsCert: '-----BEGIN CERTIFICATE-----MIIDcDCCAlgCCQD0iHbJmcUyYDANBgkqhkiG9w0BAQsFADB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wHhcNMjAwMjA3MTgwMjA0WhcNMjEwMjA2MTgwMjA0WjB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCo6AAEeYlR6bFAnxRvx/0BsKfZVhOlB3ua+fQc3yvdDbpQ+zxpKl4bki0HU9q2flRSc52NV6m1XGtSknHSuTlTPj3eRTJpbVpSDfI55zSKsMOgo7JvjdYZXzzPQqhruWXw2exwK1wQjVko3AIW/G2vC4nSPa7C2cxhQe6lYDhJazwFi1/TN0nqKPDuU9DL2BohjX40NzXpJ3yFEHogPTrzHyADIDtXqJzWofzz4zbkNuLAfijmHQnudvDpJoGZzzVOLk8i4eIY8aQECBC+8E2hmlJGhUSONqIYrdy0MD800ervCor0WhAdPe1293fkMER9PjYgtpP2CeSf1umUzwZjAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAHjWBgL4K7BuYF50ocWm5nMk4X0wsLx6+Z4n3cQurFOPBH0lKzUgxp8s/CDDI9Qa5/WTk2C0bvarcQdf0pjX5foNc/WtHmr1wu0w5Ykjhbw/uBDXzdMy2Dnk6hvDJYuXP+0VVw4tykXIE4mBYNG/dk5vptY5OG/YBMMR995pXLn8a0FJNdnznx0ocWpCeLVP6ddzgRYsU0BdO7v9lQRhRnxBYpL52VQ4uNcW77WcirLFpbbbQTDRQcTAE8maVGgO2Q/mG572/OzQ3VryNbuc2/fYJvZuavawIQR1/H9SA6aT5+fruz1e0UuPpIkKDS4emuqIOKIRpB4lIJj97esKhX8=-----END + CERTIFICATE----------BEGIN PRIVATE KEY----- + + MIIEpAIBAAKCAQEAu3589qzU1kyEjPJ8v3p7RGOaESNX4+hDw3Nv6nPNd1ysTVXV + + 80+v2iTANVlCLK6bpqOVq8VMs+6BAcWrZvfgBwKnad+cqLbrgjSsMLOD5e+zNO7A + + p1ItO/dpecLbTN4HItbiywAk/HKVZ11/1mh4wPvKtpIUJpBwB2h4j3oGBIjhK3MP + + k0evPohP+kWIBHT73cK/IkcpSIptDEhzKfwnYbni7N4TrF84ba+ykFJn1N5/mD8R + + ZT4jFhRKOwVNtfW+b8svlVt2n9O8viaUHO4UaAmkSsGuLd7BbfUUaMCBhVZECDnX + + G2xmOWAj7DW/NMUFNZiKfsCuBo0l4EBH9V8plQIDAQABAoIBAQChHptIZ1EnLu4h + + KSgma5yOMoFtBNA8W5YP2Z1s/kKstgijFIYc5neZoEdEEQYa25mKY7z0tUGqxeQ6 + + n6EhhRURMSiohK5dFYPgil8GIt3PtGJttFX981JH297Z8ab+sTW0rLCL/f3KqrTU + + 9LYsi+5o+HdE2NdUJH8A/rfLo/KT5Yv5qWgR0F3R6iYBpsq1TAfuYTN0HZPURXUq + + 3QkWwICdvKEvx/at92Q9a91Rkm+c+31CgmzSJBsNerSZLC3y/KOlVA3fNtq8Bzjh + + TOw4ReH1Bwze18mt+zOQ0t/2l7uIFGkhqDczqVlJUNKWDZ7s9o7CdOxwfVdUP9ft + + Btm1ZXeBAoGBAN2SracmzVLHOnQJLlPm2LAy8Y7Yl7VNL7bk9dN/+A7HXjIEUsFR + + /B6zfoYsVLmYbjhqFpMAzepj5HXdI2FRw30nB9SJguW9D4jPJrS635aD5+UM7sKY + + /77OKIv5gTRhaHP1gFPMsUQRZZ8RAfL4lXDlOGwKMYT9Hmx+s30runlFAoGBANig + + SIXbCNKM/vc+Xx9nyqfAHzEw444erVEoW7S/ZoL1z2+47Z+Cu9Il+i1bWKazvOEx + + 4xN8aGEga0uCBEGB3g7o7LlxoMqexfZiMgWiLTXB1cpOVvV7oT8ZVm8sJXH/PwBG + + SLR7igcBuOF2888rPf1+slz/HqOSATgufXYCxGwRAoGAF9Tz+puQ0At/vQVTx1B4 + + FBOWqb+gKa8Ap9Jeon4MJ0LIXebbI9H2pTK3NCVGg6PijwzSGsOmYkSWSRsc+BW8 + + ShTNoc2cl6tLJXLqfdvvupe7dIZ8k8+zCknQUKXogMLNYlOQlvLYSjL41DAXHpQg + + NsFg3TYHd39mK1NBaQAwEWUCgYBuJVmazht3S3/c4VbmlhTCJPr3PR+HROvlZzrx + + 9Zw/HJOEACi6wXOU0ACcDWVPJfb1HjOS1eAQ+rXzp8FYOZtaQ28Sf8c9H2wS8izz + + FlocilmVSy4GFf2QIucDEhRcGWfEUPho5KPzGhoScjRX82nKuiAhDwtaKkP6eBEM + + 7y1GsQKBgQDYA+/CsjoDT//pc1AaetuBT0INviCGJKiRDJwvVJgwi/CHZYUZuXbv + + syI3EUey4OL7in0N4oxCuBMEs+PVz39PRfANFTqQ/j74jazUnmCRHlReJy5A8DvZ + + 9tUKnGAnoUlrl7oz139om8ZW+DjLBRgr8ao1bC8UC8jX4SpB1IMP0Q== + + -----END PRIVATE KEY-----' + create: + value: + TlsCert: '-----BEGIN CERTIFICATE-----MIIDcDCCAlgCCQD0iHbJmcUyYDANBgkqhkiG9w0BAQsFADB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wHhcNMjAwMjA3MTgwMjA0WhcNMjEwMjA2MTgwMjA0WjB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCo6AAEeYlR6bFAnxRvx/0BsKfZVhOlB3ua+fQc3yvdDbpQ+zxpKl4bki0HU9q2flRSc52NV6m1XGtSknHSuTlTPj3eRTJpbVpSDfI55zSKsMOgo7JvjdYZXzzPQqhruWXw2exwK1wQjVko3AIW/G2vC4nSPa7C2cxhQe6lYDhJazwFi1/TN0nqKPDuU9DL2BohjX40NzXpJ3yFEHogPTrzHyADIDtXqJzWofzz4zbkNuLAfijmHQnudvDpJoGZzzVOLk8i4eIY8aQECBC+8E2hmlJGhUSONqIYrdy0MD800ervCor0WhAdPe1293fkMER9PjYgtpP2CeSf1umUzwZjAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAHjWBgL4K7BuYF50ocWm5nMk4X0wsLx6+Z4n3cQurFOPBH0lKzUgxp8s/CDDI9Qa5/WTk2C0bvarcQdf0pjX5foNc/WtHmr1wu0w5Ykjhbw/uBDXzdMy2Dnk6hvDJYuXP+0VVw4tykXIE4mBYNG/dk5vptY5OG/YBMMR995pXLn8a0FJNdnznx0ocWpCeLVP6ddzgRYsU0BdO7v9lQRhRnxBYpL52VQ4uNcW77WcirLFpbbbQTDRQcTAE8maVGgO2Q/mG572/OzQ3VryNbuc2/fYJvZuavawIQR1/H9SA6aT5+fruz1e0UuPpIkKDS4emuqIOKIRpB4lIJj97esKhX8=-----END + CERTIFICATE----------BEGIN PRIVATE KEY----- + + MIIEpAIBAAKCAQEAu3589qzU1kyEjPJ8v3p7RGOaESNX4+hDw3Nv6nPNd1ysTVXV + + 80+v2iTANVlCLK6bpqOVq8VMs+6BAcWrZvfgBwKnad+cqLbrgjSsMLOD5e+zNO7A + + p1ItO/dpecLbTN4HItbiywAk/HKVZ11/1mh4wPvKtpIUJpBwB2h4j3oGBIjhK3MP + + k0evPohP+kWIBHT73cK/IkcpSIptDEhzKfwnYbni7N4TrF84ba+ykFJn1N5/mD8R + + ZT4jFhRKOwVNtfW+b8svlVt2n9O8viaUHO4UaAmkSsGuLd7BbfUUaMCBhVZECDnX + + G2xmOWAj7DW/NMUFNZiKfsCuBo0l4EBH9V8plQIDAQABAoIBAQChHptIZ1EnLu4h + + KSgma5yOMoFtBNA8W5YP2Z1s/kKstgijFIYc5neZoEdEEQYa25mKY7z0tUGqxeQ6 + + n6EhhRURMSiohK5dFYPgil8GIt3PtGJttFX981JH297Z8ab+sTW0rLCL/f3KqrTU + + 9LYsi+5o+HdE2NdUJH8A/rfLo/KT5Yv5qWgR0F3R6iYBpsq1TAfuYTN0HZPURXUq + + 3QkWwICdvKEvx/at92Q9a91Rkm+c+31CgmzSJBsNerSZLC3y/KOlVA3fNtq8Bzjh + + TOw4ReH1Bwze18mt+zOQ0t/2l7uIFGkhqDczqVlJUNKWDZ7s9o7CdOxwfVdUP9ft + + Btm1ZXeBAoGBAN2SracmzVLHOnQJLlPm2LAy8Y7Yl7VNL7bk9dN/+A7HXjIEUsFR + + /B6zfoYsVLmYbjhqFpMAzepj5HXdI2FRw30nB9SJguW9D4jPJrS635aD5+UM7sKY + + /77OKIv5gTRhaHP1gFPMsUQRZZ8RAfL4lXDlOGwKMYT9Hmx+s30runlFAoGBANig + + SIXbCNKM/vc+Xx9nyqfAHzEw444erVEoW7S/ZoL1z2+47Z+Cu9Il+i1bWKazvOEx + + 4xN8aGEga0uCBEGB3g7o7LlxoMqexfZiMgWiLTXB1cpOVvV7oT8ZVm8sJXH/PwBG + + SLR7igcBuOF2888rPf1+slz/HqOSATgufXYCxGwRAoGAF9Tz+puQ0At/vQVTx1B4 + + FBOWqb+gKa8Ap9Jeon4MJ0LIXebbI9H2pTK3NCVGg6PijwzSGsOmYkSWSRsc+BW8 + + ShTNoc2cl6tLJXLqfdvvupe7dIZ8k8+zCknQUKXogMLNYlOQlvLYSjL41DAXHpQg + + NsFg3TYHd39mK1NBaQAwEWUCgYBuJVmazht3S3/c4VbmlhTCJPr3PR+HROvlZzrx + + 9Zw/HJOEACi6wXOU0ACcDWVPJfb1HjOS1eAQ+rXzp8FYOZtaQ28Sf8c9H2wS8izz + + FlocilmVSy4GFf2QIucDEhRcGWfEUPho5KPzGhoScjRX82nKuiAhDwtaKkP6eBEM + + 7y1GsQKBgQDYA+/CsjoDT//pc1AaetuBT0INviCGJKiRDJwvVJgwi/CHZYUZuXbv + + syI3EUey4OL7in0N4oxCuBMEs+PVz39PRfANFTqQ/j74jazUnmCRHlReJy5A8DvZ + + 9tUKnGAnoUlrl7oz139om8ZW+DjLBRgr8ao1bC8UC8jX4SpB1IMP0Q== + + -----END PRIVATE KEY-----' get: description: '' + tags: + - MessagingV1DomainCerts parameters: - name: DomainSid in: path @@ -1751,14 +2833,27 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_cert_v4' + examples: + fetch: + value: + certificate_sid: CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: https://api.example.com + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_expires: '2021-02-06T18:02:04Z' + date_created: '2021-02-06T18:02:04Z' + date_updated: '2021-02-06T18:02:04Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate + cert_in_validation: + date_expires: '2021-02-06T18:02:04Z' + status: pending description: OK security: - accountSid_authToken: [] operationId: FetchDomainCertV4 - x-maturity: - - Beta delete: description: '' + tags: + - MessagingV1DomainCerts parameters: - name: DomainSid in: path @@ -1776,12 +2871,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDomainCertV4 - x-maturity: - - Beta /v1/LinkShortening/Domains/{DomainSid}/Config: servers: - url: https://messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - config_sid @@ -1792,10 +2885,12 @@ paths: - date_updated - url - disable_https - pathType: instance mountName: domain_config + pathType: instance post: description: '' + tags: + - MessagingV1DomainConfig parameters: - name: DomainSid in: path @@ -1813,18 +2908,40 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config' + examples: + update: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fallback_url: https://www.example.com + callback_url: https://www.example.com + continue_on_failure: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config + disable_https: false description: OK '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config' + examples: + create: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fallback_url: https://www.example.com + callback_url: https://www.example.com + continue_on_failure: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config + disable_https: false description: Created security: - accountSid_authToken: [] operationId: UpdateDomainConfig - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1855,8 +2972,23 @@ paths: with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified. + examples: + update: + value: + FallbackUrl: https://www.example.com + CallbackUrl: https://www.example.com + ContinueOnFailure: true + DisableHttps: false + create: + value: + FallbackUrl: https://www.example.com + CallbackUrl: https://www.example.com + DisableHttps: false + ContinueOnFailure: true get: description: '' + tags: + - MessagingV1DomainConfig parameters: - name: DomainSid in: path @@ -1874,16 +3006,26 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config' + examples: + fetch: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fallback_url: https://www.example.com + callback_url: https://www.example.com + continue_on_failure: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config + disable_https: false description: OK security: - accountSid_authToken: [] operationId: FetchDomainConfig - x-maturity: - - Beta /v1/LinkShortening/MessagingService/{MessagingServiceSid}/DomainConfig: servers: - url: https://messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - domain_sid @@ -1895,10 +3037,12 @@ paths: - date_updated - url - messaging_service_sid - pathType: instance mountName: domain_config_messaging_service + pathType: instance get: description: '' + tags: + - MessagingV1DomainConfigMessagingService parameters: - name: MessagingServiceSid in: path @@ -1916,12 +3060,22 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config_messaging_service' + examples: + fetch: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fallback_url: https://www.example.com + callback_url: https://www.example.com + continue_on_failure: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://messaging.twilio.com/v1/LinkShortening/MessagingService/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DomainConfig + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchDomainConfigMessagingService - x-maturity: - - Beta /v1/Services/PreregisteredUsa2p: servers: - url: https://messaging.twilio.com @@ -1930,22 +3084,30 @@ paths: defaultOutputProperties: - campaign_id - messaging_service_sid - pathType: list mountName: external_campaign + pathType: list post: description: '' + tags: + - MessagingV1ExternalCampaign responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.external_campaign' + examples: + create: + value: + sid: QE2c6890da8086d771620e9b13fadeba0b + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + campaign_id: CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-03-21T21:31:00Z' description: Created security: - accountSid_authToken: [] operationId: CreateExternalCampaign - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1961,24 +3123,31 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with. required: - CampaignId - MessagingServiceSid + examples: + create: + value: + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + CampaignId: CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/LinkShortening/Domains/{DomainSid}/MessagingServices/{MessagingServiceSid}: servers: - url: https://messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - messaging_service_sid - domain_sid - url - pathType: instance mountName: linkshortening_messaging_service + pathType: instance post: description: '' + tags: + - MessagingV1LinkshorteningMessagingService parameters: - name: DomainSid in: path @@ -2008,14 +3177,20 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.linkshortening_messaging_service' + examples: + create: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingServices/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateLinkshorteningMessagingService - x-maturity: - - Beta delete: description: '' + tags: + - MessagingV1LinkshorteningMessagingService parameters: - name: DomainSid in: path @@ -2045,21 +3220,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteLinkshorteningMessagingService - x-maturity: - - Beta /v1/LinkShortening/MessagingServices/{MessagingServiceSid}/Domain: servers: - url: https://messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - domain_sid - messaging_service_sid - url - pathType: instance mountName: linkshortening_messaging_service_domain_association + pathType: instance get: description: '' + tags: + - MessagingV1LinkshorteningMessagingServiceDomainAssociation parameters: - name: MessagingServiceSid in: path @@ -2077,12 +3252,16 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.linkshortening_messaging_service_domain_association' + examples: + fetch: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://messaging.twilio.com/v1/LinkShortening/MessagingServices/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Domain description: OK security: - accountSid_authToken: [] operationId: FetchLinkshorteningMessagingServiceDomainAssociation - x-maturity: - - Beta /v1/Services/{ServiceSid}/PhoneNumbers: servers: - url: https://messaging.twilio.com @@ -2093,10 +3272,12 @@ paths: - sid - phone_number - country_code - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - MessagingV1PhoneNumber parameters: - name: ServiceSid in: path @@ -2114,12 +3295,36 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.phone_number' + examples: + create: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + phone_number: '+987654321' + country_code: US + capabilities: [] + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithCapabilities: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + phone_number: '+987654321' + country_code: US + capabilities: + - MMS + - SMS + - Voice + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreatePhoneNumber - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2135,8 +3340,17 @@ paths: description: The SID of the Phone Number being added to the Service. required: - PhoneNumberSid + examples: + create: + value: + PhoneNumberSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithCapabilities: + value: + PhoneNumberSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - MessagingV1PhoneNumber parameters: - name: ServiceSid in: path @@ -2180,34 +3394,53 @@ paths: items: $ref: '#/components/schemas/messaging.v1.service.phone_number' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 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 description: OK security: - accountSid_authToken: [] operationId: ListPhoneNumber - x-maturity: - - Beta /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}: servers: - url: https://messaging.twilio.com @@ -2218,10 +3451,12 @@ paths: - sid - phone_number - country_code - pathType: instance parent: /Services/{Sid} + pathType: instance delete: description: '' + tags: + - MessagingV1PhoneNumber parameters: - name: ServiceSid in: path @@ -2245,10 +3480,10 @@ paths: security: - accountSid_authToken: [] operationId: DeletePhoneNumber - x-maturity: - - Beta get: description: '' + tags: + - MessagingV1PhoneNumber parameters: - name: ServiceSid in: path @@ -2272,12 +3507,22 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.phone_number' + examples: + fetch: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + phone_number: '12345' + country_code: US + capabilities: [] + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - Beta /v1/Services: servers: - url: https://messaging.twilio.com @@ -2288,28 +3533,83 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: - phone_number: '{service_sid: sid}' - short_code: '{service_sid: sid}' - alpha_sender: '{service_sid: sid}' - messaging/v1/message: '{messaging_service_sid: sid}' - us_app_to_person: '{messaging_service_sid: sid}' - us_app_to_person_usecase: '{messaging_service_sid: sid}' + phone_numbers: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/PhoneNumbers + short_codes: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/ShortCodes + alpha_senders: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/AlphaSenders + messages: + mapping: + messaging_service_sid: sid + resource_url: /v1/Services/{messaging_service_sid}/Messages + us_app_to_person: + mapping: + messaging_service_sid: sid + resource_url: /v1/Services/{messaging_service_sid}/Compliance/Usa2p + us_app_to_person_usecases: + mapping: + messaging_service_sid: sid + resource_url: /v1/Services/{messaging_service_sid}/Compliance/Usa2p/Usecases + channel_senders: + mapping: + messaging_service_sid: sid + resource_url: /v1/Services/{messaging_service_sid}/ChannelSenders + pathType: list post: description: '' + tags: + - MessagingV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + friendly_name: My Service! + inbound_request_url: https://www.example.com/ + inbound_method: POST + fallback_url: https://www.example.com + fallback_method: GET + status_callback: https://www.example.com + sticky_sender: true + smart_encoding: false + mms_converter: true + fallback_to_long_code: true + scan_message_content: inherit + area_code_geomatch: true + validity_period: 600 + synchronous_validation: true + usecase: marketing + us_app_to_person_registered: false + use_inbound_webhook_on_number: true + links: + phone_numbers: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes + alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders + messages: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + us_app_to_person: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p + us_app_to_person_usecases: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases + channel_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2371,15 +3671,15 @@ paths: about message delivery. StickySender: type: boolean - description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) + description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance. MmsConverter: type: boolean - description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) + description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance. SmartEncoding: type: boolean - description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) + description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance. ScanMessageContent: type: string @@ -2387,11 +3687,11 @@ paths: description: Reserved. FallbackToLongCode: type: boolean - description: Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) - for messages sent through the Service instance. + description: '[OBSOLETE] Former feature used to fallback to long + code sender after certain short code message failures.' AreaCodeGeomatch: type: boolean - description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) + description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance. ValidityPeriod: type: integer @@ -2402,9 +3702,9 @@ paths: description: Reserved. Usecase: type: string - description: 'A string that describes the scenario in which the - Messaging Service will be used. Examples: [notification, marketing, - verification, poll ..].' + description: A string that describes the scenario in which the Messaging + Service will be used. Possible values are `notifications`, `marketing`, + `verification`, `discussion`, `poll`, `undeclared`. UseInboundWebhookOnNumber: type: boolean description: A boolean value that indicates either the webhook url @@ -2415,8 +3715,29 @@ paths: defined for the Messaging Service. required: - FriendlyName + examples: + create: + value: + FriendlyName: My Service! + StickySender: true + MmsConverter: true + SmartEncoding: false + FallbackToLongCode: true + InboundRequestUrl: https://www.example.com + InboundMethod: POST + FallbackMethod: GET + FallbackUrl: https://www.example.com + StatusCallback: https://www.example.com + ScanMessageContent: inherit + AreaCodeGeomatch: true + ValidityPeriod: 600 + SynchronousValidation: true + Usecase: marketing + UseInboundWebhookOnNumber: true get: description: '' + tags: + - MessagingV1Service parameters: - name: PageSize in: query @@ -2450,34 +3771,74 @@ paths: items: $ref: '#/components/schemas/messaging.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 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 + 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 description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - Beta /v1/Services/{Sid}: servers: - url: https://messaging.twilio.com @@ -2488,16 +3849,40 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: - phone_number: '{service_sid: sid}' - short_code: '{service_sid: sid}' - alpha_sender: '{service_sid: sid}' - messaging/v1/message: '{messaging_service_sid: sid}' - us_app_to_person: '{messaging_service_sid: sid}' - us_app_to_person_usecase: '{messaging_service_sid: sid}' + phone_numbers: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/PhoneNumbers + short_codes: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/ShortCodes + alpha_senders: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/AlphaSenders + messages: + mapping: + messaging_service_sid: sid + resource_url: /v1/Services/{messaging_service_sid}/Messages + us_app_to_person: + mapping: + messaging_service_sid: sid + resource_url: /v1/Services/{messaging_service_sid}/Compliance/Usa2p + us_app_to_person_usecases: + mapping: + messaging_service_sid: sid + resource_url: /v1/Services/{messaging_service_sid}/Compliance/Usa2p/Usecases + channel_senders: + mapping: + messaging_service_sid: sid + resource_url: /v1/Services/{messaging_service_sid}/ChannelSenders + pathType: instance post: description: '' + tags: + - MessagingV1Service parameters: - name: Sid in: path @@ -2514,12 +3899,43 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My Service! + sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + sticky_sender: false + mms_converter: true + smart_encoding: false + fallback_to_long_code: true + scan_message_content: inherit + synchronous_validation: true + area_code_geomatch: true + validity_period: 600 + inbound_request_url: https://www.example.com + inbound_method: POST + fallback_url: null + fallback_method: POST + status_callback: https://www.example.com + usecase: marketing + us_app_to_person_registered: false + use_inbound_webhook_on_number: true + links: + phone_numbers: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes + alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders + messages: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + us_app_to_person: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p + us_app_to_person_usecases: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases + channel_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2581,15 +3997,15 @@ paths: about message delivery. StickySender: type: boolean - description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) + description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance. MmsConverter: type: boolean - description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) + description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance. SmartEncoding: type: boolean - description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) + description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance. ScanMessageContent: type: string @@ -2597,11 +4013,11 @@ paths: description: Reserved. FallbackToLongCode: type: boolean - description: Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) - for messages sent through the Service instance. + description: '[OBSOLETE] Former feature used to fallback to long + code sender after certain short code message failures.' AreaCodeGeomatch: type: boolean - description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) + description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance. ValidityPeriod: type: integer @@ -2612,9 +4028,9 @@ paths: description: Reserved. Usecase: type: string - description: 'A string that describes the scenario in which the - Messaging Service will be used. Examples: [notification, marketing, - verification, poll ..]' + description: A string that describes the scenario in which the Messaging + Service will be used. Possible values are `notifications`, `marketing`, + `verification`, `discussion`, `poll`, `undeclared`. UseInboundWebhookOnNumber: type: boolean description: A boolean value that indicates either the webhook url @@ -2623,8 +4039,14 @@ paths: If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. + examples: + update: + value: + StickySender: false get: description: '' + tags: + - MessagingV1Service parameters: - name: Sid in: path @@ -2641,14 +4063,47 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + friendly_name: My Service! + inbound_request_url: https://www.example.com/ + inbound_method: POST + fallback_url: null + fallback_method: POST + status_callback: https://www.example.com + sticky_sender: true + mms_converter: true + smart_encoding: false + fallback_to_long_code: true + area_code_geomatch: true + validity_period: 600 + scan_message_content: inherit + synchronous_validation: true + usecase: marketing + us_app_to_person_registered: false + use_inbound_webhook_on_number: true + links: + phone_numbers: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes + alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders + messages: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + us_app_to_person: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p + us_app_to_person_usecases: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases + channel_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - Beta delete: description: '' + tags: + - MessagingV1Service parameters: - name: Sid in: path @@ -2665,8 +4120,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - Beta /v1/Services/{ServiceSid}/ShortCodes: servers: - url: https://messaging.twilio.com @@ -2677,10 +4130,12 @@ paths: - sid - short_code - country_code - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - MessagingV1ShortCode parameters: - name: ServiceSid in: path @@ -2698,12 +4153,23 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.short_code' + examples: + create: + value: + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + short_code: '12345' + country_code: US + capabilities: + - SMS + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateShortCode - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2720,8 +4186,14 @@ paths: Service. required: - ShortCodeSid + examples: + create: + value: + ShortCodeSid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - MessagingV1ShortCode parameters: - name: ServiceSid in: path @@ -2765,34 +4237,54 @@ paths: items: $ref: '#/components/schemas/messaging.v1.service.short_code' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 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 description: OK security: - accountSid_authToken: [] operationId: ListShortCode - x-maturity: - - Beta /v1/Services/{ServiceSid}/ShortCodes/{Sid}: servers: - url: https://messaging.twilio.com @@ -2803,10 +4295,12 @@ paths: - sid - short_code - country_code - pathType: instance parent: /Services/{Sid} + pathType: instance delete: description: '' + tags: + - MessagingV1ShortCode parameters: - name: ServiceSid in: path @@ -2830,10 +4324,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteShortCode - x-maturity: - - Beta get: description: '' + tags: + - MessagingV1ShortCode parameters: - name: ServiceSid in: path @@ -2857,12 +4351,740 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.short_code' + examples: + fetch: + value: + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + short_code: '12345' + country_code: US + capabilities: + - SMS + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchShortCode - x-maturity: - - Beta + /v1/Tollfree/Verifications/{Sid}: + servers: + - url: https://messaging.twilio.com + description: A Messaging resource to add and fetch Tollfree Verifications. + x-twilio: + defaultOutputProperties: + - sid + - date_created + mountName: tollfree_verifications + pathType: instance + get: + description: '' + tags: + - MessagingV1TollfreeVerification + parameters: + - name: Sid + in: path + description: The unique string to identify Tollfree Verification. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HH[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchTollfreeVerification + post: + description: '' + tags: + - MessagingV1TollfreeVerification + parameters: + - name: Sid + in: path + description: The unique string to identify Tollfree Verification. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HH[0-9a-fA-F]{32}$ + required: true + responses: + '202': + content: + 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 + description: Accepted + security: + - accountSid_authToken: [] + operationId: UpdateTollfreeVerification + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateTollfreeVerificationRequest + properties: + BusinessName: + type: string + description: The name of the business or organization using the + Tollfree number. + BusinessWebsite: + type: string + description: The website of the business or organization using the + Tollfree number. + NotificationEmail: + type: string + description: The email address to receive the notification about + the verification result. . + UseCaseCategories: + type: array + items: + type: string + description: The category of the use case for the Tollfree Number. + List as many are applicable.. + UseCaseSummary: + type: string + description: Use this to further explain how messaging is used by + the business or organization. + ProductionMessageSample: + type: string + description: An example of message content, i.e. a sample message. + OptInImageUrls: + type: array + items: + type: string + description: Link to an image that shows the opt-in workflow. Multiple + images allowed and must be a publicly hosted URL. + OptInType: + type: string + $ref: '#/components/schemas/tollfree_verification_enum_opt_in_type' + description: Describe how a user opts-in to text messages. + MessageVolume: + type: string + description: Estimate monthly volume of messages from the Tollfree + Number. + BusinessStreetAddress: + type: string + description: The address of the business or organization using the + Tollfree number. + BusinessStreetAddress2: + type: string + description: The address of the business or organization using the + Tollfree number. + BusinessCity: + type: string + description: The city of the business or organization using the + Tollfree number. + BusinessStateProvinceRegion: + type: string + description: The state/province/region of the business or organization + using the Tollfree number. + BusinessPostalCode: + type: string + description: The postal code of the business or organization using + the Tollfree number. + BusinessCountry: + type: string + description: The country of the business or organization using the + Tollfree number. + AdditionalInformation: + type: string + description: Additional information to be provided for verification. + BusinessContactFirstName: + type: string + description: The first name of the contact for the business or organization + using the Tollfree number. + BusinessContactLastName: + type: string + description: The last name of the contact for the business or organization + using the Tollfree number. + BusinessContactEmail: + type: string + description: The email address of the contact for the business or + organization using the Tollfree number. + BusinessContactPhone: + type: string + format: phone-number + description: The E.164 formatted phone number of the contact for + the business or organization using the Tollfree number. + EditReason: + type: string + 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 + delete: + description: '' + tags: + - MessagingV1TollfreeVerification + parameters: + - name: Sid + in: path + description: The unique string to identify Tollfree Verification. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HH[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteTollfreeVerification + /v1/Tollfree/Verifications: + servers: + - url: https://messaging.twilio.com + description: A Messaging resource to add and fetch Tollfree Verifications. + x-twilio: + defaultOutputProperties: + - sid + - date_created + mountName: tollfree_verifications + pathType: list + get: + description: '' + tags: + - MessagingV1TollfreeVerification + parameters: + - name: TollfreePhoneNumberSid + in: query + description: The SID of the Phone Number associated with the Tollfree Verification. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + read: + value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - name: Status + in: query + description: The compliance status of the Tollfree Verification record. + schema: + type: string + $ref: '#/components/schemas/tollfree_verification_enum_status' + examples: + read: + value: TWILIO_APPROVED + - 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: ListTollfreeVerificationResponse + properties: + verifications: + type: array + items: + $ref: '#/components/schemas/messaging.v1.tollfree_verification' + 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: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://messaging.twilio.com/v1/Tollfree/Verifications?Status=TWILIO_APPROVED&TollfreePhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&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&TollfreePhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&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 + description: OK + security: + - accountSid_authToken: [] + operationId: ListTollfreeVerification + post: + description: '' + tags: + - MessagingV1TollfreeVerification + responses: + '201': + content: + 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 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateTollfreeVerification + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateTollfreeVerificationRequest + properties: + BusinessName: + type: string + description: The name of the business or organization using the + Tollfree number. + BusinessWebsite: + type: string + description: The website of the business or organization using the + Tollfree number. + NotificationEmail: + type: string + description: The email address to receive the notification about + the verification result. . + UseCaseCategories: + type: array + items: + type: string + description: The category of the use case for the Tollfree Number. + List as many are applicable.. + UseCaseSummary: + type: string + description: Use this to further explain how messaging is used by + the business or organization. + ProductionMessageSample: + type: string + description: An example of message content, i.e. a sample message. + OptInImageUrls: + type: array + items: + type: string + description: Link to an image that shows the opt-in workflow. Multiple + images allowed and must be a publicly hosted URL. + OptInType: + type: string + $ref: '#/components/schemas/tollfree_verification_enum_opt_in_type' + description: Describe how a user opts-in to text messages. + MessageVolume: + type: string + description: Estimate monthly volume of messages from the Tollfree + Number. + TollfreePhoneNumberSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + description: The SID of the Phone Number associated with the Tollfree + Verification. + CustomerProfileSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BU[0-9a-fA-F]{32}$ + description: Customer's Profile Bundle BundleSid. + BusinessStreetAddress: + type: string + description: The address of the business or organization using the + Tollfree number. + BusinessStreetAddress2: + type: string + description: The address of the business or organization using the + Tollfree number. + BusinessCity: + type: string + description: The city of the business or organization using the + Tollfree number. + BusinessStateProvinceRegion: + type: string + description: The state/province/region of the business or organization + using the Tollfree number. + BusinessPostalCode: + type: string + description: The postal code of the business or organization using + the Tollfree number. + BusinessCountry: + type: string + description: The country of the business or organization using the + Tollfree number. + AdditionalInformation: + type: string + description: Additional information to be provided for verification. + BusinessContactFirstName: + type: string + description: The first name of the contact for the business or organization + using the Tollfree number. + BusinessContactLastName: + type: string + description: The last name of the contact for the business or organization + using the Tollfree number. + BusinessContactEmail: + type: string + description: The email address of the contact for the business or + organization using the Tollfree number. + BusinessContactPhone: + type: string + format: phone-number + description: The E.164 formatted phone number of the contact for + the business or organization using the Tollfree number. + ExternalReferenceId: + type: string + description: An optional external reference ID supplied by customer + and echoed back on status retrieval. + required: + - BusinessName + - BusinessWebsite + - NotificationEmail + - UseCaseCategories + - UseCaseSummary + - ProductionMessageSample + - OptInImageUrls + - OptInType + - 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 /v1/Services/{MessagingServiceSid}/Compliance/Usa2p: servers: - url: https://messaging.twilio.com @@ -2873,15 +5095,17 @@ paths: - brand_registration_sid - campaign_status - date_created - pathType: list parent: /Services/{Sid} mountName: us_app_to_person + pathType: list post: description: '' + tags: + - MessagingV1UsAppToPerson parameters: - name: MessagingServiceSid in: path - description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to create the resources from. schema: type: string @@ -2895,12 +5119,165 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' + examples: + create: + value: + sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send marketing messages about sales to opted in customers. + message_samples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + us_app_to_person_usecase: MARKETING + has_embedded_links: true + has_embedded_phone: false + 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: [] description: Created security: - accountSid_authToken: [] operationId: CreateUsAppToPerson - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2929,8 +5306,9 @@ paths: type: array items: type: string - description: Message samples, at least 1 and up to 5 sample messages - (at least 2 for sole proprietor), >=20 chars, <=1024 chars each. + description: 'An array of sample message strings, min two and max + five. Min length for each sample: 20 chars. Max length for each + sample: 1024 chars.' UsAppToPersonUsecase: type: string description: 'A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, @@ -2999,6 +5377,18 @@ paths: keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum. + SubscriberOptIn: + type: boolean + description: A boolean that specifies whether campaign has Subscriber + Optin or not. + AgeGated: + type: boolean + description: A boolean that specifies whether campaign is age gated + or not. + DirectLending: + type: boolean + description: A boolean that specifies whether campaign allows direct + lending or not. required: - BrandRegistrationSid - Description @@ -3007,12 +5397,85 @@ paths: - UsAppToPersonUsecase - HasEmbeddedLinks - HasEmbeddedPhone + examples: + create: + value: + BrandRegistrationSid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Description: Send marketing messages about sales to opted in customers. + MessageSamples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + UsAppToPersonUsecase: MARKETING + MessageFlow: End users opt-in by visiting www.example.com and adding + their phone number. They then check a box agreeing to receive + text messages from Example Brand. Additionally, end users can + also opt-in by texting START to (111) 222-3333 to opt in. + OptInMessage: 'Acme Corporation: You are now opted-in. For help, + reply HELP. To opt-out, reply STOP' + OptOutMessage: You have successfully been unsubscribed from Acme + Corporation. You will not receive any more messages from this + number. + HelpMessage: 'Acme Corporation: Please visit www.example.com to + get support. To opt-out, reply STOP.' + OptInKeywords: + - START + OptOutKeywords: + - STOP + HelpKeywords: + - HELP + HasEmbeddedLinks: true + HasEmbeddedPhone: false + 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 get: description: '' + tags: + - MessagingV1UsAppToPerson parameters: - name: MessagingServiceSid in: path - description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from. schema: type: string @@ -3052,34 +5515,155 @@ paths: items: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + compliance: + - sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send marketing messages about sales to opted in + customers. + message_samples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + us_app_to_person_usecase: MARKETING + has_embedded_links: true + has_embedded_phone: false + 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 description: OK security: - accountSid_authToken: [] operationId: ListUsAppToPerson - x-maturity: - - Beta /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}: servers: - url: https://messaging.twilio.com @@ -3090,15 +5674,17 @@ paths: - brand_registration_sid - campaign_status - date_created - pathType: instance parent: /Services/{Sid} mountName: us_app_to_person + pathType: instance delete: description: '' + tags: + - MessagingV1UsAppToPerson parameters: - name: MessagingServiceSid in: path - description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to delete the resource from. schema: type: string @@ -3121,14 +5707,14 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUsAppToPerson - x-maturity: - - Beta get: description: '' + tags: + - MessagingV1UsAppToPerson parameters: - name: MessagingServiceSid in: path - description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from. schema: type: string @@ -3151,12 +5737,306 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' + examples: + fetch: + value: + sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send marketing messages about sales to opted in customers. + message_samples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + us_app_to_person_usecase: MARKETING + has_embedded_links: true + has_embedded_phone: false + 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. description: OK security: - accountSid_authToken: [] operationId: FetchUsAppToPerson - x-maturity: - - Beta + post: + description: '' + tags: + - MessagingV1UsAppToPerson + parameters: + - name: MessagingServiceSid + in: path + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + to update the resource from. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^MG[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The SID of the US A2P Compliance resource to update `QE2c6890da8086d771620e9b13fadeba0b`. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^QE[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + 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: [] + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateUsAppToPerson + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateUsAppToPersonRequest + properties: + HasEmbeddedLinks: + type: boolean + description: Indicates that this SMS campaign will send messages + that contain links. + HasEmbeddedPhone: + type: boolean + description: Indicates that this SMS campaign will send messages + that contain phone numbers. + MessageSamples: + type: array + items: + type: string + description: 'An array of sample message strings, min two and max + five. Min length for each sample: 20 chars. Max length for each + sample: 1024 chars.' + MessageFlow: + type: string + description: Required for all Campaigns. Details around how a consumer + opts-in to their campaign, therefore giving consent to receive + their messages. If multiple opt-in methods can be used for the + same campaign, they must all be listed. 40 character minimum. + 2048 character maximum. + Description: + type: string + description: 'A short description of what this SMS campaign does. + Min length: 40 characters. Max length: 4096 characters.' + AgeGated: + type: boolean + description: A boolean that specifies whether campaign requires + age gate for federally legal content. + DirectLending: + type: boolean + description: A boolean that specifies whether campaign allows direct + lending or not. + required: + - HasEmbeddedLinks + - HasEmbeddedPhone + - MessageSamples + - MessageFlow + - Description + - 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 /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases: servers: - url: https://messaging.twilio.com @@ -3167,15 +6047,17 @@ paths: x-twilio: defaultOutputProperties: - us_app_to_person_usecases - pathType: list parent: /Services/{Sid} mountName: us_app_to_person_usecases + pathType: list get: description: '' + tags: + - MessagingV1UsAppToPersonUsecase parameters: - name: MessagingServiceSid in: path - description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from. schema: type: string @@ -3191,18 +6073,240 @@ paths: minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ + examples: + fetchWithBrandRegistrationSid: + value: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person_usecase' + examples: + fetchWithBrandRegistrationSid: + value: + us_app_to_person_usecases: + - code: 2FA + name: Two-Factor authentication (2FA) + description: Two-Factor authentication, one-time use password, + password reset + post_approval_required: false + - code: ACCOUNT_NOTIFICATION + name: Account Notification + description: 'All reminders, alerts, and notifications. (Examples + include: flight delayed, hotel booked, appointment reminders.)' + post_approval_required: false + - code: AGENTS_FRANCHISES + name: Agents and Franchises + description: For brands that have multiple agents, franchises + or offices in the same brand vertical, but require individual + localised numbers per agent/location/office. + post_approval_required: true + - code: CHARITY + name: Charity + description: 'Includes: 5013C Charity + + Does not include: Religious organizations' + post_approval_required: false + - code: PROXY + name: Proxy + description: 'Peer-to-peer app-based group messaging with proxy/pooled + numbers (For example: GroupMe) + + Supporting personalized services and non-exposure of personal + numbers for enterprise or A2P communications. (Examples include: + Uber and AirBnb.)' + post_approval_required: true + - code: CUSTOMER_CARE + name: Customer Care + description: All customer care messaging, including account + management and support + post_approval_required: false + - code: DELIVERY_NOTIFICATION + name: Delivery Notification + description: Information about the status of the delivery of + a product or service + post_approval_required: false + - code: EMERGENCY + name: Emergency + description: Notification services designed to support public + safety / health during natural disasters, armed conflicts, + pandemics and other national or regional emergencies + post_approval_required: true + - code: FRAUD_ALERT + name: Fraud Alert Messaging + description: Fraud alert notification + post_approval_required: false + - code: HIGHER_EDUCATION + name: Higher Education + description: For campaigns created on behalf of Colleges or + Universities and will also include School Districts etc that + fall outside of any "free to the consumer" messaging model + post_approval_required: false + - code: K12_EDUCATION + name: K-12 Education + description: Campaigns created for messaging platforms that + support schools from grades K-12 and distance learning centers. + This is not for Post-Secondary schools. + post_approval_required: true + - code: LOW_VOLUME + name: Low Volume Mixed + description: 'Low throughput, any combination of use-cases. + Examples include: test, demo accounts' + post_approval_required: false + - code: MARKETING + name: Marketing + description: Any communication with marketing and/or promotional + content + post_approval_required: false + - code: MIXED + name: Mixed + description: Mixed messaging reserved for specific consumer + service industry + post_approval_required: false + - code: POLITICAL + name: Political + description: Part of organized effort to influence decision + making of specific group. All campaigns to be verified + post_approval_required: false + - code: POLLING_VOTING + name: Polling and voting + description: Polling and voting + post_approval_required: false + - code: PUBLIC_SERVICE_ANNOUNCEMENT + name: Public Service Announcement + description: An informational message that is meant to raise + the audience awareness about an important issue + post_approval_required: false + - code: SECURITY_ALERT + name: Security Alert + description: A notification that the security of a system, either + software or hardware, has been compromised in some way and + there is an action you need to take + post_approval_required: false + - code: SOCIAL + name: Social + description: 'Communication within or between closed communities + (For example: influencers alerts)' + post_approval_required: true + - code: SWEEPSTAKE + name: Sweepstake + description: Sweepstake + post_approval_required: true + fetchWithoutBrandRegistrationSid: + value: + us_app_to_person_usecases: + - code: 2FA + name: Two-Factor authentication (2FA) + description: Two-Factor authentication, one-time use password, + password reset + post_approval_required: false + - code: ACCOUNT_NOTIFICATION + name: Account Notification + description: 'All reminders, alerts, and notifications. (Examples + include: flight delayed, hotel booked, appointment reminders.)' + post_approval_required: false + - code: AGENTS_FRANCHISES + name: Agents and Franchises + description: For brands that have multiple agents, franchises + or offices in the same brand vertical, but require individual + localised numbers per agent/location/office. + post_approval_required: true + - code: CHARITY + name: Charity + description: 'Includes: 5013C Charity + + Does not include: Religious organizations' + post_approval_required: false + - code: PROXY + name: Proxy + description: 'Peer-to-peer app-based group messaging with proxy/pooled + numbers (For example: GroupMe) + + Supporting personalized services and non-exposure of personal + numbers for enterprise or A2P communications. (Examples include: + Uber and AirBnb.)' + post_approval_required: true + - code: CUSTOMER_CARE + name: Customer Care + description: All customer care messaging, including account + management and support + post_approval_required: false + - code: DELIVERY_NOTIFICATION + name: Delivery Notification + description: Information about the status of the delivery of + a product or service + post_approval_required: false + - code: EMERGENCY + name: Emergency + description: Notification services designed to support public + safety / health during natural disasters, armed conflicts, + pandemics and other national or regional emergencies + post_approval_required: true + - code: FRAUD_ALERT + name: Fraud Alert Messaging + description: Fraud alert notification + post_approval_required: false + - code: HIGHER_EDUCATION + name: Higher Education + description: For campaigns created on behalf of Colleges or + Universities and will also include School Districts etc that + fall outside of any "free to the consumer" messaging model + post_approval_required: false + - code: K12_EDUCATION + name: K-12 Education + description: Campaigns created for messaging platforms that + support schools from grades K-12 and distance learning centers. + This is not for Post-Secondary schools. + post_approval_required: true + - code: LOW_VOLUME + name: Low Volume Mixed + description: 'Low throughput, any combination of use-cases. + Examples include: test, demo accounts' + post_approval_required: false + - code: MARKETING + name: Marketing + description: Any communication with marketing and/or promotional + content + post_approval_required: false + - code: MIXED + name: Mixed + description: Mixed messaging reserved for specific consumer + service industry + post_approval_required: false + - code: POLITICAL + name: Political + description: Part of organized effort to influence decision + making of specific group. All campaigns to be verified + post_approval_required: false + - code: POLLING_VOTING + name: Polling and voting + description: Polling and voting + post_approval_required: false + - code: PUBLIC_SERVICE_ANNOUNCEMENT + name: Public Service Announcement + description: An informational message that is meant to raise + the audience awareness about an important issue + post_approval_required: false + - code: SECURITY_ALERT + name: Security Alert + description: A notification that the security of a system, either + software or hardware, has been compromised in some way and + there is an action you need to take + post_approval_required: false + - code: SOCIAL + name: Social + description: 'Communication within or between closed communities + (For example: influencers alerts)' + post_approval_required: true + - code: SWEEPSTAKE + name: Sweepstake + description: Sweepstake + post_approval_required: true description: OK security: - accountSid_authToken: [] operationId: FetchUsAppToPersonUsecase - x-maturity: - - Beta /v1/Services/Usecases: servers: - url: https://messaging.twilio.com @@ -3213,23 +6317,55 @@ paths: pathType: list get: description: '' + tags: + - MessagingV1Usecase responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.usecase' + examples: + fetch: + value: + usecases: + - usecase: notifications + description: Transactional notifications and Alerts for any + Delivery, Account, Reminder, Order, Fraud, Security, Public + Service, or Emergency announcements. + purpose: Notify my users. + - usecase: marketing + description: Marketing messages may contain product information, + offers, and calls to action to engage with your organization. + purpose: Market my services. description: OK security: - accountSid_authToken: [] operationId: FetchUsecase - x-maturity: - - Beta servers: - url: https://messaging.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: MessagingV1AlphaSender +- name: MessagingV1BrandRegistration +- name: MessagingV1BrandRegistrationOtp +- name: MessagingV1BrandVetting +- name: MessagingV1ChannelSender +- name: MessagingV1Deactivations +- name: MessagingV1DomainCerts +- name: MessagingV1DomainConfig +- name: MessagingV1DomainConfigMessagingService +- name: MessagingV1ExternalCampaign +- name: MessagingV1LinkshorteningMessagingService +- name: MessagingV1LinkshorteningMessagingServiceDomainAssociation +- name: MessagingV1Message +- name: MessagingV1PhoneNumber +- name: MessagingV1Service +- name: MessagingV1ShortCode +- name: MessagingV1TollfreeVerification +- name: MessagingV1UsAppToPerson +- name: MessagingV1UsAppToPersonUsecase +- name: MessagingV1Usecase +- name: MessagingV1WhatsappSender +- name: MessagingV1WhatsappTemplate +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_microvisor_v1.yaml b/spec/yaml/twilio_microvisor_v1.yaml index d1db7d4d..215919a9 100644 --- a/spec/yaml/twilio_microvisor_v1.yaml +++ b/spec/yaml/twilio_microvisor_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: microvisor.v1.account_config: type: object @@ -214,10 +218,6 @@ components: format: uri nullable: true description: The absolute URL of the Secret. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Microvisor description: This is the public Twilio REST API. @@ -229,19 +229,21 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Configs: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list mountName: account_configs + pathType: list get: description: Retrieve a list of all Configs for an Account. + tags: + - MicrovisorV1AccountConfig parameters: - name: PageSize in: query @@ -275,48 +277,84 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.account_config' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + configs: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0 + next_page_url: null + key: configs + readFull: + value: + configs: + - key: first + value: something + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Configs/first + - key: second + value: or other + date_updated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Configs/second + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0 + next_page_url: null + key: configs description: OK security: - accountSid_authToken: [] operationId: ListAccountConfig - x-maturity: - - Preview post: description: Create a config for an Account. + tags: + - MicrovisorV1AccountConfig responses: '201': content: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_config' + examples: + createAccountConfig: + value: + key: first + value: place + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Configs/first description: Created security: - accountSid_authToken: [] operationId: CreateAccountConfig - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -333,16 +371,23 @@ paths: required: - Key - Value + examples: + createAccountConfig: + value: + Key: first, + Value: first val /v1/Configs/{Key}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance mountName: account_configs + pathType: instance get: description: Retrieve a Config for an Account. + tags: + - MicrovisorV1AccountConfig parameters: - name: Key in: path @@ -356,14 +401,21 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_config' + examples: + fetch: + value: + key: first + value: place + date_updated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Configs/first description: OK security: - accountSid_authToken: [] operationId: FetchAccountConfig - x-maturity: - - Preview post: description: Update a config for an Account. + tags: + - MicrovisorV1AccountConfig parameters: - name: Key in: path @@ -377,12 +429,17 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_config' + examples: + update: + value: + key: first + value: place + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Configs/first description: OK security: - accountSid_authToken: [] operationId: UpdateAccountConfig - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -395,8 +452,14 @@ paths: description: The config value; up to 4096 characters. required: - Value + examples: + update: + value: + Value: place delete: description: Delete a config for an Account. + tags: + - MicrovisorV1AccountConfig parameters: - name: Key in: path @@ -410,18 +473,18 @@ paths: security: - accountSid_authToken: [] operationId: DeleteAccountConfig - x-maturity: - - Preview /v1/Secrets: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list mountName: account_secrets + pathType: list get: description: Retrieve a list of all Secrets for an Account. + tags: + - MicrovisorV1AccountSecret parameters: - name: PageSize in: query @@ -455,48 +518,81 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.account_secret' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + secrets: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0 + next_page_url: null + key: secrets + readFull: + value: + secrets: + - key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Secrets/first + - key: second + date_rotated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Secrets/second + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0 + next_page_url: null + key: secrets description: OK security: - accountSid_authToken: [] operationId: ListAccountSecret - x-maturity: - - Preview post: description: Create a secret for an Account. + tags: + - MicrovisorV1AccountSecret responses: '201': content: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_secret' + examples: + createAccountSecret: + value: + key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Secrets/first description: Created security: - accountSid_authToken: [] operationId: CreateAccountSecret - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -513,16 +609,23 @@ paths: required: - Key - Value + examples: + createAccountSecret: + value: + Key: first, + Value: first val /v1/Secrets/{Key}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance mountName: account_secrets + pathType: instance get: description: Retrieve a Secret for an Account. + tags: + - MicrovisorV1AccountSecret parameters: - name: Key in: path @@ -536,14 +639,20 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_secret' + examples: + fetch: + value: + key: first + date_rotated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Secrets/first description: OK security: - accountSid_authToken: [] operationId: FetchAccountSecret - x-maturity: - - Preview post: description: Update a secret for an Account. + tags: + - MicrovisorV1AccountSecret parameters: - name: Key in: path @@ -557,12 +666,16 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_secret' + examples: + update: + value: + key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Secrets/first description: OK security: - accountSid_authToken: [] operationId: UpdateAccountSecret - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -575,8 +688,14 @@ paths: description: The secret value; up to 4096 characters. required: - Value + examples: + update: + value: + Value: place delete: description: Delete a secret for an Account. + tags: + - MicrovisorV1AccountSecret parameters: - name: Key in: path @@ -590,21 +709,24 @@ paths: security: - accountSid_authToken: [] operationId: DeleteAccountSecret - x-maturity: - - Preview /v1/Apps: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - pathType: list dependentProperties: - app_manifest: '{app_sid: sid}' + app_manifests: + mapping: + app_sid: sid + resource_url: /v1/Apps/{app_sid}/Manifest + pathType: list get: description: Retrieve a list of all Apps for an Account. + tags: + - MicrovisorV1App parameters: - name: PageSize in: query @@ -638,47 +760,82 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.app' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + apps: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0 + next_page_url: null + key: apps + readFull: + value: + apps: + - sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + hash: hash + unique_name: unique name + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + app_manifests: https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0 + next_page_url: null + key: apps description: OK security: - accountSid_authToken: [] operationId: ListApp - x-maturity: - - Preview /v1/Apps/{Sid}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - pathType: instance dependentProperties: - app_manifest: '{app_sid: sid}' + app_manifests: + mapping: + app_sid: sid + resource_url: /v1/Apps/{app_sid}/Manifest + pathType: instance get: description: Fetch a specific App. + tags: + - MicrovisorV1App parameters: - name: Sid in: path @@ -692,14 +849,26 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.app' + examples: + fetch: + value: + sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + hash: hash + unique_name: look at this crazy app + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + app_manifests: https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest description: OK security: - accountSid_authToken: [] operationId: FetchApp - x-maturity: - - Preview delete: description: Delete a specific App. + tags: + - MicrovisorV1App parameters: - name: Sid in: path @@ -713,19 +882,19 @@ paths: security: - accountSid_authToken: [] operationId: DeleteApp - x-maturity: - - Preview /v1/Apps/{AppSid}/Manifest: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Apps/{Sid} mountName: app_manifests + pathType: instance get: description: Retrieve the Manifest for an App. + tags: + - MicrovisorV1AppManifest parameters: - name: AppSid in: path @@ -739,26 +908,39 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.app.app_manifest' + examples: + fetch: + value: + app_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + hash: some hash + encoded_bytes: some value + url: https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest description: OK security: - accountSid_authToken: [] operationId: FetchAppManifest - x-maturity: - - Preview /v1/Devices: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - pathType: list dependentProperties: - device_config: '{device_sid: sid}' - device_secret: '{device_sid: sid}' + device_configs: + mapping: + device_sid: sid + resource_url: /v1/Devices/{device_sid}/Configs + device_secrets: + mapping: + device_sid: sid + resource_url: /v1/Devices/{device_sid}/Secrets + pathType: list get: description: Retrieve a list of all Devices registered with the Account. + tags: + - MicrovisorV1Device parameters: - name: PageSize in: query @@ -792,48 +974,97 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.device' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + devices: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0 + next_page_url: null + key: devices + readFull: + value: + devices: + - sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: This is my device; there are many like it. + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + app: + target_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_hash: null + date_targeted: '2021-01-01T12:34:56Z' + update_status: up-to-date + update_error_code: 0 + reported_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_reported: '2021-01-01T12:34:56Z' + logging: + enabled: true + date_expires: '2021-01-01T12:34:56Z' + date_created: '2021-01-01T12:34:56Z' + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + device_configs: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs + device_secrets: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0 + next_page_url: null + key: devices description: OK security: - accountSid_authToken: [] operationId: ListDevice - x-maturity: - - Preview /v1/Devices/{Sid}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - pathType: instance dependentProperties: - device_config: '{device_sid: sid}' - device_secret: '{device_sid: sid}' + device_configs: + mapping: + device_sid: sid + resource_url: /v1/Devices/{device_sid}/Configs + device_secrets: + mapping: + device_sid: sid + resource_url: /v1/Devices/{device_sid}/Secrets + pathType: instance get: description: Fetch a specific Device. + tags: + - MicrovisorV1Device parameters: - name: Sid in: path @@ -847,14 +1078,37 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device' + examples: + fetch: + value: + sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: This is my device; there are many like it. + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + app: + target_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_hash: null + date_targeted: '2021-01-01T12:34:56Z' + update_status: up-to-date + update_error_code: 0 + reported_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_reported: '2021-01-01T12:34:56Z' + logging: + enabled: true + date_expires: '2021-01-01T12:34:56Z' + date_created: '2021-01-01T12:34:56Z' + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + device_configs: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs + device_secrets: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets description: OK security: - accountSid_authToken: [] operationId: FetchDevice - x-maturity: - - Preview post: description: Update a specific Device. + tags: + - MicrovisorV1Device parameters: - name: Sid in: path @@ -868,12 +1122,55 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device' + examples: + update: + value: + sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: UniqueName + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + app: + target_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_hash: null + date_targeted: '2021-01-01T12:34:56Z' + update_status: pending + update_error_code: 0 + reported_sid: null + date_reported: '2021-01-01T12:34:56Z' + logging: + enabled: false + date_expires: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + device_configs: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs + device_secrets: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets + restartApp: + value: + sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: UniqueName + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + app: + target_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_hash: null + date_targeted: '2021-01-01T12:34:56Z' + update_status: pending + update_error_code: 0 + reported_sid: null + date_reported: '2021-01-01T12:34:56Z' + logging: + enabled: false + date_expires: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + device_configs: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs + device_secrets: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets description: OK security: - accountSid_authToken: [] operationId: UpdateDevice - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -894,17 +1191,31 @@ paths: type: boolean description: A Boolean flag specifying whether to enable application logging. Logs will be enabled or extended for 24 hours. + RestartApp: + type: boolean + description: Set to true to restart the App running on the Device. + examples: + update: + value: + UniqueName: unique_name + TargetApp: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + LoggingEnabled: false + restartApp: + value: + RestartApp: true /v1/Devices/{DeviceSid}/Configs: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Devices/{Sid} mountName: device_configs + pathType: list get: description: Retrieve a list of all Configs for a Device. + tags: + - MicrovisorV1DeviceConfig parameters: - name: DeviceSid in: path @@ -944,36 +1255,69 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.device.device_config' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + configs: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0 + next_page_url: null + key: configs + readFull: + value: + configs: + - device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + value: some value + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first + - device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: second + value: some value + date_updated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/second + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0 + next_page_url: null + key: configs description: OK security: - accountSid_authToken: [] operationId: ListDeviceConfig - x-maturity: - - Preview post: description: Create a config for a Microvisor Device. + tags: + - MicrovisorV1DeviceConfig parameters: - name: DeviceSid in: path @@ -987,12 +1331,18 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_config' + examples: + createAccountConfig: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + value: some value + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first description: Created security: - accountSid_authToken: [] operationId: CreateDeviceConfig - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1009,17 +1359,24 @@ paths: required: - Key - Value + examples: + createAccountConfig: + value: + Key: first, + Value: first val /v1/Devices/{DeviceSid}/Configs/{Key}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Devices/{Sid} mountName: device_configs + pathType: instance get: description: Retrieve a Config for a Device. + tags: + - MicrovisorV1DeviceConfig parameters: - name: DeviceSid in: path @@ -1039,14 +1396,22 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_config' + examples: + fetch: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + value: some value + date_updated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first description: OK security: - accountSid_authToken: [] operationId: FetchDeviceConfig - x-maturity: - - Preview post: description: Update a config for a Microvisor Device. + tags: + - MicrovisorV1DeviceConfig parameters: - name: DeviceSid in: path @@ -1066,12 +1431,18 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_config' + examples: + update: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + value: place + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first description: OK security: - accountSid_authToken: [] operationId: UpdateDeviceConfig - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1084,8 +1455,14 @@ paths: description: The config value; up to 4096 characters. required: - Value + examples: + update: + value: + Value: place delete: description: Delete a config for a Microvisor Device. + tags: + - MicrovisorV1DeviceConfig parameters: - name: DeviceSid in: path @@ -1105,19 +1482,19 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDeviceConfig - x-maturity: - - Preview /v1/Devices/{DeviceSid}/Secrets: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Devices/{Sid} mountName: device_secrets + pathType: list get: description: Retrieve a list of all Secrets for a Device. + tags: + - MicrovisorV1DeviceSecret parameters: - name: DeviceSid in: path @@ -1157,36 +1534,67 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.device.device_secret' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + secrets: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0 + next_page_url: null + key: secrets + readFull: + value: + secrets: + - device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first + - device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: second + date_rotated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/second + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0 + next_page_url: null + key: secrets description: OK security: - accountSid_authToken: [] operationId: ListDeviceSecret - x-maturity: - - Preview post: description: Create a secret for a Microvisor Device. + tags: + - MicrovisorV1DeviceSecret parameters: - name: DeviceSid in: path @@ -1200,12 +1608,17 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_secret' + examples: + createAccountSecret: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first description: Created security: - accountSid_authToken: [] operationId: CreateDeviceSecret - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1222,17 +1635,24 @@ paths: required: - Key - Value + examples: + createAccountSecret: + value: + Key: first, + Value: first val /v1/Devices/{DeviceSid}/Secrets/{Key}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Devices/{Sid} mountName: device_secrets + pathType: instance get: description: Retrieve a Secret for a Device. + tags: + - MicrovisorV1DeviceSecret parameters: - name: DeviceSid in: path @@ -1252,14 +1672,21 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_secret' + examples: + fetch: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + date_rotated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first description: OK security: - accountSid_authToken: [] operationId: FetchDeviceSecret - x-maturity: - - Preview post: description: Update a secret for a Microvisor Device. + tags: + - MicrovisorV1DeviceSecret parameters: - name: DeviceSid in: path @@ -1279,12 +1706,17 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_secret' + examples: + update: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first description: OK security: - accountSid_authToken: [] operationId: UpdateDeviceSecret - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1297,8 +1729,14 @@ paths: description: The secret value; up to 4096 characters. required: - Value + examples: + update: + value: + Value: place delete: description: Delete a secret for a Microvisor Device. + tags: + - MicrovisorV1DeviceSecret parameters: - name: DeviceSid in: path @@ -1318,12 +1756,18 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDeviceSecret - x-maturity: - - Preview servers: - url: https://microvisor.twilio.com -x-maturity: -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. +tags: +- name: MicrovisorV1AccountConfig +- name: MicrovisorV1AccountSecret +- name: MicrovisorV1App +- name: MicrovisorV1AppManifest +- name: MicrovisorV1DebugToken +- name: MicrovisorV1Device +- name: MicrovisorV1DeviceCert +- name: MicrovisorV1DeviceConfig +- name: MicrovisorV1DeviceSecret +- name: MicrovisorV1LoggingToken +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_monitor_v1.yaml b/spec/yaml/twilio_monitor_v1.yaml index ba183343..c93f7063 100644 --- a/spec/yaml/twilio_monitor_v1.yaml +++ b/spec/yaml/twilio_monitor_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: monitor.v1.alert: type: object @@ -325,10 +329,6 @@ components: format: uri-map nullable: true description: The absolute URLs of related resources. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Monitor description: This is the public Twilio REST API. @@ -340,7 +340,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Alerts/{Sid}: @@ -356,6 +356,8 @@ paths: pathType: instance get: description: '' + tags: + - MonitorV1Alert parameters: - name: Sid in: path @@ -372,12 +374,32 @@ paths: application/json: schema: $ref: '#/components/schemas/monitor.v1.alert-instance' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + alert_text: alert_text + api_version: '2010-04-01' + date_created: '2015-07-30T20:00:00Z' + date_generated: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + error_code: error_code + log_level: log_level + more_info: more_info + request_method: GET + request_url: http://www.example.com + request_variables: request_variables + resource_sid: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + response_body: response_body + response_headers: response_headers + request_headers: request_headers + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://monitor.twilio.com/v1/Alerts/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: PNe2cd757cd5257b0217a447933a0290d2 description: OK security: - accountSid_authToken: [] operationId: FetchAlert - x-maturity: - - GA /v1/Alerts: servers: - url: https://monitor.twilio.com @@ -391,6 +413,8 @@ paths: pathType: list get: description: '' + tags: + - MonitorV1Alert parameters: - name: LogLevel in: query @@ -398,6 +422,11 @@ paths: `notice`, or `debug`.' schema: type: string + examples: + readEmpty: + value: log_level + readFull: + value: log_level - name: StartDate in: query description: Only include alerts that occurred on or after this date and time. @@ -406,6 +435,11 @@ paths: schema: type: string format: date-time + examples: + readEmpty: + value: '2016-01-01' + readFull: + value: '2016-01-01' - name: EndDate in: query description: Only include alerts that occurred on or before this date and @@ -414,6 +448,11 @@ paths: schema: type: string format: date-time + examples: + readEmpty: + value: '2016-01-01' + readFull: + value: '2016-01-01' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -446,34 +485,70 @@ paths: items: $ref: '#/components/schemas/monitor.v1.alert' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + alerts: [] + meta: + first_page_url: https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0 + key: alerts + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0 + readFull: + value: + alerts: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + alert_text: alert_text + api_version: '2010-04-01' + date_created: '2015-07-30T20:00:00Z' + date_generated: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + error_code: error_code + log_level: log_level + more_info: more_info + request_method: GET + request_url: http://www.example.com + resource_sid: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://monitor.twilio.com/v1/Alerts/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: PNe2cd757cd5257b0217a447933a0290d2 + meta: + first_page_url: https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0 + key: alerts + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListAlert - x-maturity: - - GA /v1/Events/{Sid}: servers: - url: https://monitor.twilio.com @@ -487,6 +562,8 @@ paths: pathType: instance get: description: '' + tags: + - MonitorV1Event parameters: - name: Sid in: path @@ -503,12 +580,32 @@ paths: application/json: schema: $ref: '#/components/schemas/monitor.v1.event' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_type: account + description: null + event_data: + friendly_name: + previous: SubAccount Created at 2014-10-03 09:48 am + updated: Mr. Friendly + event_date: '2014-10-03T16:48:25Z' + event_type: account.updated + links: + actor: https://api.twilio.com/2010-04-01/Accounts/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_type: account + sid: AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: api + source_ip_address: 10.86.6.250 + url: https://monitor.twilio.com/v1/Events/AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEvent - x-maturity: - - GA /v1/Events: servers: - url: https://monitor.twilio.com @@ -522,6 +619,8 @@ paths: pathType: list get: description: Returns a list of events in the account, sorted by event-date. + tags: + - MonitorV1Event parameters: - name: ActorSid in: query @@ -532,11 +631,21 @@ paths: minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ + examples: + readFull: + value: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: EventType in: query description: Only include events of this [Event Type](https://www.twilio.com/docs/usage/monitor-events#event-types). schema: type: string + examples: + readFull: + value: event_type + readEmpty: + value: event_type - name: ResourceSid in: query description: Only include events that refer to this resource. Useful for discovering @@ -546,6 +655,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readFull: + value: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: SourceIpAddress in: query description: Only include events that originated from this IP address. Useful @@ -553,6 +667,11 @@ paths: Console. schema: type: string + examples: + readFull: + value: source_ip_address + readEmpty: + value: source_ip_address - name: StartDate in: query description: Only include events that occurred on or after this date. Specify @@ -560,6 +679,11 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: EndDate in: query description: Only include events that occurred on or before this date. Specify @@ -567,6 +691,11 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -599,36 +728,78 @@ paths: items: $ref: '#/components/schemas/monitor.v1.event' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + events: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_type: account + description: null + event_data: + friendly_name: + previous: SubAccount Created at 2014-10-03 09:48 am + updated: Mr. Friendly + event_date: '2014-10-03T16:48:25Z' + event_type: account.updated + links: + actor: https://api.twilio.com/2010-04-01/Accounts/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_type: account + sid: AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: api + source_ip_address: 10.86.6.250 + url: https://monitor.twilio.com/v1/Events/AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://monitor.twilio.com/v1/Events?PageSize=50&Page=0 + key: events + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://monitor.twilio.com/v1/Events?PageSize=50&Page=0 + readEmpty: + value: + events: [] + meta: + first_page_url: https://monitor.twilio.com/v1/Events?PageSize=50&Page=0 + key: events + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://monitor.twilio.com/v1/Events?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListEvent - x-maturity: - - GA servers: - url: https://monitor.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: MonitorV1Alert +- name: MonitorV1Event +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_notify_v1.yaml b/spec/yaml/twilio_notify_v1.yaml index 2a609fa8..70f8a624 100644 --- a/spec/yaml/twilio_notify_v1.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: notify.v1.service.binding: type: object @@ -68,6 +72,10 @@ components: [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service. + x-twilio: + pii: + handling: standard + deleteSla: 120 binding_type: type: string nullable: true @@ -80,6 +88,10 @@ components: FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format. + x-twilio: + pii: + handling: sensitive + deleteSla: 120 tags: type: array items: @@ -88,6 +100,10 @@ components: description: The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed. + x-twilio: + pii: + handling: standard + deleteSla: 120 url: type: string format: uri @@ -204,6 +220,10 @@ components: description: The list of `identity` values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list. + x-twilio: + pii: + handling: standard + deleteSla: 120 tags: type: array items: @@ -212,6 +232,10 @@ components: description: The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property. + x-twilio: + pii: + handling: standard + deleteSla: 120 segments: type: array items: @@ -254,6 +278,10 @@ components: For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification. + x-twilio: + pii: + handling: standard + deleteSla: 0 sound: type: string nullable: true @@ -389,7 +417,7 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. In order to send SMS notifications this parameter has to be set. facebook_messenger_page_id: @@ -447,10 +475,15 @@ components: nullable: true description: Callback configuration that enables delivery callbacks, default false - securitySchemes: - accountSid_authToken: - type: http - scheme: basic + user_binding_enum_binding_type: + type: string + enum: + - apn + - gcm + - sms + - fcm + - facebook-messenger + - alexa info: title: Twilio - Notify description: This is the public Twilio REST API. @@ -462,13 +495,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Bindings/{Sid}: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -476,10 +509,12 @@ paths: - endpoint - binding_type - address - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - NotifyV1Binding parameters: - name: ServiceSid in: path @@ -507,14 +542,33 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.service.binding' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73 + binding_type: apn + credential_sid: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + endpoint: '26607274' + identity: '24987039' + notification_protocol_version: '3' + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tags: + - '26607274' + links: + user: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039 + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchBinding - x-maturity: - - Beta delete: description: '' + tags: + - NotifyV1Binding parameters: - name: ServiceSid in: path @@ -542,12 +596,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBinding - x-maturity: - - Beta /v1/Services/{ServiceSid}/Bindings: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -555,10 +607,12 @@ paths: - endpoint - binding_type - address - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - NotifyV1Binding parameters: - name: ServiceSid in: path @@ -576,12 +630,29 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.service.binding' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73 + binding_type: apn + credential_sid: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + endpoint: '26607274' + identity: '24987039' + notification_protocol_version: '3' + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tags: + - '26607274' + links: + user: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039 + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateBinding - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -638,8 +709,21 @@ paths: - Identity - BindingType - Address + examples: + create: + value: + Address: address + BindingType: apn + CredentialSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Endpoint: endpoint + Identity: '24987039' + NotificationProtocolVersion: notification_protocol_version + Tag: + - tag get: description: '' + tags: + - NotifyV1Binding parameters: - name: ServiceSid in: path @@ -673,6 +757,17 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 120 + examples: + readEmpty: + value: + - identity + readFull: + value: + - identity - name: Tag in: query description: 'Only list Bindings that have all of the specified Tags. The @@ -682,6 +777,13 @@ paths: type: array items: type: string + examples: + readEmpty: + value: + - tag + readFull: + value: + - tag - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -714,38 +816,75 @@ paths: items: $ref: '#/components/schemas/notify.v1.service.binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + bindings: [] + meta: + first_page_url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0 + key: bindings + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0 + readFull: + value: + bindings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73 + binding_type: apn + credential_sid: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + endpoint: '26607274' + identity: '24987039' + notification_protocol_version: '3' + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tags: + - '26607274' + links: + user: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039 + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0 + key: bindings + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListBinding - x-maturity: - - Beta /v1/Credentials: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -754,6 +893,8 @@ paths: pathType: list get: description: '' + tags: + - NotifyV1Credential parameters: - name: PageSize in: query @@ -787,48 +928,88 @@ paths: items: $ref: '#/components/schemas/notify.v1.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - Beta post: description: '' + tags: + - NotifyV1Credential responses: '201': content: application/json: schema: $ref: '#/components/schemas/notify.v1.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -870,10 +1051,14 @@ paths: console under Settings / Cloud messaging.' required: - Type + examples: + create: + value: + Type: apn /v1/Credentials/{Sid}: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -882,6 +1067,8 @@ paths: pathType: instance get: description: '' + tags: + - NotifyV1Credential parameters: - name: Sid in: path @@ -899,14 +1086,25 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - Beta post: description: '' + tags: + - NotifyV1Credential parameters: - name: Sid in: path @@ -924,12 +1122,21 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -965,8 +1172,14 @@ paths: type: string description: '[FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.' + examples: + update: + value: + FriendlyName: Test slow create delete: description: '' + tags: + - NotifyV1Credential parameters: - name: Sid in: path @@ -984,21 +1197,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - Beta /v1/Services/{ServiceSid}/Notifications: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - priority - title - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - NotifyV1Notification parameters: - name: ServiceSid in: path @@ -1016,12 +1229,56 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.service.notification' + examples: + create: + value: + sid: NTb8021351170b4e1286adaac3fdd6d082 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: IS699b53e02da45a1ba9d13b7d7d2766af + date_created: '2016-03-24T23:42:28Z' + identities: + - jing + tags: [] + segments: [] + priority: high + ttl: 2419200 + title: test + body: body + sound: null + action: null + data: null + apn: null + fcm: null + gcm: null + sms: null + facebook_messenger: null + alexa: null + createDirectNotification: + value: + sid: NTb8021351170b4e1286adaac3fdd6d082 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: IS699b53e02da45a1ba9d13b7d7d2766af + date_created: '2016-03-24T23:42:28Z' + identities: [] + tags: [] + segments: [] + priority: high + ttl: 2419200 + title: null + body: body + sound: null + action: null + data: null + apn: null + fcm: null + gcm: null + sms: null + facebook_messenger: null + alexa: null description: Created security: - accountSid_authToken: [] operationId: CreateNotification - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1106,12 +1363,12 @@ paths: description: 'The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the - Twilio [Message](https://www.twilio.com/docs/sms/send-messages) - resource. These parameters of the Message resource are supported - in snake case format: `body`, `media_urls`, `status_callback`, - and `max_price`. The `status_callback` parameter overrides the - corresponding parameter in the messaging service, if configured. - The `media_urls` property expects a JSON array.' + Twilio [Message](https://www.twilio.com/docs/sms/quickstart) resource. These + parameters of the Message resource are supported in snake case + format: `body`, `media_urls`, `status_callback`, and `max_price`. The + `status_callback` parameter overrides the corresponding parameter + in the messaging service, if configured. The `media_urls` property + expects a JSON array.' FacebookMessenger: description: Deprecated. Fcm: @@ -1162,6 +1419,18 @@ paths: a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to notify all Bindings in a specific channel. + examples: + create: + value: + Identity: jing + Body: body + Priority: high + Title: test + DeliveryCallbackUrl: hello + createDirectNotification: + value: + ToBinding: '{"binding_type":"apn", "address":"0efb85d06b3cc1bf290545fde4775a929d46b3541aaa4aa167e420b6c8b0ff15"}' + Body: body x-twilio: conditional: - - identity @@ -1169,32 +1438,72 @@ paths: /v1/Services: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list dependentProperties: - binding: '{service_sid: sid}' - notification: '{service_sid: sid}' - notify/v1/user: '{service_sid: sid}' - notify/v1/segment: '{service_sid: sid}' + bindings: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Bindings + notifications: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Notifications + users: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Users + segments: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Segments + pathType: list post: description: '' + tags: + - NotifyV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/notify.v1.service' + examples: + create: + value: + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 733c7f0f-6541-42ec-84ce-e2ae1cac588c + date_created: '2016-03-09T20:22:31Z' + date_updated: '2016-03-09T20:22:31Z' + apn_credential_sid: null + gcm_credential_sid: null + fcm_credential_sid: null + messaging_service_sid: null + facebook_messenger_page_id: '4' + alexa_skill_id: null + default_apn_notification_protocol_version: '3' + default_gcm_notification_protocol_version: '3' + default_fcm_notification_protocol_version: '3' + default_alexa_notification_protocol_version: '3' + log_enabled: true + type: S + delivery_callback_url: Hello + delivery_callback_enabled: true + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + bindings: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + segments: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments + users: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1225,7 +1534,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications. FacebookMessengerPageId: @@ -1273,8 +1582,25 @@ paths: type: boolean description: Callback configuration that enables delivery callbacks, default false + examples: + create: + value: + FriendlyName: friendly_name + ApnCredentialSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + GcmCredentialSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FacebookMessengerPageId: '4' + DefaultApnNotificationProtocolVersion: '3' + DefaultGcmNotificationProtocolVersion: '3' + DefaultFcmNotificationProtocolVersion: '3' + LogEnabled: 'True' + Type: S + DeliveryCallbackUrl: Hello + DeliveryCallbackEnabled: 'True' get: description: '' + tags: + - NotifyV1Service parameters: - name: FriendlyName in: query @@ -1313,51 +1639,111 @@ paths: items: $ref: '#/components/schemas/notify.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://notify.twilio.com/v1/Services?PageSize=50&Page=0 + previous_page_url: null + url: https://notify.twilio.com/v1/Services?PageSize=50&Page=0 + next_page_url: null + key: services + services: + - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 733c7f0f-6541-42ec-84ce-e2ae1cac588c + date_created: '2016-03-09T20:22:31Z' + date_updated: '2016-03-09T20:22:31Z' + apn_credential_sid: null + gcm_credential_sid: null + fcm_credential_sid: null + messaging_service_sid: null + facebook_messenger_page_id: '4' + alexa_skill_id: null + default_apn_notification_protocol_version: '3' + default_gcm_notification_protocol_version: '3' + default_fcm_notification_protocol_version: '3' + default_alexa_notification_protocol_version: '3' + log_enabled: true + type: S + delivery_callback_url: Hello + delivery_callback_enabled: true + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + bindings: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + segments: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments + users: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://notify.twilio.com/v1/Services?PageSize=50&Page=0 + previous_page_url: null + url: https://notify.twilio.com/v1/Services?PageSize=50&Page=0 + next_page_url: null + key: services + services: [] description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - Beta /v1/Services/{Sid}: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance dependentProperties: - binding: '{service_sid: sid}' - notification: '{service_sid: sid}' - notify/v1/user: '{service_sid: sid}' - notify/v1/segment: '{service_sid: sid}' + bindings: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Bindings + notifications: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Notifications + users: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Users + segments: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Segments + pathType: instance delete: description: '' + tags: + - NotifyV1Service parameters: - name: Sid in: path @@ -1375,10 +1761,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - Beta get: description: '' + tags: + - NotifyV1Service parameters: - name: Sid in: path @@ -1396,14 +1782,42 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.service' + examples: + fetch: + value: + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 733c7f0f-6541-42ec-84ce-e2ae1cac588c + date_created: '2016-03-09T20:22:31Z' + date_updated: '2016-03-09T20:22:31Z' + apn_credential_sid: null + gcm_credential_sid: null + fcm_credential_sid: null + messaging_service_sid: null + facebook_messenger_page_id: '4' + alexa_skill_id: null + default_apn_notification_protocol_version: '3' + default_gcm_notification_protocol_version: '3' + default_fcm_notification_protocol_version: '3' + default_alexa_notification_protocol_version: '3' + log_enabled: true + type: S + delivery_callback_url: Hello + delivery_callback_enabled: true + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + bindings: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + segments: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments + users: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - Beta post: description: '' + tags: + - NotifyV1Service parameters: - name: Sid in: path @@ -1421,12 +1835,38 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.service' + examples: + update: + value: + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 733c7f0f-6541-42ec-84ce-e2ae1cac588c + date_created: '2016-03-09T20:22:31Z' + date_updated: '2016-03-09T20:22:31Z' + apn_credential_sid: null + gcm_credential_sid: null + fcm_credential_sid: null + default_apn_notification_protocol_version: '3' + default_gcm_notification_protocol_version: '3' + default_fcm_notification_protocol_version: '3' + default_alexa_notification_protocol_version: '3' + messaging_service_sid: null + alexa_skill_id: null + facebook_messenger_page_id: '4' + log_enabled: true + type: S + delivery_callback_url: Hello + delivery_callback_enabled: true + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + bindings: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + segments: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments + users: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1457,7 +1897,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications. FacebookMessengerPageId: @@ -1505,9 +1945,31 @@ paths: type: boolean description: Callback configuration that enables delivery callbacks, default false + examples: + update: + value: + FriendlyName: friendly_name + ApnCredentialSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + GcmCredentialSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FacebookMessengerPageId: '4' + DefaultApnNotificationProtocolVersion: '3' + DefaultGcmNotificationProtocolVersion: '3' + DefaultFcmNotificationProtocolVersion: '3' + LogEnabled: 'True' + Type: S + DeliveryCallbackUrl: Hello + DeliveryCallbackEnabled: 'True' servers: - url: https://notify.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: NotifyV1Binding +- name: NotifyV1Credential +- name: NotifyV1Notification +- name: NotifyV1Segment +- name: NotifyV1SegmentMembership +- name: NotifyV1Service +- name: NotifyV1User +- name: NotifyV1UserBinding +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_numbers_v1.yaml b/spec/yaml/twilio_numbers_v1.yaml index 893997ca..6a3139ca 100644 --- a/spec/yaml/twilio_numbers_v1.yaml +++ b/spec/yaml/twilio_numbers_v1.yaml @@ -1,5 +1,17 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: + authorization_document_enum_status: + type: string + enum: + - opened + - signing + - signed + - canceled + - failed numbers.v1.bulk_eligibility: type: object properties: @@ -66,6 +78,24 @@ components: - invalid-hosting-account-sid - eligible - eligible-by-manual-process + dependent_order_enum_status: + type: string + enum: + - twilio-processing + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + dependent_order_enum_verification_type: + type: string + enum: + - phone-call + - phone-bill numbers.v1.eligibility: type: object properties: @@ -100,10 +130,220 @@ components: - invalid-phone-number - invalid-hosting-account-sid - eligible - securitySchemes: - accountSid_authToken: - type: http - scheme: basic + hosted_number_order_enum_status: + type: string + enum: + - twilio-processing + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + hosted_number_order_enum_verification_type: + type: string + enum: + - phone-call + - phone-bill + numbers.v1.porting_bulk_portability: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KZ[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this Portability + check. + status: + type: string + $ref: '#/components/schemas/porting_bulk_portability_enum_status' + nullable: true + description: The Status of this Portability check. One of `in-progress`, + `completed` or `expired`. + datetime_created: + type: string + format: date-time + nullable: true + description: The date that the Portability check was created, given in ISO + 8601 format. + phone_numbers: + type: array + items: {} + nullable: true + description: 'Contains a list with all the information of the requested + phone numbers. Each phone number contains the following properties: `phone_number`: + The phone number which portability is to be checked. `portable`: Boolean + flag specifying if phone number is portable or not. `not_portable_reason`: + Reason why the phone number cannot be ported into Twilio, `null` otherwise. + `not_portable_reason_code`: The Portability Reason Code for the phone + number if it cannot be ported in Twilio, `null` otherwise. `pin_and_account_number_required`: + Boolean flag specifying if PIN and account number is required for the + phone number. `number_type`: The type of the requested phone number. `country` + Country the phone number belongs to. `messaging_carrier` Current messaging + carrier of the phone number. `voice_carrier` Current voice carrier of + the phone number.' + url: + type: string + format: uri + nullable: true + description: This is the url of the request that you're trying to reach + out to locate the resource. + porting_bulk_portability_enum_status: + type: string + enum: + - in-progress + - completed + - expired + numbers.v1.porting_port_in: + type: object + properties: + port_in_request_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KW[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Port In request. This is a unique identifier + of the port in request. + url: + type: string + format: uri + nullable: true + numbers.v1.porting_port_in_fetch: + type: object + properties: + port_in_request_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KW[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Port In request. This is a unique identifier + of the port in request. + url: + type: string + format: uri + nullable: true + description: The URL of this Port In request + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The Account SID that the numbers will be added to after they + are ported into Twilio. + notification_emails: + type: array + items: + type: string + nullable: true + description: List of emails for getting notifications about the LOA signing + process. Allowed Max 10 emails. + target_port_in_date: + type: string + format: date + nullable: true + description: Minimum number of days in the future (at least 2 days) needs + to be established with the Ops team for validation. + target_port_in_time_range_start: + type: string + nullable: true + description: Minimum hour in the future needs to be established with the + Ops team for validation. + target_port_in_time_range_end: + type: string + nullable: true + description: Maximum hour in the future needs to be established with the + Ops team for validation. + losing_carrier_information: + nullable: true + description: 'The information for the losing carrier. ' + phone_numbers: + type: array + items: {} + nullable: true + description: The list of phone numbers to Port in. Phone numbers are in + E.164 format (e.g. +16175551212). + documents: + type: array + items: + type: string + nullable: true + description: The list of documents SID referencing a utility bills + numbers.v1.porting_portability: + type: object + properties: + phone_number: + type: string + format: phone-number + nullable: true + description: The phone number which portability is to be checked. Phone + numbers are in E.164 format (e.g. +16175551212). + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The target account sid to which the number will be ported + portable: + type: boolean + nullable: true + description: Boolean flag specifying if phone number is portable or not. + pin_and_account_number_required: + type: boolean + nullable: true + description: Boolean flag specifying if PIN and account number is required + for the phone number. + not_portable_reason: + type: string + nullable: true + description: Reason why the phone number cannot be ported into Twilio, `null` + otherwise. + not_portable_reason_code: + type: integer + nullable: true + description: The Portability Reason Code for the phone number if it cannot + be ported into Twilio, `null` otherwise. One of `22131`, `22132`, `22130`, + `22133`, `22102` or `22135`. + number_type: + type: string + $ref: '#/components/schemas/porting_portability_enum_number_type' + nullable: true + description: The type of the requested phone number. One of `LOCAL`, `UNKNOWN`, + `MOBILE`, `TOLL-FREE`. + country: + type: string + format: iso-country-code + nullable: true + description: Country the phone number belongs to. + messaging_carrier: + type: string + nullable: true + description: Current messaging carrier of the phone number + voice_carrier: + type: string + nullable: true + description: Current voice carrier of the phone number + url: + type: string + format: uri + nullable: true + description: This is the url of the request that you're trying to reach + out to locate the resource. + porting_portability_enum_number_type: + type: string + enum: + - LOCAL + - UNKNOWN + - MOBILE + - TOLL-FREE info: title: Twilio - Numbers description: This is the public Twilio REST API. @@ -115,27 +355,61 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/HostedNumber/Eligibility/Bulk: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list mountName: bulk_eligibilities + pathType: list + post: + description: Create a bulk eligibility check for a set of numbers that you want + to host in Twilio. + 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 + description: Accepted + security: + - accountSid_authToken: [] + operationId: CreateBulkEligibility + requestBody: + content: + application/json: + schema: + type: object + title: CreateBulkEligibilityRequest + properties: {} /v1/HostedNumber/Eligibility/Bulk/{RequestId}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance mountName: bulk_eligibilities + pathType: instance get: description: Fetch an eligibility bulk check that you requested to host in Twilio. + tags: + - NumbersV1BulkEligibility parameters: - name: RequestId in: path @@ -152,23 +426,389 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v1.bulk_eligibility' + examples: + fetch: + value: + friendly_name: Foo + status: SUCCESSFUL + date_created: '2023-04-24T14:47:04Z' + date_completed: '2023-04-24T14:47:06Z' + results: + - phone_number: '+18778894546' + account_sid: AC93b447ff5bd2abac37f1cbab2a871430 + eligibility_status: INELIGIBLE + eligibility_sub_status: ALREADY_IN_TWILIO + ineligibility_reason: ALREADY_IN_TWILIO_BUT_NOT_IN_USE + next_step: CONTACT_SUPPORT_INELIGIBLE_INVENTORY_STATUS + voice_provider: null + messaging_provider: null + phone_number_type: TOLL_FREE + hosting_order_sid: null + hosting_order_status: null + iso_country_code: US + inventory_status: in-testing + inventory_account_sid: AC93b447ff5bd2abac37f1cbab2a871430 + url: https://numbers.twilio.com/v1/HostedNumber/Eligibility/Bulk/ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + request_id: ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchBulkEligibility - x-maturity: - - Beta /v1/HostedNumber/Eligibility: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list mountName: eligibilities + pathType: list + post: + description: Create an eligibility check for a number that you want to host + in Twilio. + 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 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateEligibility + requestBody: + content: + application/json: + schema: + type: object + title: CreateEligibilityRequest + properties: {} + /v1/Porting/Portability/{Sid}: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - status + mountName: porting_bulk_portabilities + pathType: instance + get: + description: Fetch a previous portability check. This should return the current + status of the validation and the result for all the numbers provided, given + that they have been validated (as this process is performed asynchronously). + tags: + - NumbersV1PortingBulkPortability + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies the Portability + check. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KZ[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v1.porting_bulk_portability' + examples: + fetch: + value: + sid: KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + datetime_created: '2015-07-30T20:00:00Z' + phone_numbers: + - phone_number: '+14153334440' + portable: true + pin_and_account_number_required: true + not_portable_reason: null + not_portable_reason_code: null + number_type: LOCAL + country: US + messaging_carrier: string + voice_carrier: string + - phone_number: '+18002178781' + portable: false + pin_and_account_number_required: false + not_portable_reason: MANUAL_PORTING_AVAILABLE + not_portable_reason_code: 22133 + number_type: TOLL-FREE + country: US + messaging_carrier: Verizon + voice_carrier: Verizon + url: https://numbers.twilio.com/v1/Porting/Portability/KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPortingBulkPortability + /v1/Porting/Portability: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - status + mountName: porting_bulk_portabilities + pathType: list + post: + description: Allows to check if a list of phone numbers can be ported to Twilio + or not. This is done asynchronous for each phone number. + tags: + - NumbersV1PortingBulkPortability + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v1.porting_bulk_portability' + examples: + create: + value: + sid: KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: in-progress + datetime_created: '2015-07-30T20:00:00Z' + phone_numbers: [] + url: https://numbers.twilio.com/v1/Porting/Portability/KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Accepted + security: + - accountSid_authToken: [] + operationId: CreatePortingBulkPortability + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreatePortingBulkPortabilityRequest + properties: + PhoneNumbers: + type: array + items: + type: string + description: The phone numbers which portability is to be checked. + This should be a list of strings. Phone numbers are in E.164 format + (e.g. +16175551212). . + required: + - PhoneNumbers + examples: + create: + value: + PhoneNumbers: + - '+14153334440' + - '+18002178781' + /v1/Porting/PortIn: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - port_in_request_sid + 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 + url: https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Accepted + security: + - accountSid_authToken: [] + operationId: CreatePortingPortIn + requestBody: + content: + application/json: + schema: + type: object + title: CreatePortingPortInRequest + properties: {} + /v1/Porting/PortIn/{PortInRequestSid}: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - port_in_request_sid + mountName: porting_port_ins_fetch + className: porting_port_in_fetch + pathType: instance + get: + description: Fetch a port in request by SID + tags: + - NumbersV1PortingPortInFetch + parameters: + - name: PortInRequestSid + in: path + description: The SID of the Port In request. This is a unique identifier of + the port in request. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KW[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v1.porting_port_in_fetch' + 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 + 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 + documents: + - ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPortingPortInFetch + /v1/Porting/Portability/PhoneNumber/{PhoneNumber}: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + mountName: porting_portabilities + pathType: instance + get: + description: Allows to check if a single phone number can be ported to Twilio + or not. + tags: + - NumbersV1PortingPortability + parameters: + - name: PhoneNumber + in: path + description: The phone number which portability is to be checked. Phone numbers + are in E.164 format (e.g. +16175551212). + schema: + type: string + format: phone-number + required: true + - name: TargetAccountSid + in: query + description: The SID of the account where the phone number(s) will be ported. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + examples: + fetch: + value: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 + responses: + '200': + content: + 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 + messaging_carrier: Verizon + voice_carrier: Verizon + url: https://numbers.twilio.com/v1/Porting/Portability/PhoneNumber/+18001234567 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPortingPortability servers: - url: https://numbers.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: NumbersV1AuthorizationDocument +- name: NumbersV1BulkEligibility +- name: NumbersV1DependentOrder +- name: NumbersV1Documents +- name: NumbersV1Eligibility +- name: NumbersV1HostedNumberOrder +- name: NumbersV1Identity +- name: NumbersV1PortingBulkPortability +- name: NumbersV1PortingPortIn +- name: NumbersV1PortingPortInFetch +- name: NumbersV1PortingPortability +- name: NumbersV1ProofOfAddress +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_numbers_v2.yaml b/spec/yaml/twilio_numbers_v2.yaml index 3a7f30b8..4a48f429 100644 --- a/spec/yaml/twilio_numbers_v2.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -1,5 +1,154 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: + numbers.v2.authorization_document: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this AuthorizationDocument. + address_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the Address + resource that is associated with this AuthorizationDocument. + status: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + nullable: true + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + email: + type: string + nullable: true + description: Email that this AuthorizationDocument will be sent to for signing. + x-twilio: + pii: + handling: standard + deleteSla: 30 + cc_emails: + type: array + items: + type: string + nullable: true + description: Email recipients who will be informed when an Authorization + Document has been sent and signed. + x-twilio: + pii: + handling: standard + deleteSla: 30 + date_created: + type: string + format: date-time + nullable: true + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + url: + type: string + format: uri + nullable: true + links: + type: object + format: uri-map + nullable: true + authorization_document_enum_status: + type: string + enum: + - opened + - signing + - signed + - canceled + - failed + numbers.v2.bulk_hosted_number_order: + type: object + properties: + bulk_hosting_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BH[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this BulkHostedNumberOrder. + request_status: + type: string + $ref: '#/components/schemas/bulk_hosted_number_order_enum_request_status' + nullable: true + description: 'A string that shows the status of the current Bulk Hosting + request, it can vary between these values: ''QUEUED'',''IN_PROGRESS'',''PROCESSED''' + friendly_name: + type: string + nullable: true + description: A 128 character string that is a human-readable text that describes + this resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + notification_email: + type: string + nullable: true + description: Email address used for send notifications about this Bulk hosted + number request. + x-twilio: + pii: + handling: standard + deleteSla: 30 + date_created: + type: string + format: date-time + nullable: true + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. + date_completed: + type: string + format: date-time + nullable: true + description: The date that this resource was completed, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + url: + type: string + format: uri + nullable: true + description: The URL of this BulkHostedNumberOrder resource. + total_count: + type: integer + nullable: true + description: The total count of phone numbers in this Bulk hosting request. + results: + type: array + items: {} + nullable: true + description: Contains a list of all the individual hosting orders and their + information, for this Bulk request. Each result object is grouped by its + order status. To see a complete list of order status, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'. + x-twilio: + pii: + handling: standard + deleteSla: 30 + bulk_hosted_number_order_enum_request_status: + type: string + enum: + - QUEUED + - IN_PROGRESS + - PROCESSED numbers.v2.regulatory_compliance.bundle: type: object properties: @@ -174,6 +323,154 @@ components: enum: - individual - business + numbers.v2.authorization_document.dependent_hosted_number_order: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this Authorization + Document + bulk_hosting_request_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BH[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the bulk hosting + request associated with this HostedNumberOrder. + next_step: + type: string + nullable: true + description: The next step you need to take to complete the hosted number + order and request it successfully. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The unique SID identifier of the Account. + incoming_phone_number_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + address_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the Address + resource that represents the address of the owner of this phone number. + signing_document_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the LOA document + associated with this HostedNumberOrder. + phone_number: + type: string + format: phone-number + nullable: true + description: An E164 formatted phone number hosted by this HostedNumberOrder. + capabilities: + type: object + format: phone-number-capabilities + properties: + mms: + type: boolean + sms: + type: boolean + voice: + type: boolean + fax: + type: boolean + nullable: true + description: A mapping of capabilities this hosted phone number will have + enabled on Twilio's platform. + friendly_name: + type: string + nullable: true + description: A human readable description of this resource, up to 128 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 + status: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + nullable: true + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + failure_reason: + type: string + nullable: true + description: A message that explains why a hosted_number_order went to status + "action-required" + date_created: + type: string + format: date-time + nullable: true + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + email: + type: string + nullable: true + description: Email of the owner of this phone number that is being hosted. + x-twilio: + pii: + handling: standard + deleteSla: 30 + cc_emails: + type: array + items: + type: string + nullable: true + description: Email recipients who will be informed when an Authorization + Document has been sent and signed + x-twilio: + pii: + handling: standard + deleteSla: 30 + contact_title: + type: string + nullable: true + description: The title of the person authorized to sign the Authorization + Document for this phone number. + contact_phone_number: + type: string + format: phone-number + nullable: true + description: The contact phone number of the person authorized to sign the + Authorization Document. + dependent_hosted_number_order_enum_status: + type: string + enum: + - received + - verified + - pending-loa + - carrier-processing + - completed + - failed + - action-required numbers.v2.regulatory_compliance.end_user: type: object properties: @@ -207,6 +504,10 @@ components: nullable: true description: The set of parameters that are the attributes of the End Users resource which are listed in the End User Types. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -319,6 +620,166 @@ components: enum: - compliant - noncompliant + numbers.v2.hosted_number_order: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this HostedNumberOrder. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the account. + incoming_phone_number_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) + resource that represents the phone number being hosted. + address_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the Address + resource that represents the address of the owner of this phone number. + signing_document_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the [Authorization + Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) + the user needs to sign. + phone_number: + type: string + format: phone-number + nullable: true + description: Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) + format, e.g., +16175551212 + x-twilio: + pii: + handling: standard + deleteSla: 30 + capabilities: + type: object + format: phone-number-capabilities + properties: + mms: + type: boolean + sms: + type: boolean + voice: + type: boolean + fax: + type: boolean + nullable: true + description: Set of booleans describing the capabilities hosted on Twilio's + platform. SMS is currently only supported. + friendly_name: + type: string + nullable: true + description: A 128 character string that is a human-readable text that describes + this resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + status: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_status' + nullable: true + description: 'Status of this resource. It can hold one of the values: 1. + Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, + 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders + Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values) + section for more information on each of these statuses.' + failure_reason: + type: string + nullable: true + description: A message that explains why a hosted_number_order went to status + "action-required" + date_created: + type: string + format: date-time + nullable: true + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + email: + type: string + nullable: true + description: Email of the owner of this phone number that is being hosted. + x-twilio: + pii: + handling: standard + deleteSla: 30 + cc_emails: + type: array + items: + type: string + nullable: true + description: A list of emails that LOA document for this HostedNumberOrder + will be carbon copied to. + x-twilio: + pii: + handling: standard + deleteSla: 30 + url: + type: string + format: uri + nullable: true + description: The URL of this HostedNumberOrder. + contact_title: + type: string + nullable: true + description: The title of the person authorized to sign the Authorization + Document for this phone number. + contact_phone_number: + type: string + format: phone-number + nullable: true + description: The contact phone number of the person authorized to sign the + Authorization Document. + bulk_hosting_request_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BH[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the bulk hosting + request associated with this HostedNumberOrder. + next_step: + type: string + nullable: true + description: The next step you need to take to complete the hosted number + order and request it successfully. + hosted_number_order_enum_status: + type: string + enum: + - received + - verified + - pending-loa + - carrier-processing + - completed + - failed + - action-required numbers.v2.regulatory_compliance.bundle.item_assignment: type: object properties: @@ -535,6 +996,10 @@ components: nullable: true description: The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -594,10 +1059,6 @@ components: format: uri nullable: true description: The absolute URL of the Supporting Document Type resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Numbers description: This is the public Twilio REST API. @@ -609,39 +1070,495 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: + /v2/HostedNumber/AuthorizationDocuments/{Sid}: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + dependent_hosted_number_orders: + mapping: + signing_document_sid: sid + resource_url: /v2/HostedNumber/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders + pathType: instance + get: + description: Fetch a specific AuthorizationDocument. + tags: + - NumbersV2AuthorizationDocument + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this AuthorizationDocument. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v2.authorization_document' + examples: + fetch: + value: + address_sid: AD11111111111111111111111111111111 + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + links: + dependent_hosted_number_orders: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchAuthorizationDocument + delete: + description: Cancel the AuthorizationDocument request. + tags: + - NumbersV2AuthorizationDocument + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this AuthorizationDocument. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteAuthorizationDocument + /v2/HostedNumber/AuthorizationDocuments: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + dependent_hosted_number_orders: + mapping: + signing_document_sid: sid + 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. + tags: + - NumbersV2AuthorizationDocument + parameters: + - name: Email + in: query + description: Email that this AuthorizationDocument will be sent to for signing. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: test+hosted@twilio.com + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + examples: + readEmpty: + value: signed + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListAuthorizationDocumentResponse + properties: + items: + type: array + items: + $ref: '#/components/schemas/numbers.v2.authorization_document' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0 + items: + - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: ListAuthorizationDocument + post: + description: Create an AuthorizationDocument for authorizing the hosting of + phone number capabilities on Twilio's platform. + tags: + - NumbersV2AuthorizationDocument + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v2.authorization_document' + examples: + create: + value: + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateAuthorizationDocument + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateAuthorizationDocumentRequest + properties: + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + Email: + type: string + description: Email that this AuthorizationDocument will be sent + to for signing. + ContactPhoneNumber: + type: string + format: phone-number + description: The contact phone number of the person authorized to + sign the Authorization Document. + HostedNumberOrderSids: + type: array + items: + type: string + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + ContactTitle: + type: string + description: The title of the person authorized to sign the Authorization + Document for this phone number. + CcEmails: + type: array + items: + type: string + description: Email recipients who will be informed when an Authorization + Document has been sent and signed. + required: + - AddressSid + - Email + - ContactPhoneNumber + - HostedNumberOrderSids + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + HostedNumberOrderSids: + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 + ContactTitle: Mr. + ContactPhoneNumber: '+14155555555' + /v2/HostedNumber/Orders/Bulk/{BulkHostingSid}: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + mountName: bulk_hosted_number_orders + pathType: instance + get: + description: Fetch a specific BulkHostedNumberOrder. + tags: + - NumbersV2BulkHostedNumberOrder + parameters: + - name: BulkHostingSid + in: path + description: A 34 character string that uniquely identifies this BulkHostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BH[0-9a-fA-F]{32}$ + required: true + - name: OrderStatus + in: query + description: Order status can be used for filtering on Hosted Number Order + status values. To see a complete list of order statuses, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'. + schema: + type: string + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchBulkHostedNumberOrder + /v2/HostedNumber/Orders/Bulk: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + 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: [] + description: Accepted + security: + - accountSid_authToken: [] + operationId: CreateBulkHostedNumberOrder + requestBody: + content: + application/json: + schema: + type: object + title: CreateBulkHostedNumberOrderRequest + properties: {} /v2/RegulatoryCompliance/Bundles: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - regulation_sid - friendly_name - pathType: list dependentProperties: - evaluation: '{bundle_sid: sid}' - item_assignment: '{bundle_sid: sid}' - bundle_copy: '{bundle_sid: sid}' - replace_items: '{bundle_sid: sid}' + evaluations: + mapping: + bundle_sid: sid + resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Evaluations + item_assignments: + mapping: + bundle_sid: sid + resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ItemAssignments + bundle_copies: + mapping: + bundle_sid: sid + resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Copies + replace_items: + mapping: + bundle_sid: sid + resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ReplaceItems parent: /RegulatoryCompliance + pathType: list post: description: Create a new Bundle. + tags: + - NumbersV2Bundle responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' + examples: + create: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies description: Created security: - accountSid_authToken: [] operationId: CreateBundle - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -684,8 +1601,17 @@ paths: required: - FriendlyName - Email + examples: + create: + value: + FriendlyName: friendly_name + Email: email + RegulationSid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + StatusCallback: http://www.example.com get: description: Retrieve a list of all Bundles for an account. + tags: + - NumbersV2Bundle parameters: - name: Status in: query @@ -695,12 +1621,24 @@ paths: schema: type: string $ref: '#/components/schemas/bundle_enum_status' + examples: + readFull: + value: draft + readApprovedAuMobileWithDate: + value: twilio-approved + readApprovedAuMobileDateLess: + value: twilio-approved + readApprovedJapanTollfreeDateBetween: + value: twilio-approved - name: FriendlyName in: query description: The string that you assigned to describe the resource. The column can contain 255 variable characters. schema: type: string + examples: + readFull: + value: friendly_name - name: RegulationSid in: query description: The unique string of a [Regulation resource](https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations) @@ -710,24 +1648,48 @@ paths: minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ + examples: + readFull: + value: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: IsoCountry in: query description: The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request. schema: type: string + examples: + readFull: + value: US + readApprovedAuMobileWithDate: + value: AU + readApprovedAuMobileDateLess: + value: AU + readApprovedJapanTollfreeDateBetween: + value: JP - name: NumberType in: query description: The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `tollfree`. schema: type: string + examples: + readFull: + value: mobile + readApprovedAuMobileWithDate: + value: mobile + readApprovedAuMobileDateLess: + value: mobile + readApprovedJapanTollfreeDateBetween: + value: tollfree - name: HasValidUntilDate in: query description: Indicates that the Bundle is a valid Bundle until a specified expiration date. schema: type: boolean + examples: + readApprovedAuMobileWithDate: + value: 'true' - name: SortBy in: query description: Can be `valid-until` or `date-updated`. Defaults to `date-created`. @@ -758,6 +1720,16 @@ paths: schema: type: string format: date-time + x-twilio: + shortDescription: Date to filter Bundles having their `valid_until_date` + before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. + Both can be used in conjunction as well. + ignoreFormat: true + examples: + readApprovedAuMobileDateLess: + value: '2022-11-29T23:59:59Z' + readApprovedJapanTollfreeDateBetween: + value: '2022-11-29T23:59:59Z' - name: ValidUntilDate> in: query description: Date to filter Bundles having their `valid_until_date` before @@ -767,6 +1739,14 @@ paths: schema: type: string format: date-time + x-twilio: + shortDescription: Date to filter Bundles having their `valid_until_date` + before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. + Both can be used in conjunction as well. + ignoreFormat: true + examples: + readApprovedJapanTollfreeDateBetween: + value: '2022-01-01T00:00:00Z' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -799,52 +1779,180 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: provisionally-approved + email: email + status_callback: http://www.example.com + valid_until: '2020-07-31T01:00:00Z' + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=draft&RegulationSid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IsoCountry=US&FriendlyName=friendly_name&NumberType=mobile&PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=draft&RegulationSid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IsoCountry=US&FriendlyName=friendly_name&NumberType=mobile&PageSize=50&Page=0 + next_page_url: null + key: results + readApprovedAuMobileWithDate: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: twilio-approved + email: email + status_callback: http://www.example.com + valid_until: '2022-11-29T01:00:00Z' + date_created: '2021-08-30T22:29:24Z' + date_updated: '2021-08-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&HasValidUntilDate=true&NumberType=mobile&PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&HasValidUntilDate=true&NumberType=mobile&PageSize=50&Page=0 + next_page_url: null + key: results + readApprovedAuMobileDateLess: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: twilio-approved + email: email + status_callback: http://www.example.com + valid_until: '2022-11-29T01:00:00Z' + date_created: '2021-08-30T22:29:24Z' + date_updated: '2021-08-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=mobile&PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=mobile&PageSize=50&Page=0 + next_page_url: null + key: results + readApprovedJapanTollfreeDateBetween: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: twilio-approved + email: email + status_callback: http://www.example.com + valid_until: '2022-11-29T01:00:00Z' + date_created: '2021-08-30T22:29:24Z' + date_updated: '2021-08-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=JP&ValidUntilDate%3E=2022-01-01T00%3A00%3A00Z&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=tollfree&PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=JP&ValidUntilDate%3E=2022-01-01T00%3A00%3A00Z&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=tollfree&PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListBundle - x-maturity: - - GA /v2/RegulatoryCompliance/Bundles/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - regulation_sid - friendly_name - pathType: instance dependentProperties: - evaluation: '{bundle_sid: sid}' - item_assignment: '{bundle_sid: sid}' - bundle_copy: '{bundle_sid: sid}' - replace_items: '{bundle_sid: sid}' + evaluations: + mapping: + bundle_sid: sid + resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Evaluations + item_assignments: + mapping: + bundle_sid: sid + resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ItemAssignments + bundle_copies: + mapping: + bundle_sid: sid + resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Copies + replace_items: + mapping: + bundle_sid: sid + resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ReplaceItems parent: /RegulatoryCompliance + pathType: instance get: description: Fetch a specific Bundle instance. + tags: + - NumbersV2Bundle parameters: - name: Sid in: path @@ -861,14 +1969,32 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' + examples: + fetch: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + valid_until: null + email: email + status_callback: http://www.example.com + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies description: OK security: - accountSid_authToken: [] operationId: FetchBundle - x-maturity: - - GA post: description: Updates a Bundle in an account. + tags: + - NumbersV2Bundle parameters: - name: Sid in: path @@ -885,12 +2011,28 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' + examples: + update: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies description: OK security: - accountSid_authToken: [] operationId: UpdateBundle - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -914,8 +2056,17 @@ paths: type: string description: The email address that will receive updates when the Bundle resource changes status. + examples: + update: + value: + Status: draft + StatusCallback: http://www.example.com + FriendlyName: friendly_name + Email: email delete: description: Delete a specific Bundle. + tags: + - NumbersV2Bundle parameters: - name: Sid in: path @@ -932,20 +2083,20 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBundle - x-maturity: - - GA /v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /RegulatoryCompliance/Bundles/{Sid} mountName: bundle_copies + pathType: list post: description: Creates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle + tags: + - NumbersV2BundleCopy parameters: - name: BundleSid in: path @@ -962,12 +2113,23 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.bundle_copy' + examples: + create: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + valid_until: '2015-07-30T20:00:00Z' + email: email + status_callback: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: Created security: - accountSid_authToken: [] operationId: CreateBundleCopy - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -979,8 +2141,14 @@ paths: type: string description: The string that you assigned to describe the copied bundle. + examples: + create: + value: + FriendlyName: friendly_name get: description: Retrieve a list of all Bundles Copies for a Bundle. + tags: + - NumbersV2BundleCopy parameters: - name: BundleSid in: path @@ -1023,58 +2191,273 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.bundle_copy' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true + type: string url: + format: uri type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: twilio-approved + email: email + status_callback: http://www.example.com + valid_until: '2020-07-31T01:00:00Z' + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 + next_page_url: null + key: results + description: OK + security: + - accountSid_authToken: [] + operationId: ListBundleCopy + /v2/HostedNumber/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /HostedNumber/AuthorizationDocuments/{Sid} + pathType: list + get: + description: Retrieve a list of dependent HostedNumberOrders belonging to the + AuthorizationDocument. + tags: + - NumbersV2DependentHostedNumberOrder + parameters: + - name: SigningDocumentSid + in: path + description: A 34 character string that uniquely identifies the LOA document + associated with this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. + schema: + type: string + format: phone-number + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid + in: query + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 128 characters. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: example + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListDependentHostedNumberOrderResponse + properties: + items: + type: array + items: + $ref: '#/components/schemas/numbers.v2.authorization_document.dependent_hosted_number_order' + meta: + properties: + first_page_url: format: uri + type: string key: type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + failure_reason: '' + contact_title: contact_title_test + contact_phone_number: '+12344444444' + bulk_hosting_request_sid: BH11111111111111111111111111111111 + next_step: Test description: OK security: - accountSid_authToken: [] - operationId: ListBundleCopy - x-maturity: - - Beta + operationId: ListDependentHostedNumberOrder /v2/RegulatoryCompliance/EndUsers: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /RegulatoryCompliance + pathType: list post: description: Create a new End User. + tags: + - NumbersV2EndUser responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' + examples: + create: + value: + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + type: individual + attributes: + email: foobar@twilio.com + date_created: '2019-07-30T21:57:45Z' + date_updated: '2019-07-30T21:57:45Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateEndUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1096,8 +2479,16 @@ paths: required: - FriendlyName - Type + examples: + create: + value: + FriendlyName: friendly_name + Type: individual + Attributes: '{}' get: description: Retrieve a list of all End User for an account. + tags: + - NumbersV2EndUser parameters: - name: PageSize in: query @@ -1131,46 +2522,78 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + type: individual + attributes: + email: foobar@twilio.com + date_created: '2019-07-30T21:57:45Z' + date_updated: '2019-07-30T21:57:45Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListEndUser - x-maturity: - - GA /v2/RegulatoryCompliance/EndUsers/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /RegulatoryCompliance + pathType: instance get: description: Fetch specific End User Instance. + tags: + - NumbersV2EndUser parameters: - name: Sid in: path @@ -1188,14 +2611,26 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' + examples: + fetch: + value: + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + type: individual + attributes: + email: foobar@twilio.com + date_created: '2019-07-30T21:57:45Z' + date_updated: '2019-07-30T21:57:45Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEndUser - x-maturity: - - GA post: description: Update an existing End User. + tags: + - NumbersV2EndUser parameters: - name: Sid in: path @@ -1213,12 +2648,22 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' + examples: + update: + value: + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + type: individual + attributes: + email: foobar@twilio.com + date_created: '2019-07-30T21:57:45Z' + date_updated: '2019-07-30T21:57:45Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateEndUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1232,8 +2677,15 @@ paths: Attributes: description: The set of parameters that are the attributes of the End User resource which are derived End User Types. + examples: + update: + value: + FriendlyName: friendly_name + Attributes: '{}' delete: description: Delete a specific End User. + tags: + - NumbersV2EndUser parameters: - name: Sid in: path @@ -1251,20 +2703,20 @@ paths: security: - accountSid_authToken: [] operationId: DeleteEndUser - x-maturity: - - GA /v2/RegulatoryCompliance/EndUserTypes: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /RegulatoryCompliance + pathType: list get: description: Retrieve a list of all End-User Types. + tags: + - NumbersV2EndUserType parameters: - name: PageSize in: query @@ -1298,46 +2750,80 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + end_user_types: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 + next_page_url: null + key: end_user_types + readFull: + value: + end_user_types: + - sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + machine_name: machine_name + fields: + - friendly_name: Business Purpose + machine_name: business_purpose + constraint: String + - friendly_name: Last Name + machine_name: last_name + constraint: String + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 + next_page_url: null + key: end_user_types description: OK security: - accountSid_authToken: [] operationId: ListEndUserType - x-maturity: - - GA /v2/RegulatoryCompliance/EndUserTypes/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /RegulatoryCompliance + pathType: instance get: description: Fetch a specific End-User Type Instance. + tags: + - NumbersV2EndUserType parameters: - name: Sid in: path @@ -1351,23 +2837,37 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user_type' + examples: + fetch: + value: + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + machine_name: machine_name + fields: + - friendly_name: Business Purpose + machine_name: business_purpose + constraint: String + - friendly_name: Last Name + machine_name: last_name + constraint: String + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEndUserType - x-maturity: - - GA /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /RegulatoryCompliance/Bundles/{Sid} + pathType: list post: description: Creates an evaluation for a bundle + tags: + - NumbersV2Evaluation parameters: - name: BundleSid in: path @@ -1384,14 +2884,169 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation' + examples: + create: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info description: Created security: - accountSid_authToken: [] operationId: CreateEvaluation - x-maturity: - - GA get: description: Retrieve a list of Evaluations associated to the Bundle resource. + tags: + - NumbersV2Evaluation parameters: - name: BundleSid in: path @@ -1434,45 +3089,220 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add + one to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the + Business information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter + in a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure + both Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in + the address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListEvaluation - x-maturity: - - GA /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /RegulatoryCompliance/Bundles/{Sid} + pathType: instance get: description: Fetch specific Evaluation Instance. + tags: + - NumbersV2Evaluation parameters: - name: BundleSid in: path @@ -1498,23 +3328,628 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation' + examples: + fetch: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info description: OK security: - accountSid_authToken: [] operationId: FetchEvaluation - x-maturity: - - GA + /v2/HostedNumber/Orders/{Sid}: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + mountName: hosted_number_orders + pathType: instance + get: + description: Fetch a specific HostedNumberOrder. + tags: + - NumbersV2HostedNumberOrder + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v2.hosted_number_order' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + failure_reason: '' + bulk_hosting_request_sid: 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' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchHostedNumberOrder + delete: + description: Cancel the HostedNumberOrder (only available when the status is + in `received`). + tags: + - NumbersV2HostedNumberOrder + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteHostedNumberOrder + /v2/HostedNumber/Orders: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + mountName: hosted_number_orders + pathType: list + get: + description: Retrieve a list of HostedNumberOrders belonging to the account + initiating the request. + tags: + - NumbersV2HostedNumberOrder + parameters: + - name: Status + in: query + description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, + `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, + `failed`, or `action-required`. + schema: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: SmsCapability + in: query + description: Whether the SMS capability will be hosted on our platform. Can + be `true` of `false`. + schema: + type: boolean + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. + schema: + type: string + format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid + in: query + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 128 characters. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: example + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListHostedNumberOrderResponse + properties: + items: + type: array + items: + $ref: '#/components/schemas/numbers.v2.hosted_number_order' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/Orders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/Orders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/Orders?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/Orders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + failure_reason: '' + friendly_name: friendly_name + bulk_hosting_request_sid: 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' + description: OK + security: + - accountSid_authToken: [] + operationId: ListHostedNumberOrder + post: + description: Host a phone number's capability on Twilio's platform. + tags: + - NumbersV2HostedNumberOrder + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v2.hosted_number_order' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + bulk_hosting_request_sid: 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' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateHostedNumberOrder + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateHostedNumberOrderRequest + properties: + PhoneNumber: + type: string + format: phone-number + description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) + format + ContactPhoneNumber: + type: string + format: phone-number + description: The contact phone number of the person authorized to + sign the Authorization Document. + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: Optional. A 34 character string that uniquely identifies + the Address resource that represents the address of the owner + of this phone number. + Email: + type: string + description: Optional. Email of the owner of this phone number that + is being hosted. + AccountSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + description: This defaults to the AccountSid of the authorization + the user is using. This can be provided to specify a subaccount + to add the HostedNumberOrder to. + FriendlyName: + type: string + description: A 128 character string that is a human readable text + that describes this resource. + CcEmails: + type: array + items: + type: string + description: Optional. A list of emails that the LOA document for + this HostedNumberOrder will be carbon copied to. + SmsUrl: + type: string + format: uri + description: The URL that Twilio should request when somebody sends + an SMS to the phone number. This will be copied onto the IncomingPhoneNumber + resource. + SmsMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: The HTTP method that should be used to request the + SmsUrl. Must be either `GET` or `POST`. This will be copied onto + the IncomingPhoneNumber resource. + SmsFallbackUrl: + type: string + format: uri + description: A URL that Twilio will request if an error occurs requesting + or executing the TwiML defined by SmsUrl. This will be copied + onto the IncomingPhoneNumber resource. + SmsCapability: + type: boolean + description: Used to specify that the SMS capability will be hosted + on Twilio's platform. + SmsFallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: The HTTP method that should be used to request the + SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied + onto the IncomingPhoneNumber resource. + StatusCallbackUrl: + type: string + format: uri + description: Optional. The Status Callback URL attached to the IncomingPhoneNumber + resource. + StatusCallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: Optional. The Status Callback Method attached to the + IncomingPhoneNumber resource. + SmsApplicationSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AP[0-9a-fA-F]{32}$ + description: Optional. The 34 character sid of the application Twilio + should use to handle SMS messages sent to this number. If a `SmsApplicationSid` + is present, Twilio will ignore all of the SMS urls above and use + those set on the application. + ContactTitle: + type: string + description: The title of the person authorized to sign the Authorization + Document for this phone number. + required: + - PhoneNumber + - ContactPhoneNumber + - AddressSid + - Email + examples: + create: + value: + AddressSid: AD11111111111111111111111111111111 + PhoneNumber: '+14153608311' + ContactPhoneNumber: '+12344444444' + ContactTitle: contact_title_test + Email: test@twilio.com + createWithoutOptionalLoaFields: + value: + PhoneNumber: '+14153608311' + ContactPhoneNumber: '+12344444444' + Email: test@twilio.com + AddressSid: AD11111111111111111111111111111111 /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /RegulatoryCompliance/Bundles/{Sid} + pathType: list post: description: Create a new Assigned Item. + tags: + - NumbersV2ItemAssignment parameters: - name: BundleSid in: path @@ -1531,12 +3966,19 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment' + examples: + create: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateItemAssignment - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1553,8 +3995,14 @@ paths: the different items. required: - ObjectSid + examples: + create: + value: + ObjectSid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Assigned Items for an account. + tags: + - NumbersV2ItemAssignment parameters: - name: BundleSid in: path @@ -1597,45 +4045,74 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListItemAssignment - x-maturity: - - GA /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /RegulatoryCompliance/Bundles/{Sid} + pathType: instance get: description: Fetch specific Assigned Item Instance. + tags: + - NumbersV2ItemAssignment parameters: - name: BundleSid in: path @@ -1661,14 +4138,23 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment' + examples: + fetch: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchItemAssignment - x-maturity: - - GA delete: description: Remove an Assignment Item Instance. + tags: + - NumbersV2ItemAssignment parameters: - name: BundleSid in: path @@ -1694,20 +4180,20 @@ paths: security: - accountSid_authToken: [] operationId: DeleteItemAssignment - x-maturity: - - GA /v2/RegulatoryCompliance/Regulations: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /RegulatoryCompliance + pathType: list get: description: Retrieve a list of all Regulations. + tags: + - NumbersV2Regulation parameters: - name: EndUserType in: query @@ -1716,16 +4202,25 @@ paths: schema: type: string $ref: '#/components/schemas/regulation_enum_end_user_type' + examples: + readEmpty: + value: business - name: IsoCountry in: query description: The ISO country code of the phone number's country. schema: type: string + examples: + readEmpty: + value: US - name: NumberType in: query description: The type of phone number that the regulatory requiremnt is restricting. schema: type: string + examples: + readEmpty: + value: mobile - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1758,46 +4253,109 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.regulation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=US&EndUserType=business&NumberType=mobile&PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=US&EndUserType=business&NumberType=mobile&PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 'Australia: Local - Individual' + iso_country: AU + number_type: local + end_user_type: individual + requirements: + end_user: + - name: Individual + type: individual + 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 description: OK security: - accountSid_authToken: [] operationId: ListRegulation - x-maturity: - - GA /v2/RegulatoryCompliance/Regulations/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /RegulatoryCompliance + pathType: instance get: description: Fetch specific Regulation Instance. + tags: + - NumbersV2Regulation parameters: - name: Sid in: path @@ -1814,32 +4372,75 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.regulation' + examples: + fetch: + value: + sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 'Australia: Local - Individual' + iso_country: AU + number_type: local + end_user_type: individual + requirements: + end_user: + - name: Individual + type: individual + 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 description: OK security: - accountSid_authToken: [] operationId: FetchRegulation - x-maturity: - - GA /v2/RegulatoryCompliance: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: list /v2/RegulatoryCompliance/Bundles/{BundleSid}/ReplaceItems: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /RegulatoryCompliance/Bundles/{Sid} className: replace_items + pathType: list post: description: Replaces all bundle items in the target bundle (specified in the path) with all the bundle items of the source bundle (specified by the from_bundle_sid body param) + tags: + - NumbersV2ReplaceItems parameters: - name: BundleSid in: path @@ -1857,12 +4458,23 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.replace_items' + examples: + create: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + valid_until: '2015-07-30T20:00:00Z' + email: email + status_callback: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: Created security: - accountSid_authToken: [] operationId: CreateReplaceItems - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1879,30 +4491,50 @@ paths: from. required: - FromBundleSid + examples: + create: + value: + FromBundleSid: BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb /v2/RegulatoryCompliance/SupportingDocuments: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /RegulatoryCompliance + pathType: list post: description: Create a new Supporting Document. + tags: + - NumbersV2SupportingDocument responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' + examples: + create: + value: + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + mime_type: mime_type + status: draft + failure_reason: null + type: type + attributes: + first_name: foo + last_name: bar + date_created: '2019-07-31T02:11:52Z' + date_updated: '2019-07-31T02:11:52Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSupportingDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1923,8 +4555,16 @@ paths: required: - FriendlyName - Type + examples: + create: + value: + FriendlyName: friendly_name + Type: type + Attributes: '{}' get: description: Retrieve a list of all Supporting Document for an account. + tags: + - NumbersV2SupportingDocument parameters: - name: PageSize in: query @@ -1958,46 +4598,106 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + mime_type: mime_type + status: draft + failure_reason: null + type: type + attributes: + first_name: foo + last_name: bar + date_created: '2019-07-31T02:11:52Z' + date_updated: '2019-07-31T02:11:52Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + next_page_url: null + key: results + readRejectedDocument: + value: + results: + - sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + mime_type: mime_type + status: twilio-rejected + failure_reason: Some failure reason. + type: type + attributes: + first_name: foo + last_name: bar + date_created: '2019-07-31T02:11:52Z' + date_updated: '2019-07-31T02:11:52Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocument - x-maturity: - - GA /v2/RegulatoryCompliance/SupportingDocuments/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /RegulatoryCompliance + pathType: instance get: description: Fetch specific Supporting Document Instance. + tags: + - NumbersV2SupportingDocument parameters: - name: Sid in: path @@ -2015,14 +4715,30 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' + examples: + fetch: + value: + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + mime_type: mime_type + status: draft + failure_reason: null + type: type + attributes: + first_name: foo + last_name: bar + date_created: '2019-07-31T02:11:52Z' + date_updated: '2019-07-31T02:11:52Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocument - x-maturity: - - GA post: description: Update an existing Supporting Document. + tags: + - NumbersV2SupportingDocument parameters: - name: Sid in: path @@ -2040,12 +4756,26 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' + examples: + update: + value: + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + mime_type: mime_type + status: draft + failure_reason: null + type: type + attributes: + first_name: foo + last_name: bar + date_created: '2019-07-31T02:11:52Z' + date_updated: '2019-07-31T02:11:52Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSupportingDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2060,8 +4790,15 @@ paths: description: The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types. + examples: + update: + value: + FriendlyName: friendly_name + Attributes: '{}' delete: description: Delete a specific Supporting Document. + tags: + - NumbersV2SupportingDocument parameters: - name: Sid in: path @@ -2079,20 +4816,20 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSupportingDocument - x-maturity: - - GA /v2/RegulatoryCompliance/SupportingDocumentTypes: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /RegulatoryCompliance + pathType: list get: description: Retrieve a list of all Supporting Document Types. + tags: + - NumbersV2SupportingDocumentType parameters: - name: PageSize in: query @@ -2126,46 +4863,77 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + supporting_document_types: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 + next_page_url: null + key: supporting_document_types + readFull: + value: + supporting_document_types: + - sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Passport + machine_name: passport + fields: + - friendly_name: Last Name + machine_name: last_name + constraint: String + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 + next_page_url: null + key: supporting_document_types description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocumentType - x-maturity: - - GA /v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /RegulatoryCompliance + pathType: instance get: description: Fetch a specific Supporting Document Type Instance. + tags: + - NumbersV2SupportingDocumentType parameters: - name: Sid in: path @@ -2180,17 +4948,37 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document_type' + examples: + fetch: + value: + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Passport + machine_name: passport + fields: + - friendly_name: Last Name + machine_name: last_name + constraint: String + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocumentType - x-maturity: - - GA servers: - url: https://numbers.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: NumbersV2AuthorizationDocument +- name: NumbersV2BulkHostedNumberOrder +- name: NumbersV2Bundle +- name: NumbersV2BundleCopy +- name: NumbersV2DependentHostedNumberOrder +- name: NumbersV2EndUser +- name: NumbersV2EndUserType +- name: NumbersV2Evaluation +- name: NumbersV2HostedNumberOrder +- name: NumbersV2ItemAssignment +- name: NumbersV2Regulation +- name: NumbersV2ReplaceItems +- name: NumbersV2SupportingDocument +- name: NumbersV2SupportingDocumentType +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_oauth_v1.yaml b/spec/yaml/twilio_oauth_v1.yaml deleted file mode 100644 index 456c5b4a..00000000 --- a/spec/yaml/twilio_oauth_v1.yaml +++ /dev/null @@ -1,406 +0,0 @@ -components: - schemas: - oauth.v1.certs: - type: object - properties: - keys: - nullable: true - description: A collection of certificates where are signed Twilio-issued - tokens. - url: - type: string - format: uri - nullable: true - oauth.v1.device_code: - type: object - properties: - device_code: - type: string - nullable: true - description: The device verification code. - user_code: - type: string - nullable: true - description: The verification code which end user uses to verify authorization - request. - verification_uri: - type: string - nullable: true - description: The URI that the end user visits to verify authorization request. - verification_uri_complete: - type: string - nullable: true - description: The URI with user_code that the end-user alternatively visits - to verify authorization request. - expires_in: - type: integer - format: int64 - nullable: true - description: The expiration time of the device_code and user_code in seconds. - interval: - type: integer - nullable: true - description: The minimum amount of time in seconds that the client should - wait between polling requests to the token endpoint. - oauth.v1.openid_discovery: - type: object - properties: - issuer: - type: string - format: uri - nullable: true - description: The URL of the party that will create the token and sign it - with its private key. - authorization_endpoint: - type: string - format: uri - nullable: true - description: The endpoint that validates all authorization requests. - device_authorization_endpoint: - type: string - format: uri - nullable: true - description: The endpoint that validates all device code related authorization - requests. - token_endpoint: - type: string - format: uri - nullable: true - description: The URL of the token endpoint. After a client has received - an authorization code, that code is presented to the token endpoint and - exchanged for an identity token, an access token, and a refresh token. - userinfo_endpoint: - type: string - format: uri - nullable: true - description: The URL of the user info endpoint, which returns user profile - information to a client. Keep in mind that the user info endpoint returns - only the information that has been requested. - revocation_endpoint: - type: string - format: uri - nullable: true - description: The endpoint used to revoke access or refresh tokens issued - by the authorization server. - jwk_uri: - type: string - format: uri - nullable: true - description: The URL of your JSON Web Key Set. This set is a collection - of JSON Web Keys, a standard method for representing cryptographic keys - in a JSON structure. - response_type_supported: - type: array - items: - type: string - nullable: true - description: A collection of response type supported by authorization server. - subject_type_supported: - type: array - items: - type: string - nullable: true - description: A collection of subject by authorization server. - id_token_signing_alg_values_supported: - type: array - items: - type: string - nullable: true - description: A collection of JWS signing algorithms supported by authorization - server to sign identity token. - scopes_supported: - type: array - items: - type: string - nullable: true - description: A collection of scopes supported by authorization server for - identity token - claims_supported: - type: array - items: - type: string - nullable: true - description: A collection of claims supported by authorization server for - identity token - url: - type: string - format: uri - nullable: true - oauth.v1.token: - type: object - properties: - access_token: - type: string - nullable: true - description: Token which carries the necessary information to access a Twilio - resource directly. - refresh_token: - type: string - nullable: true - description: Token which carries the information necessary to get a new - access token. - id_token: - type: string - nullable: true - refresh_token_expires_at: - type: string - format: date-time - nullable: true - description: The date and time in GMT when the refresh token expires in - [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - access_token_expires_at: - type: string - format: date-time - nullable: true - description: The date and time in GMT when the refresh token expires in - [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - oauth.v1.user_info: - type: object - properties: - user_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^US[0-9a-fA-F]{32}$ - nullable: true - description: The URL of the party that will create the token and sign it - with its private key. - first_name: - type: string - nullable: true - description: The first name of the end-user. - last_name: - type: string - nullable: true - description: The last name of the end-user. - friendly_name: - type: string - nullable: true - description: The friendly name of the end-user. - email: - type: string - nullable: true - description: The end-user's preferred email address. - url: - type: string - format: uri - nullable: true - securitySchemes: - accountSid_authToken: - type: http - scheme: basic -info: - title: Twilio - Oauth - description: This is the public Twilio REST API. - termsOfService: https://www.twilio.com/legal/tos - contact: - name: Twilio Support - url: https://support.twilio.com - email: support@twilio.com - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 -openapi: 3.0.1 -paths: - /v1/certs: - servers: - - url: https://oauth.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - keys - pathType: instance - mountName: oauth - get: - description: Fetches public JWKs - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/oauth.v1.certs' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchCerts - x-maturity: - - GA - /v1/device/code: - servers: - - url: https://oauth.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - device_code - - user_code - - verification_uri - - verification_uri_complete - - expires_in - - interval - pathType: list - mountName: device_code - post: - description: Issues a new Access token (optionally identity_token & refresh_token) - in exchange of Oauth grant - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/oauth.v1.device_code' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeviceCode - x-maturity: - - GA - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateDeviceCodeRequest - properties: - ClientSid: - type: string - description: A 34 character string that uniquely identifies this - OAuth App. - Scopes: - type: array - items: - type: string - description: An Array of scopes for authorization request - Audiences: - type: array - items: - type: string - description: An array of intended audiences for token requests - required: - - ClientSid - - Scopes - /v1/.well-known/openid-configuration: - servers: - - url: https://oauth.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - issuer - - authorization_endpoint - - device_authorization_endpoint - - token_endpoint - - userinfo_endpoint - - revocation_endpoint - - jwk_uri - - response_type_supported - - subject_type_supported - - id_token_signing_alg_values_supported - - scopes_supported - - claims_supported - pathType: instance - mountName: openid_discovery - get: - description: Fetch configuration details about the OpenID Connect Authorization - Server - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/oauth.v1.openid_discovery' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchOpenidDiscovery - x-maturity: - - GA - /v1/token: - servers: - - url: https://oauth.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - access_token - - access_token_expires_at - pathType: list - post: - description: Issues a new Access token (optionally identity_token & refresh_token) - in exchange of Oauth grant - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/oauth.v1.token' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateToken - x-maturity: - - GA - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateTokenRequest - properties: - GrantType: - type: string - description: Grant type is a credential representing resource owner's - authorization which can be used by client to obtain access token. - ClientSid: - type: string - description: A 34 character string that uniquely identifies this - OAuth App. - ClientSecret: - type: string - description: The credential for confidential OAuth App. - Code: - type: string - description: JWT token related to the authorization code grant type. - CodeVerifier: - type: string - description: A code which is generation cryptographically. - DeviceCode: - type: string - description: JWT token related to the device code grant type. - RefreshToken: - type: string - description: JWT token related to the refresh token grant type. - DeviceId: - type: string - description: The Id of the device associated with the token (refresh - token). - required: - - GrantType - - ClientSid - /v1/userinfo: - servers: - - url: https://oauth.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - user_sid - pathType: instance - mountName: user_info - get: - description: Retrieves the consented UserInfo and other claims about the logged-in - subject (end-user). - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/oauth.v1.user_info' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUserInfo - x-maturity: - - GA -servers: -- url: https://oauth.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_preview.yaml b/spec/yaml/twilio_preview.yaml index 7f46fd50..d0262467 100644 --- a/spec/yaml/twilio_preview.yaml +++ b/spec/yaml/twilio_preview.yaml @@ -1,379 +1,265 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: - preview.deployed_devices.fleet.certificate: + preview.hosted_numbers.authorization_document: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - nullable: true - description: Contains a 34 character string that uniquely identifies this - Certificate credential resource. - url: - type: string - format: uri - nullable: true - description: Contains an absolute URL for this Certificate credential resource. - friendly_name: - type: string - nullable: true - description: Contains a human readable descriptive text for this Certificate - credential, up to 256 characters long. - fleet_sid: - type: string + pattern: ^PX[0-9a-fA-F]{32}$ nullable: true - description: Specifies the unique string identifier of the Fleet that the - given Certificate credential belongs to. - account_sid: + description: A 34 character string that uniquely identifies this AuthorizationDocument. + address_sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: Specifies the unique string identifier of the Account responsible - for this Certificate credential. - device_sid: + description: A 34 character string that uniquely identifies the Address + resource that is associated with this AuthorizationDocument. + status: type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ + $ref: '#/components/schemas/authorization_document_enum_status' nullable: true - description: Specifies the unique string identifier of a Device authenticated - with this Certificate credential. - thumbprint: + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + email: type: string nullable: true - description: Contains a unique hash of the payload of this Certificate credential, - used to authenticate the Device. + description: Email that this AuthorizationDocument will be sent to for signing. + x-twilio: + pii: + handling: standard + deleteSla: 30 + cc_emails: + type: array + items: + type: string + nullable: true + description: Email recipients who will be informed when an Authorization + Document has been sent and signed. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time nullable: true - description: Specifies the date this Certificate credential was created, - given in UTC ISO 8601 format. + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. date_updated: type: string format: date-time nullable: true - description: Specifies the date this Certificate credential was last updated, - given in UTC ISO 8601 format. - preview.deployed_devices.fleet.deployment: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - nullable: true - description: Contains a 34 character string that uniquely identifies this - Deployment resource. + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true - description: Contains an absolute URL for this Deployment resource. - friendly_name: - type: string + links: + type: object + format: uri-map nullable: true - description: Contains a human readable descriptive text for this Deployment, - up to 64 characters long - fleet_sid: + authorization_document_enum_status: + type: string + enum: + - opened + - signing + - signed + - canceled + - failed + preview.hosted_numbers.authorization_document.dependent_hosted_number_order: + type: object + properties: + sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ nullable: true - description: Specifies the unique string identifier of the Fleet that the - given Deployment belongs to. + description: A 34 character string that uniquely identifies this Authorization + Document account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Specifies the unique string identifier of the Account responsible - for this Deployment. - sync_service_sid: + description: The unique SID identifier of the Account. + incoming_phone_number_sid: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - nullable: true - description: Specifies the unique string identifier of the Twilio Sync service - instance linked to and accessible by this Deployment. - date_created: - type: string - format: date-time + pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: Specifies the date this Deployment was created, given in UTC - ISO 8601 format. - date_updated: + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + address_sid: type: string - format: date-time + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: Specifies the date this Deployment was last updated, given - in UTC ISO 8601 format. - preview.deployed_devices.fleet.device: - type: object - properties: - sid: + description: A 34 character string that uniquely identifies the Address + resource that represents the address of the owner of this phone number. + signing_document_sid: type: string minLength: 34 maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ + pattern: ^PX[0-9a-fA-F]{32}$ nullable: true - description: Contains a 34 character string that uniquely identifies this - Device resource. - url: + description: A 34 character string that uniquely identifies the LOA document + associated with this HostedNumberOrder. + phone_number: type: string - format: uri + format: phone-number nullable: true - description: Contains an absolute URL for this Device resource. - unique_name: - type: string + description: An E164 formatted phone number hosted by this HostedNumberOrder. + capabilities: + type: object + format: phone-number-capabilities + properties: + mms: + type: boolean + sms: + type: boolean + voice: + type: boolean + fax: + type: boolean nullable: true - description: Contains a unique and addressable name of this Device, assigned - by the developer, up to 128 characters long. + description: A mapping of capabilities this hosted phone number will have + enabled on Twilio's platform. friendly_name: type: string nullable: true - description: Contains a human readable descriptive text for this Device, - up to 256 characters long - fleet_sid: - type: string - nullable: true - description: Specifies the unique string identifier of the Fleet that the - given Device belongs to. - enabled: - type: boolean - nullable: true - description: Contains a boolean flag indicating whether the device is enabled - or not, blocks device connectivity if set to false. - account_sid: + description: A human readable description of this resource, up to 64 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 + unique_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Specifies the unique string identifier of the Account responsible - for this Device. - identity: + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in + addition to SID. + x-twilio: + pii: + handling: standard + deleteSla: 30 + status: type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' nullable: true - description: Contains an arbitrary string identifier representing a human - user associated with this Device, assigned by the developer, up to 256 - characters long. - deployment_sid: + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + failure_reason: type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ nullable: true - description: Specifies the unique string identifier of the Deployment group - that this Device is associated with. + description: A message that explains why a hosted_number_order went to status + "action-required" date_created: type: string format: date-time nullable: true - description: Specifies the date this Device was created, given in UTC ISO - 8601 format. + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. date_updated: type: string format: date-time nullable: true - description: Specifies the date this Device was last updated, given in UTC - ISO 8601 format. - date_authenticated: + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + verification_attempts: + type: integer + nullable: true + description: The number of attempts made to verify ownership of the phone + number that is being hosted. + email: type: string - format: date-time nullable: true - description: Specifies the date this Device was last authenticated, given - in UTC ISO 8601 format. - preview.deployed_devices.fleet: - type: object - properties: - sid: + description: Email of the owner of this phone number that is being hosted. + x-twilio: + pii: + handling: standard + deleteSla: 30 + cc_emails: + type: array + items: + type: string + nullable: true + description: Email recipients who will be informed when an Authorization + Document has been sent and signed + x-twilio: + pii: + handling: standard + deleteSla: 30 + verification_type: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_verification_type' + nullable: true + description: The method used for verifying ownership of the number to be + hosted. One of phone-call (default) or phone-bill. + verification_document_sid: type: string minLength: 34 maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ + pattern: ^RI[0-9a-fA-F]{32}$ nullable: true - description: Contains a 34 character string that uniquely identifies this - Fleet resource. - url: + description: A 34 character string that uniquely identifies the Identity + Document resource that represents the document for verifying ownership + of the number to be hosted. + extension: type: string - format: uri nullable: true - description: Contains an absolute URL for this Fleet resource. - unique_name: - type: string - nullable: true - description: Contains a unique and addressable name of this Fleet, e.g. - 'default', up to 128 characters long. - friendly_name: - type: string - nullable: true - description: Contains a human readable descriptive text for this Fleet, - up to 256 characters long. - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: Speicifies the unique string identifier of the Account responsible - for this Fleet. - default_deployment_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - nullable: true - description: Contains the string identifier of the automatically provisioned - default Deployment of this Fleet. - date_created: - type: string - format: date-time - nullable: true - description: Specifies the date this Fleet was created, given in UTC ISO - 8601 format. - date_updated: - type: string - format: date-time - nullable: true - description: Specifies the date this Fleet was last updated, given in UTC - ISO 8601 format. - links: - type: object - format: uri-map - nullable: true - description: Contains a dictionary of URL links to nested resources of this - Fleet. - preview.deployed_devices.fleet.key: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - nullable: true - description: Contains a 34 character string that uniquely identifies this - Key credential resource. - url: - type: string - format: uri - nullable: true - description: Contains an absolute URL for this Key credential resource. - friendly_name: - type: string - nullable: true - description: Contains a human readable descriptive text for this Key credential, - up to 256 characters long. - fleet_sid: - type: string - nullable: true - description: Specifies the unique string identifier of the Fleet that the - given Key credential belongs to. - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: Specifies the unique string identifier of the Account responsible - for this Key credential. - device_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - nullable: true - description: Specifies the unique string identifier of a Device authenticated - with this Key credential. - secret: - type: string - nullable: true - description: Contains the automatically generated secret belonging to this - Key credential, used to authenticate the Device. - date_created: - type: string - format: date-time - nullable: true - description: Specifies the date this Key credential was created, given in - UTC ISO 8601 format. - date_updated: - type: string - format: date-time - nullable: true - description: Specifies the date this Key credential was last updated, given - in UTC ISO 8601 format. - preview.hosted_numbers.authorization_document: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies this AuthorizationDocument. - address_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the Address - resource that is associated with this AuthorizationDocument. - status: - type: string - $ref: '#/components/schemas/authorization_document_enum_status' + description: A numerical extension to be used when making the ownership + verification call. + call_delay: + type: integer nullable: true - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - email: + description: A value between 0-30 specifying the number of seconds to delay + initiating the ownership verification call. + verification_code: type: string nullable: true - description: Email that this AuthorizationDocument will be sent to for signing. - cc_emails: + description: The digits passed during the ownership verification call. + verification_call_sids: type: array items: type: string nullable: true - description: Email recipients who will be informed when an Authorization - Document has been sent and signed. - date_created: - type: string - format: date-time - nullable: true - description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) - format. - date_updated: - type: string - format: date-time - nullable: true - description: The date that this resource was updated, given as [GMT RFC - 2822](http://www.ietf.org/rfc/rfc2822.txt) format. - url: - type: string - format: uri - nullable: true - links: - type: object - format: uri-map - nullable: true - authorization_document_enum_status: + description: A list of 34 character strings that are unique identifiers + for the calls placed as part of ownership verification. + dependent_hosted_number_order_enum_status: type: string enum: - - opened - - signing - - signed - - canceled + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed - failed - preview.hosted_numbers.authorization_document.dependent_hosted_number_order: + - action-required + dependent_hosted_number_order_enum_verification_type: + type: string + enum: + - phone-call + - phone-bill + preview.hosted_numbers.hosted_number_order: type: object properties: sid: @@ -382,23 +268,22 @@ components: maxLength: 34 pattern: ^HR[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies this Authorization - Document + description: A 34 character string that uniquely identifies this HostedNumberOrder. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Account. + description: A 34 character string that uniquely identifies the account. incoming_phone_number_sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. + description: A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) + resource that represents the phone number being hosted. address_sid: type: string minLength: 34 @@ -413,13 +298,15 @@ components: maxLength: 34 pattern: ^PX[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the LOA document - associated with this HostedNumberOrder. + description: A 34 character string that uniquely identifies the [Authorization + Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) + the user needs to sign. phone_number: type: string format: phone-number nullable: true - description: An E164 formatted phone number hosted by this HostedNumberOrder. + description: Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) + format, e.g., +16175551212 capabilities: type: object format: phone-number-capabilities @@ -433,26 +320,36 @@ components: fax: type: boolean nullable: true - description: A mapping of capabilities this hosted phone number will have - enabled on Twilio's platform. + description: Set of booleans describing the capabilities hosted on Twilio's + platform. SMS is currently only supported. friendly_name: type: string nullable: true - description: A human readable description of this resource, up to 64 characters. + description: A 64 character string that is a human-readable text that describes + this resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 unique_name: type: string nullable: true description: Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID. + x-twilio: + pii: + handling: standard + deleteSla: 30 status: type: string - $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + $ref: '#/components/schemas/hosted_number_order_enum_status' nullable: true - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' + description: 'Status of this resource. It can hold one of the values: 1. + Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, + 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders + Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values) + section for more information on each of these statuses.' failure_reason: type: string nullable: true @@ -479,19 +376,32 @@ components: type: string nullable: true description: Email of the owner of this phone number that is being hosted. + x-twilio: + pii: + handling: standard + deleteSla: 30 cc_emails: type: array items: type: string nullable: true - description: Email recipients who will be informed when an Authorization - Document has been sent and signed + description: A list of emails that LOA document for this HostedNumberOrder + will be carbon copied to. + x-twilio: + pii: + handling: standard + deleteSla: 30 + url: + type: string + format: uri + nullable: true + description: The URL of this HostedNumberOrder. verification_type: type: string - $ref: '#/components/schemas/dependent_hosted_number_order_enum_verification_type' + $ref: '#/components/schemas/hosted_number_order_enum_verification_type' nullable: true - description: The method used for verifying ownership of the number to be - hosted. One of phone-call (default) or phone-bill. + description: The type of ownership verification required to move the number + to a `verified` state. The verification methods are `phone-call` or `phone-bill`. verification_document_sid: type: string minLength: 34 @@ -514,7 +424,8 @@ components: verification_code: type: string nullable: true - description: The digits passed during the ownership verification call. + description: A verification code provided in the response for a user to + enter when they pick up the phone call. verification_call_sids: type: array items: @@ -522,7 +433,7 @@ components: nullable: true description: A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification. - dependent_hosted_number_order_enum_status: + hosted_number_order_enum_status: type: string enum: - received @@ -534,202 +445,27 @@ components: - completed - failed - action-required - dependent_hosted_number_order_enum_verification_type: + hosted_number_order_enum_verification_type: type: string enum: - phone-call - phone-bill - preview.hosted_numbers.hosted_number_order: + preview.marketplace.available_add_on: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ + pattern: ^XB[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies this HostedNumberOrder. - account_sid: + description: The unique string that we created to identify the AvailableAddOn + resource. + friendly_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the account. - incoming_phone_number_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/api/rest/incoming-phone-numbers) - resource that represents the phone number being hosted. - address_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the Address - resource that represents the address of the owner of this phone number. - signing_document_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the [Authorization - Document](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents) - the user needs to sign. - phone_number: - type: string - format: phone-number - nullable: true - description: Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) - format, e.g., +16175551212 - capabilities: - type: object - format: phone-number-capabilities - properties: - mms: - type: boolean - sms: - type: boolean - voice: - type: boolean - fax: - type: boolean - nullable: true - description: Set of booleans describing the capabilities hosted on Twilio's - platform. SMS is currently only supported. - friendly_name: - type: string - nullable: true - description: A 64 character string that is a human-readable text that describes - this resource. - unique_name: - type: string - nullable: true - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in - addition to SID. - status: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' - nullable: true - description: 'Status of this resource. It can hold one of the values: 1. - Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, - 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders - Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-numbers#status-values) - section for more information on each of these statuses.' - failure_reason: - type: string - nullable: true - description: A message that explains why a hosted_number_order went to status - "action-required" - date_created: - type: string - format: date-time - nullable: true - description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) - format. - date_updated: - type: string - format: date-time - nullable: true - description: The date that this resource was updated, given as [GMT RFC - 2822](http://www.ietf.org/rfc/rfc2822.txt) format. - verification_attempts: - type: integer - nullable: true - description: The number of attempts made to verify ownership of the phone - number that is being hosted. - email: - type: string - nullable: true - description: Email of the owner of this phone number that is being hosted. - cc_emails: - type: array - items: - type: string - nullable: true - description: A list of emails that LOA document for this HostedNumberOrder - will be carbon copied to. - url: - type: string - format: uri - nullable: true - description: The URL of this HostedNumberOrder. - verification_type: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_verification_type' - nullable: true - description: The type of ownership verification required to move the number - to a `verified` state. The verification methods are `phone-call` or `phone-bill`. - verification_document_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the Identity - Document resource that represents the document for verifying ownership - of the number to be hosted. - extension: - type: string - nullable: true - description: A numerical extension to be used when making the ownership - verification call. - call_delay: - type: integer - nullable: true - description: A value between 0-30 specifying the number of seconds to delay - initiating the ownership verification call. - verification_code: - type: string - nullable: true - description: A verification code provided in the response for a user to - enter when they pick up the phone call. - verification_call_sids: - type: array - items: - type: string - nullable: true - description: A list of 34 character strings that are unique identifiers - for the calls placed as part of ownership verification. - hosted_number_order_enum_status: - type: string - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - hosted_number_order_enum_verification_type: - type: string - enum: - - phone-call - - phone-bill - preview.marketplace.available_add_on: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the AvailableAddOn - resource. - friendly_name: - type: string - nullable: true - description: The string that you assigned to describe the resource. - description: + 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. @@ -888,17 +624,14 @@ components: format: uri nullable: true description: The absolute URL of the resource. - preview.sync.service.document: + preview.wireless.command: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^ET[0-9a-fA-F]{32}$ - nullable: true - unique_name: - type: string + pattern: ^DC[0-9a-fA-F]{32}$ nullable: true account_sid: type: string @@ -906,24 +639,29 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - service_sid: + device_sid: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - url: + sim_sid: type: string - format: uri + minLength: 34 + maxLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - links: - type: object - format: uri-map + command: + type: string nullable: true - revision: + command_mode: type: string nullable: true - data: + status: + type: string + nullable: true + direction: + type: string nullable: true date_created: type: string @@ -933,67 +671,77 @@ components: type: string format: date-time nullable: true - created_by: + url: type: string + format: uri nullable: true - preview.sync.service.document.document_permission: + preview.wireless.rate_plan: type: object properties: - account_sid: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^WP[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Twilio Account. - service_sid: + unique_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Sync Service Instance. - document_sid: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^ET[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Sync Document to which the - Permission applies. - identity: + friendly_name: type: string nullable: true - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - read: + data_enabled: type: boolean nullable: true - description: Boolean flag specifying whether the identity can read the Sync - Document. - write: + data_metering: + type: string + nullable: true + data_limit: + type: integer + nullable: true + messaging_enabled: type: boolean nullable: true - description: Boolean flag specifying whether the identity can update the - Sync Document. - manage: + voice_enabled: type: boolean nullable: true - description: Boolean flag specifying whether the identity can delete the - Sync Document. + national_roaming_enabled: + type: boolean + nullable: true + international_roaming: + type: array + items: + type: string + nullable: true + date_created: + type: string + format: date-time + nullable: true + date_updated: + type: string + format: date-time + nullable: true url: type: string format: uri nullable: true - description: Contains an absolute URL for this Sync Document Permission. - preview.sync.service: + preview.wireless.sim: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^DE[0-9a-fA-F]{32}$ + nullable: true + unique_name: + type: string nullable: true account_sid: type: string @@ -1001,69 +749,90 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + rate_plan_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WP[0-9a-fA-F]{32}$ + nullable: true friendly_name: type: string nullable: true - date_created: + iccid: type: string - format: date-time nullable: true - date_updated: + e_id: type: string - format: date-time nullable: true - url: + status: type: string - format: uri nullable: true - webhook_url: + commands_callback_url: type: string format: uri nullable: true - reachability_webhooks_enabled: - type: boolean - nullable: true - acl_enabled: - type: boolean + commands_callback_method: + type: string nullable: true - links: - type: object - format: uri-map + sms_fallback_method: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE nullable: true - preview.sync.service.sync_list: - type: object - properties: - sid: + sms_fallback_url: type: string - minLength: 34 - maxLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ + format: uri nullable: true - unique_name: + sms_method: type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE nullable: true - account_sid: + sms_url: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + format: uri nullable: true - service_sid: + voice_fallback_method: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE nullable: true - url: + voice_fallback_url: type: string format: uri nullable: true - links: - type: object - format: uri-map + voice_method: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE nullable: true - revision: + voice_url: type: string + format: uri nullable: true date_created: type: string @@ -1073,640 +842,597 @@ components: type: string format: date-time nullable: true - created_by: + url: type: string + format: uri nullable: true - preview.sync.service.sync_list.sync_list_item: + links: + type: object + format: uri-map + nullable: true + preview.wireless.sim.usage: type: object properties: - index: - type: integer - nullable: true - account_sid: + sim_sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - service_sid: + sim_unique_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - list_sid: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + period: + nullable: true + commands_usage: + nullable: true + commands_costs: + nullable: true + data_usage: + nullable: true + data_costs: nullable: true url: type: string format: uri nullable: true - revision: + preview.deployed_devices.fleet.certificate: + type: object + properties: + sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ nullable: true - data: - nullable: true - date_created: + description: Contains a 34 character string that uniquely identifies this + Certificate credential resource. + url: type: string - format: date-time + format: uri nullable: true - date_updated: + description: Contains an absolute URL for this Certificate credential resource. + friendly_name: type: string - format: date-time nullable: true - created_by: + description: Contains a human readable descriptive text for this Certificate + credential, up to 256 characters long. + fleet_sid: type: string nullable: true - sync_list_item_enum_query_result_order: - type: string - enum: - - asc - - desc - sync_list_item_enum_query_from_bound_type: - type: string - enum: - - inclusive - - exclusive - preview.sync.service.sync_list.sync_list_permission: - type: object - properties: + description: Specifies the unique string identifier of the Fleet that the + given Certificate credential belongs to. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Twilio Account. - service_sid: + description: Specifies the unique string identifier of the Account responsible + for this Certificate credential. + device_sid: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Sync Service Instance. - list_sid: + description: Specifies the unique string identifier of a Device authenticated + with this Certificate credential. + thumbprint: type: string - minLength: 34 - maxLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Sync List to which the Permission - applies. - identity: + description: Contains a unique hash of the payload of this Certificate credential, + used to authenticate the Device. + date_created: type: string + format: date-time nullable: true - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - read: - type: boolean - nullable: true - description: Boolean flag specifying whether the identity can read the Sync - List and its Items. - write: - type: boolean - nullable: true - description: Boolean flag specifying whether the identity can create, update - and delete Items of the Sync List. - manage: - type: boolean - nullable: true - description: Boolean flag specifying whether the identity can delete the - Sync List. - url: + description: Specifies the date this Certificate credential was created, + given in UTC ISO 8601 format. + date_updated: type: string - format: uri + format: date-time nullable: true - description: Contains an absolute URL for this Sync List Permission. - preview.sync.service.sync_map: + description: Specifies the date this Certificate credential was last updated, + given in UTC ISO 8601 format. + preview.deployed_devices.fleet.deployment: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ + pattern: ^DL[0-9a-fA-F]{32}$ nullable: true - unique_name: + description: Contains a 34 character string that uniquely identifies this + Deployment resource. + url: + type: string + format: uri + nullable: true + description: Contains an absolute URL for this Deployment resource. + friendly_name: + type: string + nullable: true + description: Contains a human readable descriptive text for this Deployment, + up to 64 characters long + fleet_sid: type: string nullable: true + description: Specifies the unique string identifier of the Fleet that the + given Deployment belongs to. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - service_sid: + description: Specifies the unique string identifier of the Account responsible + for this Deployment. + sync_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - url: + description: Specifies the unique string identifier of the Twilio Sync service + instance linked to and accessible by this Deployment. + date_created: type: string - format: uri + format: date-time nullable: true - links: - type: object - format: uri-map + description: Specifies the date this Deployment was created, given in UTC + ISO 8601 format. + date_updated: + type: string + format: date-time nullable: true - revision: + description: Specifies the date this Deployment was last updated, given + in UTC ISO 8601 format. + preview.deployed_devices.fleet.device: + type: object + properties: + sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - date_created: + description: Contains a 34 character string that uniquely identifies this + Device resource. + url: type: string - format: date-time + format: uri nullable: true - date_updated: + description: Contains an absolute URL for this Device resource. + unique_name: type: string - format: date-time nullable: true - created_by: + description: Contains a unique and addressable name of this Device, assigned + by the developer, up to 128 characters long. + friendly_name: type: string nullable: true - preview.sync.service.sync_map.sync_map_item: - type: object - properties: - key: + description: Contains a human readable descriptive text for this Device, + up to 256 characters long + fleet_sid: type: string nullable: true + description: Specifies the unique string identifier of the Fleet that the + given Device belongs to. + enabled: + type: boolean + nullable: true + description: Contains a boolean flag indicating whether the device is enabled + or not, blocks device connectivity if set to false. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - service_sid: + description: Specifies the unique string identifier of the Account responsible + for this Device. + identity: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - map_sid: + description: Contains an arbitrary string identifier representing a human + user associated with this Device, assigned by the developer, up to 256 + characters long. + deployment_sid: type: string minLength: 34 maxLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ - nullable: true - url: - type: string - format: uri - nullable: true - revision: - type: string - nullable: true - data: + pattern: ^DL[0-9a-fA-F]{32}$ nullable: true + description: Specifies the unique string identifier of the Deployment group + that this Device is associated with. date_created: type: string format: date-time nullable: true + description: Specifies the date this Device was created, given in UTC ISO + 8601 format. date_updated: type: string format: date-time nullable: true - created_by: + description: Specifies the date this Device was last updated, given in UTC + ISO 8601 format. + date_authenticated: type: string + format: date-time nullable: true - sync_map_item_enum_query_result_order: - type: string - enum: - - asc - - desc - sync_map_item_enum_query_from_bound_type: - type: string - enum: - - inclusive - - exclusive - preview.sync.service.sync_map.sync_map_permission: + description: Specifies the date this Device was last authenticated, given + in UTC ISO 8601 format. + preview.deployed_devices.fleet: type: object properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The unique SID identifier of the Twilio Account. - service_sid: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Sync Service Instance. - map_sid: + description: Contains a 34 character string that uniquely identifies this + Fleet resource. + url: type: string - minLength: 34 - maxLength: 34 - pattern: ^MP[0-9a-fA-F]{32}$ + format: uri nullable: true - description: The unique SID identifier of the Sync Map to which the Permission - applies. - identity: + description: Contains an absolute URL for this Fleet resource. + unique_name: type: string nullable: true - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - read: - type: boolean - nullable: true - description: Boolean flag specifying whether the identity can read the Sync - Map and its Items. - write: - type: boolean - nullable: true - description: Boolean flag specifying whether the identity can create, update - and delete Items of the Sync Map. - manage: - type: boolean - nullable: true - description: Boolean flag specifying whether the identity can delete the - Sync Map. - url: + description: Contains a unique and addressable name of this Fleet, e.g. + 'default', up to 128 characters long. + friendly_name: type: string - format: uri nullable: true - description: Contains an absolute URL for this Sync Map Permission. - preview.understand.assistant: - type: object - properties: + description: Contains a human readable descriptive text for this Fleet, + up to 256 characters long. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account that created this Assistant. + description: Speicifies the unique string identifier of the Account responsible + for this Fleet. + default_deployment_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + nullable: true + description: Contains the string identifier of the automatically provisioned + default Deployment of this Fleet. date_created: type: string format: date-time nullable: true - description: The date that this resource was created + description: Specifies the date this Fleet was created, given in UTC ISO + 8601 format. date_updated: type: string format: date-time nullable: true - description: The date that this resource was last updated - friendly_name: - type: string - nullable: true - description: A text description for the Assistant. It is non-unique and - can up to 255 characters long. - latest_model_build_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID (Sid) of the latest model build. Null if no model - has been built. + description: Specifies the date this Fleet was last updated, given in UTC + ISO 8601 format. links: type: object format: uri-map nullable: true - log_queries: - type: boolean - nullable: true - description: A boolean that specifies whether queries should be logged for - 30 days further training. If false, no queries will be stored, if true, - queries will be stored for 30 days and deleted thereafter. + description: Contains a dictionary of URL links to nested resources of this + Fleet. + preview.deployed_devices.fleet.key: + type: object + properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies this resource. - unique_name: - type: string + pattern: ^KY[0-9a-fA-F]{32}$ nullable: true - description: A user-provided string that uniquely identifies this resource - as an alternative to the sid. You can use the unique name in the URL path. - Unique up to 64 characters long. + description: Contains a 34 character string that uniquely identifies this + Key credential resource. url: type: string format: uri nullable: true - callback_url: + description: Contains an absolute URL for this Key credential resource. + friendly_name: type: string - format: uri nullable: true - description: A user-provided URL to send event callbacks to. - callback_events: + description: Contains a human readable descriptive text for this Key credential, + up to 256 characters long. + fleet_sid: type: string nullable: true - description: Space-separated list of callback events that will trigger callbacks. - preview.understand.assistant.assistant_fallback_actions: - type: object - properties: + description: Specifies the unique string identifier of the Fleet that the + given Key credential belongs to. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - assistant_sid: + description: Specifies the unique string identifier of the Account responsible + for this Key credential. + device_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - url: + description: Specifies the unique string identifier of a Device authenticated + with this Key credential. + secret: type: string - format: uri nullable: true - data: + description: Contains the automatically generated secret belonging to this + Key credential, used to authenticate the Device. + date_created: + type: string + format: date-time nullable: true - preview.understand.assistant.assistant_initiation_actions: - type: object - properties: - account_sid: + description: Specifies the date this Key credential was created, given in + UTC ISO 8601 format. + date_updated: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + format: date-time nullable: true - assistant_sid: + description: Specifies the date this Key credential was last updated, given + in UTC ISO 8601 format. + preview.sync.service.document: + type: object + properties: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + pattern: ^ET[0-9a-fA-F]{32}$ nullable: true - url: + unique_name: type: string - format: uri nullable: true - data: - nullable: true - preview.understand.assistant.dialogue: - type: object - properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account that created this Field. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the parent Assistant. - sid: + service_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UK[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the Dialogue - data: + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The dialogue memory object as json url: type: string format: uri nullable: true - preview.understand.assistant.task.field: - type: object - properties: - account_sid: + links: + type: object + format: uri-map + nullable: true + revision: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account that created this Field. + data: + nullable: true date_created: type: string format: date-time nullable: true - description: The date that this resource was created date_updated: type: string format: date-time nullable: true - description: The date that this resource was last updated - field_type: + created_by: type: string nullable: true - description: The Field Type of this field. It can be any [Built-in Field - Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) - or the unique_name or sid of a custom Field Type. - task_sid: + preview.sync.service.document.document_permission: + type: object + properties: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Task associated with this Field. - assistant_sid: + description: The unique SID identifier of the Twilio Account. + service_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the parent Assistant. - sid: + description: The unique SID identifier of the Sync Service Instance. + document_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UE[0-9a-fA-F]{32}$ + pattern: ^ET[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies this resource. - unique_name: + description: The unique SID identifier of the Sync Document to which the + Permission applies. + identity: type: string nullable: true - description: A user-provided string that uniquely identifies this resource - as an alternative to the sid. Unique up to 64 characters long. + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + read: + type: boolean + nullable: true + description: Boolean flag specifying whether the identity can read the Sync + Document. + write: + type: boolean + nullable: true + description: Boolean flag specifying whether the identity can update the + Sync Document. + manage: + type: boolean + nullable: true + description: Boolean flag specifying whether the identity can delete the + Sync Document. url: type: string format: uri nullable: true - preview.understand.assistant.field_type: + description: Contains an absolute URL for this Sync Document Permission. + preview.sync.service: type: object properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account that created this Field Type. + friendly_name: + type: string + nullable: true date_created: type: string format: date-time nullable: true - description: The date that this resource was created date_updated: type: string format: date-time nullable: true - description: The date that this resource was last updated - friendly_name: + url: + type: string + format: uri + nullable: true + webhook_url: type: string + format: uri + nullable: true + reachability_webhooks_enabled: + type: boolean + nullable: true + acl_enabled: + type: boolean nullable: true - description: A user-provided string that identifies this resource. It is - non-unique and can up to 255 characters long. links: type: object format: uri-map nullable: true - assistant_sid: + preview.sync.service.sync_list: + type: object + properties: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + pattern: ^ES[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Assistant. - sid: + unique_name: + type: string + nullable: true + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UB[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies this resource. - unique_name: + service_sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: A user-provided string that uniquely identifies this resource - as an alternative to the sid. Unique up to 64 characters long. url: type: string format: uri nullable: true - preview.understand.assistant.field_type.field_value: - type: object - properties: - account_sid: + links: + type: object + format: uri-map + nullable: true + revision: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account that created this Field Value. date_created: type: string format: date-time nullable: true - description: The date that this resource was created date_updated: type: string format: date-time nullable: true - description: The date that this resource was last updated - field_type_sid: + created_by: type: string - minLength: 34 - maxLength: 34 - pattern: ^UB[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Field Type associated with this Field - Value. - language: - type: string + preview.sync.service.sync_list.sync_list_item: + type: object + properties: + index: + type: integer nullable: true - description: An ISO language-country string of the value. - assistant_sid: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Assistant. - sid: + service_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UC[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies this resource. - value: + list_sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^ES[0-9a-fA-F]{32}$ nullable: true - description: The Field Value itself. url: type: string format: uri nullable: true - synonym_of: + revision: type: string - minLength: 34 - maxLength: 34 - pattern: ^UC[0-9a-fA-F]{32}$ nullable: true - description: A value that indicates this field value is a synonym of. Empty - if the value is not a synonym. - preview.understand.assistant.model_build: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + data: nullable: true - description: The unique ID of the Account that created this Model Build. date_created: type: string format: date-time nullable: true - description: The date that this resource was created date_updated: type: string format: date-time nullable: true - description: The date that this resource was last updated - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the parent Assistant. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies this resource. - status: - type: string - $ref: '#/components/schemas/model_build_enum_status' - nullable: true - description: 'A string that described the model build status. The values - can be: enqueued, building, completed, failed' - unique_name: - type: string - nullable: true - description: A user-provided string that uniquely identifies this resource - as an alternative to the sid. Unique up to 64 characters long. - url: + created_by: type: string - format: uri - nullable: true - build_duration: - type: integer nullable: true - description: The time in seconds it took to build the model. - error_code: - type: integer - nullable: true - model_build_enum_status: + sync_list_item_enum_query_result_order: type: string enum: - - enqueued - - building - - completed - - failed - - canceled - preview.understand.assistant.query: + - asc + - desc + sync_list_item_enum_query_from_bound_type: + type: string + enum: + - inclusive + - exclusive + preview.sync.service.sync_list.sync_list_permission: type: object properties: account_sid: @@ -1715,155 +1441,148 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account that created this Query. - date_created: + description: The unique SID identifier of the Twilio Account. + service_sid: type: string - format: date-time + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The date that this resource was created - date_updated: + description: The unique SID identifier of the Sync Service Instance. + list_sid: type: string - format: date-time - nullable: true - description: The date that this resource was last updated - results: + minLength: 34 + maxLength: 34 + pattern: ^ES[0-9a-fA-F]{32}$ nullable: true - description: The natural language analysis results which include the Task - recognized, the confidence score and a list of identified Fields. - language: + description: The unique SID identifier of the Sync List to which the Permission + applies. + identity: type: string nullable: true - description: An ISO language-country string of the sample. - model_build_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + read: + type: boolean + nullable: true + description: Boolean flag specifying whether the identity can read the Sync + List and its Items. + write: + type: boolean nullable: true - description: The unique ID of the Model Build queried. - query: + description: Boolean flag specifying whether the identity can create, update + and delete Items of the Sync List. + manage: + type: boolean + nullable: true + description: Boolean flag specifying whether the identity can delete the + Sync List. + url: type: string + format: uri nullable: true - description: The end-user's natural language input. - sample_sid: + description: Contains an absolute URL for this Sync List Permission. + preview.sync.service.sync_map: + type: object + properties: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ + pattern: ^MP[0-9a-fA-F]{32}$ nullable: true - description: An optional reference to the Sample created from this query. - assistant_sid: + unique_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the parent Assistant. - sid: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UH[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies this resource. - status: + service_sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: 'A string that described the query status. The values can be: - pending_review, reviewed, discarded' url: type: string format: uri nullable: true - source_channel: - type: string + links: + type: object + format: uri-map nullable: true - description: The communication channel where this end-user input came from - preview.understand.assistant.task.sample: - type: object - properties: - account_sid: + revision: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account that created this Sample. date_created: type: string format: date-time nullable: true - description: The date that this resource was created date_updated: type: string format: date-time nullable: true - description: The date that this resource was last updated - task_sid: + created_by: type: string - minLength: 34 - maxLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Task associated with this Sample. - language: + preview.sync.service.sync_map.sync_map_item: + type: object + properties: + key: type: string nullable: true - description: An ISO language-country string of the sample. - assistant_sid: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Assistant. - sid: + service_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies this resource. - tagged_text: + map_sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^MP[0-9a-fA-F]{32}$ nullable: true - description: The text example of how end-users may express this task. The - sample may contain Field tag blocks. url: type: string format: uri nullable: true - source_channel: + revision: type: string nullable: true - description: 'The communication channel the sample was captured. It can - be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If - not included the value will be null' - preview.understand.assistant.style_sheet: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + data: nullable: true - description: The unique ID of the Account that created this Assistant - assistant_sid: + date_created: type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + format: date-time nullable: true - description: The unique ID of the Assistant - url: + date_updated: type: string - format: uri + format: date-time nullable: true - data: + created_by: + type: string nullable: true - description: The JSON style sheet object - preview.understand.assistant.task: + sync_map_item_enum_query_result_order: + type: string + enum: + - asc + - desc + sync_map_item_enum_query_from_bound_type: + type: string + enum: + - inclusive + - exclusive + preview.sync.service.sync_map.sync_map_permission: type: object properties: account_sid: @@ -1872,383 +1591,47 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account that created this Task. - date_created: - type: string - format: date-time - nullable: true - description: The date that this resource was created - date_updated: - type: string - format: date-time - nullable: true - description: The date that this resource was last updated - friendly_name: - type: string - nullable: true - description: A user-provided string that identifies this resource. It is - non-unique and can up to 255 characters long. - links: - type: object - format: uri-map - nullable: true - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the Assistant. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies this resource. - unique_name: - type: string - nullable: true - description: A user-provided string that uniquely identifies this resource - as an alternative to the sid. Unique up to 64 characters long. - actions_url: - type: string - format: uri - nullable: true - description: User-provided HTTP endpoint where from the assistant fetches - actions - url: - type: string - format: uri - nullable: true - preview.understand.assistant.task.task_actions: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the Account that created this Field. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the parent Assistant. - task_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the Task. - url: - type: string - format: uri - nullable: true - data: - nullable: true - preview.understand.assistant.task.task_statistics: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the Account that created this Field. - assistant_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the parent Assistant. - task_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UD[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the Task associated with this Field. - samples_count: - type: integer - nullable: true - description: The total number of Samples associated with this Task. - fields_count: - type: integer - nullable: true - description: The total number of Fields associated with this Task. - url: - type: string - format: uri - nullable: true - preview.wireless.command: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DC[0-9a-fA-F]{32}$ - nullable: true - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - device_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - nullable: true - sim_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - nullable: true - command: - type: string - nullable: true - command_mode: - type: string - nullable: true - status: - type: string - nullable: true - direction: - type: string - nullable: true - date_created: - type: string - format: date-time - nullable: true - date_updated: - type: string - format: date-time - nullable: true - url: - type: string - format: uri - nullable: true - preview.wireless.rate_plan: - type: object - properties: - sid: + description: The unique SID identifier of the Twilio Account. + service_sid: type: string minLength: 34 maxLength: 34 - pattern: ^WP[0-9a-fA-F]{32}$ - nullable: true - unique_name: - type: string + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - account_sid: + description: The unique SID identifier of the Sync Service Instance. + map_sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - friendly_name: - type: string - nullable: true - data_enabled: - type: boolean + pattern: ^MP[0-9a-fA-F]{32}$ nullable: true - data_metering: + description: The unique SID identifier of the Sync Map to which the Permission + applies. + identity: type: string nullable: true - data_limit: - type: integer - nullable: true - messaging_enabled: + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + read: type: boolean nullable: true - voice_enabled: + description: Boolean flag specifying whether the identity can read the Sync + Map and its Items. + write: type: boolean nullable: true - national_roaming_enabled: + description: Boolean flag specifying whether the identity can create, update + and delete Items of the Sync Map. + manage: type: boolean nullable: true - international_roaming: - type: array - items: - type: string - nullable: true - date_created: - type: string - format: date-time - nullable: true - date_updated: - type: string - format: date-time - nullable: true + description: Boolean flag specifying whether the identity can delete the + Sync Map. url: type: string format: uri nullable: true - preview.wireless.sim: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - nullable: true - unique_name: - type: string - nullable: true - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - rate_plan_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^WP[0-9a-fA-F]{32}$ - nullable: true - friendly_name: - type: string - nullable: true - iccid: - type: string - nullable: true - e_id: - type: string - nullable: true - status: - type: string - nullable: true - commands_callback_url: - type: string - format: uri - nullable: true - commands_callback_method: - type: string - nullable: true - sms_fallback_method: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - nullable: true - sms_fallback_url: - type: string - format: uri - nullable: true - sms_method: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - nullable: true - sms_url: - type: string - format: uri - nullable: true - voice_fallback_method: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - nullable: true - voice_fallback_url: - type: string - format: uri - nullable: true - voice_method: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - nullable: true - voice_url: - type: string - format: uri - nullable: true - date_created: - type: string - format: date-time - nullable: true - date_updated: - type: string - format: date-time - nullable: true - url: - type: string - format: uri - nullable: true - links: - type: object - format: uri-map - nullable: true - preview.wireless.sim.usage: - type: object - properties: - sim_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ - nullable: true - sim_unique_name: - type: string - nullable: true - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - period: - nullable: true - commands_usage: - nullable: true - commands_costs: - nullable: true - data_usage: - nullable: true - data_costs: - nullable: true - url: - type: string - format: uri - nullable: true - securitySchemes: - accountSid_authToken: - type: http - scheme: basic + description: Contains an absolute URL for this Sync Map Permission. info: title: Twilio - Preview description: This is the public Twilio REST API. @@ -2260,2111 +1643,201 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 -paths: - /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Fleets/{Sid} - get: - description: Fetch information about a specific Certificate credential in the - Fleet. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesCertificate - x-maturity: - - Preview - delete: - description: Unregister a specific Certificate credential from the Fleet, effectively - disallowing any inbound client connections that are presenting it. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteDeployedDevicesCertificate - x-maturity: - - Preview - post: - description: Update the given properties of a specific Certificate credential - in the Fleet, giving it a friendly name or assigning to a Device. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDeployedDevicesCertificate - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateDeployedDevicesCertificateRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Certificate credential, up to 256 characters long. - DeviceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of an existing - Device to become authenticated with this Certificate credential. - /DeployedDevices/Fleets/{FleetSid}/Certificates: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /Fleets/{Sid} - post: - description: Enroll a new Certificate credential to the Fleet, optionally giving - it a friendly name and assigning to a Device. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesCertificate - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateDeployedDevicesCertificateRequest - properties: - CertificateData: - type: string - description: Provides a URL encoded representation of the public - certificate in PEM format. - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Certificate credential, up to 256 characters long. - DeviceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of an existing - Device to become authenticated with this Certificate credential. - required: - - CertificateData - get: - description: Retrieve a list of all Certificate credentials belonging to the - Fleet. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: DeviceSid - in: query - description: Filters the resulting list of Certificates by a unique string - identifier of an authenticated Device. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListDeployedDevicesCertificateResponse - properties: - certificates: - type: array - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListDeployedDevicesCertificate - x-maturity: - - Preview - /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Fleets/{Sid} - get: - description: Fetch information about a specific Deployment in the Fleet. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesDeployment - x-maturity: - - Preview - delete: - description: Delete a specific Deployment from the Fleet, leaving associated - devices effectively undeployed. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteDeployedDevicesDeployment - x-maturity: - - Preview - post: - description: Update the given properties of a specific Deployment credential - in the Fleet, giving it a friendly name or linking to a specific Twilio Sync - service instance. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDeployedDevicesDeployment - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateDeployedDevicesDeploymentRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Deployment, up to 64 characters long - SyncServiceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of the Twilio - Sync service instance that will be linked to and accessible by - this Deployment. - /DeployedDevices/Fleets/{FleetSid}/Deployments: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /Fleets/{Sid} - post: - description: Create a new Deployment in the Fleet, optionally giving it a friendly - name and linking to a specific Twilio Sync service instance. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesDeployment - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateDeployedDevicesDeploymentRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Deployment, up to 256 characters long. - SyncServiceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of the Twilio - Sync service instance that will be linked to and accessible by - this Deployment. - get: - description: Retrieve a list of all Deployments belonging to the Fleet. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - 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: ListDeployedDevicesDeploymentResponse - properties: - deployments: - type: array - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListDeployedDevicesDeployment - x-maturity: - - Preview - /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Fleets/{Sid} - get: - description: Fetch information about a specific Device in the Fleet. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Device resource. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesDevice - x-maturity: - - Preview - delete: - description: Delete a specific Device from the Fleet, also removing it from - associated Deployments. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Device resource. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteDeployedDevicesDevice - x-maturity: - - Preview - post: - description: Update the given properties of a specific Device in the Fleet, - giving it a friendly name, assigning to a Deployment, or a human identity. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Device resource. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDeployedDevicesDevice - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateDeployedDevicesDeviceRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text to be assigned - to this Device, up to 256 characters long. - Identity: - type: string - description: Provides an arbitrary string identifier representing - a human user to be associated with this Device, up to 256 characters - long. - DeploymentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - description: Specifies the unique string identifier of the Deployment - group that this Device is going to be associated with. - Enabled: - type: boolean - description: '' - /DeployedDevices/Fleets/{FleetSid}/Devices: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /Fleets/{Sid} - post: - description: Create a new Device in the Fleet, optionally giving it a unique - name, friendly name, and assigning to a Deployment and/or human identity. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesDevice - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateDeployedDevicesDeviceRequest - properties: - UniqueName: - type: string - description: Provides a unique and addressable name to be assigned - to this Device, to be used in addition to SID, up to 128 characters - long. - FriendlyName: - type: string - description: Provides a human readable descriptive text to be assigned - to this Device, up to 256 characters long. - Identity: - type: string - description: Provides an arbitrary string identifier representing - a human user to be associated with this Device, up to 256 characters - long. - DeploymentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - description: Specifies the unique string identifier of the Deployment - group that this Device is going to be associated with. - Enabled: - type: boolean - description: '' - get: - description: Retrieve a list of all Devices belonging to the Fleet. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: DeploymentSid - in: query - description: Filters the resulting list of Devices by a unique string identifier - of the Deployment they are associated with. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 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: ListDeployedDevicesDeviceResponse - properties: - devices: - type: array - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListDeployedDevicesDevice - x-maturity: - - Preview - /DeployedDevices/Fleets/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - dependentProperties: - device: '{fleet_sid: sid}' - deployment: '{fleet_sid: sid}' - certificate: '{fleet_sid: sid}' - key: '{fleet_sid: sid}' - get: - description: Fetch information about a specific Fleet in your account. - parameters: - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesFleet - x-maturity: - - Preview - delete: - description: 'Delete a specific Fleet from your account, also destroys all nested - resources: Devices, Deployments, Certificates, Keys.' - parameters: - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteDeployedDevicesFleet - x-maturity: - - Preview - post: - description: Update the friendly name property of a specific Fleet in your account. - parameters: - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDeployedDevicesFleet - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateDeployedDevicesFleetRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Fleet, up to 256 characters long. - DefaultDeploymentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - description: Provides a string identifier of a Deployment that is - going to be used as a default one for this Fleet. - /DeployedDevices/Fleets: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - dependentProperties: - device: '{fleet_sid: sid}' - deployment: '{fleet_sid: sid}' - certificate: '{fleet_sid: sid}' - key: '{fleet_sid: sid}' - post: - description: Create a new Fleet for scoping of deployed devices within your - account. - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesFleet - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateDeployedDevicesFleetRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Fleet, up to 256 characters long. - get: - description: Retrieve a list of all Fleets belonging to your account. - 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: ListDeployedDevicesFleetResponse - properties: - fleets: - type: array - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListDeployedDevicesFleet - x-maturity: - - Preview - /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Fleets/{Sid} - get: - description: Fetch information about a specific Key credential in the Fleet. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesKey - x-maturity: - - Preview - delete: - description: Delete a specific Key credential from the Fleet, effectively disallowing - any inbound client connections that are presenting it. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteDeployedDevicesKey - x-maturity: - - Preview - post: - description: Update the given properties of a specific Key credential in the - Fleet, giving it a friendly name or assigning to a Device. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDeployedDevicesKey - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateDeployedDevicesKeyRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Key credential, up to 256 characters long. - DeviceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of an existing - Device to become authenticated with this Key credential. - /DeployedDevices/Fleets/{FleetSid}/Keys: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /Fleets/{Sid} - post: - description: Create a new Key credential in the Fleet, optionally giving it - a friendly name and assigning to a Device. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesKey - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateDeployedDevicesKeyRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Key credential, up to 256 characters long. - DeviceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of an existing - Device to become authenticated with this Key credential. - get: - description: Retrieve a list of all Keys credentials belonging to the Fleet. - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: DeviceSid - in: query - description: Filters the resulting list of Keys by a unique string identifier - of an authenticated Device. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListDeployedDevicesKeyResponse - properties: - keys: - type: array - items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListDeployedDevicesKey - x-maturity: - - Preview - /HostedNumbers/AuthorizationDocuments/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - dependentProperties: - dependent_hosted_number_order: '{signing_document_sid: sid}' - get: - description: Fetch a specific AuthorizationDocument. - parameters: - - name: Sid - in: path - description: A 34 character string that uniquely identifies this AuthorizationDocument. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchHostedNumbersAuthorizationDocument - x-maturity: - - Preview - post: - description: Updates a specific AuthorizationDocument. - parameters: - - name: Sid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateHostedNumbersAuthorizationDocument - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateHostedNumbersAuthorizationDocumentRequest - properties: - HostedNumberOrderSids: - type: array - items: - type: string - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - Email: - type: string - description: Email that this AuthorizationDocument will be sent - to for signing. - CcEmails: - type: array - items: - type: string - description: Email recipients who will be informed when an Authorization - Document has been sent and signed - Status: - type: string - $ref: '#/components/schemas/authorization_document_enum_status' - description: 'Status of an instance resource. It can hold one of - the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, - 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - ContactTitle: - type: string - description: The title of the person authorized to sign the Authorization - Document for this phone number. - ContactPhoneNumber: - type: string - description: The contact phone number of the person authorized to - sign the Authorization Document. - /HostedNumbers/AuthorizationDocuments: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - dependentProperties: - dependent_hosted_number_order: '{signing_document_sid: sid}' - get: - description: Retrieve a list of AuthorizationDocuments belonging to the account - initiating the request. - parameters: - - name: Email - in: query - description: Email that this AuthorizationDocument will be sent to for signing. - schema: - type: string - - name: Status - in: query - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - schema: - type: string - $ref: '#/components/schemas/authorization_document_enum_status' - - 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: ListHostedNumbersAuthorizationDocumentResponse - properties: - items: - type: array - items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListHostedNumbersAuthorizationDocument - x-maturity: - - Preview - post: - description: Create an AuthorizationDocument for authorizing the hosting of - phone number capabilities on Twilio's platform. - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateHostedNumbersAuthorizationDocument - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateHostedNumbersAuthorizationDocumentRequest - properties: - HostedNumberOrderSids: - type: array - items: - type: string - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - Email: - type: string - description: Email that this AuthorizationDocument will be sent - to for signing. - ContactTitle: - type: string - description: The title of the person authorized to sign the Authorization - Document for this phone number. - ContactPhoneNumber: - type: string - description: The contact phone number of the person authorized to - sign the Authorization Document. - CcEmails: - type: array - items: - type: string - description: Email recipients who will be informed when an Authorization - Document has been sent and signed. - required: - - HostedNumberOrderSids - - AddressSid - - Email - - ContactTitle - - ContactPhoneNumber - /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /AuthorizationDocuments/{Sid} - get: - description: Retrieve a list of dependent HostedNumberOrders belonging to the - AuthorizationDocument. - parameters: - - name: SigningDocumentSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - required: true - - name: Status - in: query - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - schema: - type: string - $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' - - name: PhoneNumber - in: query - description: An E164 formatted phone number hosted by this HostedNumberOrder. - schema: - type: string - format: phone-number - - name: IncomingPhoneNumberSid - in: query - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - - name: FriendlyName - in: query - description: A human readable description of this resource, up to 64 characters. - schema: - type: string - - name: UniqueName - in: query - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in addition - to SID. - schema: - type: string - - 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: ListHostedNumbersDependentHostedNumberOrderResponse - properties: - items: - type: array - items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListHostedNumbersDependentHostedNumberOrder - x-maturity: - - Preview - /HostedNumbers/HostedNumberOrders/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - get: - description: Fetch a specific HostedNumberOrder. - parameters: - - name: Sid - in: path - description: A 34 character string that uniquely identifies this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchHostedNumbersHostedNumberOrder - x-maturity: - - Preview - delete: - description: Cancel the HostedNumberOrder (only available when the status is - in `received`). - parameters: - - name: Sid - in: path - description: A 34 character string that uniquely identifies this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteHostedNumbersHostedNumberOrder - x-maturity: - - Preview - post: - description: Updates a specific HostedNumberOrder. - parameters: - - name: Sid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateHostedNumbersHostedNumberOrder - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateHostedNumbersHostedNumberOrderRequest - properties: - FriendlyName: - type: string - description: A 64 character string that is a human readable text - that describes this resource. - UniqueName: - type: string - description: Provides a unique and addressable name to be assigned - to this HostedNumberOrder, assigned by the developer, to be optionally - used in addition to SID. - Email: - type: string - description: Email of the owner of this phone number that is being - hosted. - CcEmails: - type: array - items: - type: string - description: Optional. A list of emails that LOA document for this - HostedNumberOrder will be carbon copied to. - Status: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' - description: User can only post to `pending-verification` status - to transition the HostedNumberOrder to initiate a verification - call or verification of ownership with a copy of a phone bill. - VerificationCode: - type: string - description: A verification code that is given to the user via a - phone call to the phone number that is being hosted. - VerificationType: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_verification_type' - description: Optional. The method used for verifying ownership of - the number to be hosted. One of phone-call (default) or phone-bill. - VerificationDocumentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - description: Optional. The unique sid identifier of the Identity - Document that represents the document for verifying ownership - of the number to be hosted. Required when VerificationType is - phone-bill. - Extension: - type: string - description: Digits to dial after connecting the verification call. - CallDelay: - type: integer - description: The number of seconds, between 0 and 60, to delay before - initiating the verification call. Defaults to 0. - /HostedNumbers/HostedNumberOrders: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - get: - description: Retrieve a list of HostedNumberOrders belonging to the account - initiating the request. - parameters: - - name: Status - in: query - description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, - `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, - `failed`, or `action-required`. - schema: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' - - name: PhoneNumber - in: query - description: An E164 formatted phone number hosted by this HostedNumberOrder. - schema: - type: string - format: phone-number - - name: IncomingPhoneNumberSid - in: query - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - - name: FriendlyName - in: query - description: A human readable description of this resource, up to 64 characters. - schema: - type: string - - name: UniqueName - in: query - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in addition - to SID. - schema: - type: string - - name: PageSize - in: query - 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: ListHostedNumbersHostedNumberOrderResponse - properties: - items: - type: array - items: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListHostedNumbersHostedNumberOrder - x-maturity: - - Preview - post: - description: Host a phone number's capability on Twilio's platform. - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateHostedNumbersHostedNumberOrder - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateHostedNumbersHostedNumberOrderRequest - properties: - PhoneNumber: - type: string - format: phone-number - description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) - format - SmsCapability: - type: boolean - description: Used to specify that the SMS capability will be hosted - on Twilio's platform. - AccountSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - description: This defaults to the AccountSid of the authorization - the user is using. This can be provided to specify a subaccount - to add the HostedNumberOrder to. - FriendlyName: - type: string - description: A 64 character string that is a human readable text - that describes this resource. - UniqueName: - type: string - description: Optional. Provides a unique and addressable name to - be assigned to this HostedNumberOrder, assigned by the developer, - to be optionally used in addition to SID. - CcEmails: - type: array - items: - type: string - description: Optional. A list of emails that the LOA document for - this HostedNumberOrder will be carbon copied to. - SmsUrl: - type: string - format: uri - description: The URL that Twilio should request when somebody sends - an SMS to the phone number. This will be copied onto the IncomingPhoneNumber - resource. - SmsMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: The HTTP method that should be used to request the - SmsUrl. Must be either `GET` or `POST`. This will be copied onto - the IncomingPhoneNumber resource. - SmsFallbackUrl: - type: string - format: uri - description: A URL that Twilio will request if an error occurs requesting - or executing the TwiML defined by SmsUrl. This will be copied - onto the IncomingPhoneNumber resource. - SmsFallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: The HTTP method that should be used to request the - SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied - onto the IncomingPhoneNumber resource. - StatusCallbackUrl: - type: string - format: uri - description: Optional. The Status Callback URL attached to the IncomingPhoneNumber - resource. - StatusCallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: Optional. The Status Callback Method attached to the - IncomingPhoneNumber resource. - SmsApplicationSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AP[0-9a-fA-F]{32}$ - description: Optional. The 34 character sid of the application Twilio - should use to handle SMS messages sent to this number. If a `SmsApplicationSid` - is present, Twilio will ignore all of the SMS urls above and use - those set on the application. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: Optional. A 34 character string that uniquely identifies - the Address resource that represents the address of the owner - of this phone number. - Email: - type: string - description: Optional. Email of the owner of this phone number that - is being hosted. - VerificationType: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_verification_type' - description: Optional. The method used for verifying ownership of - the number to be hosted. One of phone-call (default) or phone-bill. - VerificationDocumentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - description: Optional. The unique sid identifier of the Identity - Document that represents the document for verifying ownership - of the number to be hosted. Required when VerificationType is - phone-bill. - required: - - PhoneNumber - - SmsCapability - /marketplace/AvailableAddOns/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - dependentProperties: - available_add_on_extension: '{available_add_on_sid: sid}' - get: - description: Fetch an instance of an Add-on currently available to be installed. - parameters: - - name: Sid - in: path - description: The SID of the AvailableAddOn resource to fetch. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchMarketplaceAvailableAddOn - x-maturity: - - Preview - /marketplace/AvailableAddOns: +paths: + /HostedNumbers/AuthorizationDocuments/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list dependentProperties: - available_add_on_extension: '{available_add_on_sid: sid}' + dependent_hosted_number_orders: + mapping: + signing_document_sid: sid + resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders + pathType: instance get: - description: Retrieve a list of Add-ons currently available to be installed. + description: Fetch a specific AuthorizationDocument. + tags: + - PreviewHostedNumbersAuthorizationDocument 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. + - name: Sid + in: path + description: A 34 character string that uniquely identifies this AuthorizationDocument. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true responses: '200': content: application/json: schema: - type: object - title: ListMarketplaceAvailableAddOnResponse - properties: - available_add_ons: - type: array - items: - $ref: '#/components/schemas/preview.marketplace.available_add_on' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + examples: + fetch: + value: + address_sid: AD11111111111111111111111111111111 + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceAvailableAddOn - x-maturity: - - Preview - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /AvailableAddOns/{Sid} - className: available_add_on_extension - get: - description: Fetch an instance of an Extension for the Available Add-on. + operationId: FetchHostedNumbersAuthorizationDocument + post: + description: Updates a specific AuthorizationDocument. + tags: + - PreviewHostedNumbersAuthorizationDocument 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. + description: A 34 character string that uniquely identifies this AuthorizationDocument. schema: type: string minLength: 34 maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ + pattern: ^PX[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + examples: + update: + value: + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceAvailableAddOnExtension - x-maturity: - - Preview - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: + operationId: UpdateHostedNumbersAuthorizationDocument + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateHostedNumbersAuthorizationDocumentRequest + properties: + HostedNumberOrderSids: + type: array + items: + type: string + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + Email: + type: string + description: Email that this AuthorizationDocument will be sent + to for signing. + CcEmails: + type: array + items: + type: string + description: Email recipients who will be informed when an Authorization + Document has been sent and signed + Status: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + description: 'Status of an instance resource. It can hold one of + the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, + 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + ContactTitle: + type: string + description: The title of the person authorized to sign the Authorization + Document for this phone number. + ContactPhoneNumber: + type: string + description: The contact phone number of the person authorized to + sign the Authorization Document. + examples: + update: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + HostedNumberOrderSids: + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 + Status: signing + ContactTitle: Mr. + ContactPhoneNumber: '+14155555555' + /HostedNumbers/AuthorizationDocuments: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + dependent_hosted_number_orders: + mapping: + signing_document_sid: sid + resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders pathType: list - parent: /AvailableAddOns/{Sid} - className: available_add_on_extension get: - description: Retrieve a list of Extensions for the Available Add-on. + description: Retrieve a list of AuthorizationDocuments belonging to the account + initiating the request. + tags: + - PreviewHostedNumbersAuthorizationDocument parameters: - - name: AvailableAddOnSid - in: path - description: The SID of the AvailableAddOn resource with the extensions to - read. + - name: Email + in: query + description: Email that this AuthorizationDocument will be sent to for signing. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - required: true + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: test+hosted@twilio.com + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + examples: + readEmpty: + value: signed - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4390,93 +1863,245 @@ paths: application/json: schema: type: object - title: ListMarketplaceAvailableAddOnExtensionResponse + title: ListHostedNumbersAuthorizationDocumentResponse properties: - extensions: + items: type: array items: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 + items: + - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceAvailableAddOnExtension - x-maturity: - - Preview - /marketplace/InstalledAddOns: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - dependentProperties: - installed_add_on_extension: '{installed_add_on_sid: sid}' + operationId: ListHostedNumbersAuthorizationDocument post: - description: Install an Add-on for the Account specified. + description: Create an AuthorizationDocument for authorizing the hosting of + phone number capabilities on Twilio's platform. + tags: + - PreviewHostedNumbersAuthorizationDocument responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + examples: + create: + value: + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateMarketplaceInstalledAddOn - x-maturity: - - Preview + operationId: CreateHostedNumbersAuthorizationDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateMarketplaceInstalledAddOnRequest + title: CreateHostedNumbersAuthorizationDocumentRequest properties: - AvailableAddOnSid: + HostedNumberOrderSids: + type: array + items: + type: string + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + AddressSid: type: string minLength: 34 maxLength: 34 - pattern: ^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: + pattern: ^AD[0-9a-fA-F]{32}$ + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + Email: type: string - description: An application-defined string that uniquely identifies - the resource. This value must be unique within the Account. + description: Email that this AuthorizationDocument will be sent + to for signing. + ContactTitle: + type: string + description: The title of the person authorized to sign the Authorization + Document for this phone number. + ContactPhoneNumber: + type: string + description: The contact phone number of the person authorized to + sign the Authorization Document. + CcEmails: + type: array + items: + type: string + description: Email recipients who will be informed when an Authorization + Document has been sent and signed. required: - - AvailableAddOnSid - - AcceptTermsOfService + - HostedNumberOrderSids + - AddressSid + - Email + - ContactTitle + - ContactPhoneNumber + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + HostedNumberOrderSids: + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 + ContactTitle: Mr. + ContactPhoneNumber: '+14155555555' + /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /AuthorizationDocuments/{Sid} + pathType: list get: - description: Retrieve a list of Add-ons currently installed on this Account. + description: Retrieve a list of dependent HostedNumberOrders belonging to the + AuthorizationDocument. + tags: + - PreviewHostedNumbersDependentHostedNumberOrder parameters: + - name: SigningDocumentSid + in: path + description: A 34 character string that uniquely identifies the LOA document + associated with this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. + schema: + type: string + format: phone-number + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid + in: query + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 64 characters. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: example + - name: UniqueName + in: query + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in addition + to SID. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: something123 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4502,244 +2127,370 @@ paths: application/json: schema: type: object - title: ListMarketplaceInstalledAddOnResponse + title: ListHostedNumbersDependentHostedNumberOrderResponse properties: - installed_add_ons: + items: type: array items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '1234' + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + failure_reason: '' + unique_name: foobar + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceInstalledAddOn - x-maturity: - - Preview - /marketplace/InstalledAddOns/{Sid}: + operationId: ListHostedNumbersDependentHostedNumberOrder + /HostedNumbers/HostedNumberOrders/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: instance - dependentProperties: - installed_add_on_extension: '{installed_add_on_sid: sid}' - delete: - description: Remove an Add-on installation from your account - 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 - x-maturity: - - Preview get: - description: Fetch an instance of an Add-on currently installed on this Account. - 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/preview.marketplace.installed_add_on' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchMarketplaceInstalledAddOn - x-maturity: - - Preview - post: - description: Update an Add-on installation for the Account specified. + description: Fetch a specific HostedNumberOrder. + tags: + - PreviewHostedNumbersHostedNumberOrder parameters: - name: Sid in: path - description: The SID of the InstalledAddOn resource to update. + description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ + pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '5105' + failure_reason: '' + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + unique_name: foobar + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: UpdateMarketplaceInstalledAddOn - x-maturity: - - Preview - 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. - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /InstalledAddOns/{Sid} - className: installed_add_on_extension - get: - description: Fetch an instance of an Extension for the Installed Add-on. + operationId: FetchHostedNumbersHostedNumberOrder + delete: + description: Cancel the HostedNumberOrder (only available when the status is + in `received`). + tags: + - PreviewHostedNumbersHostedNumberOrder 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. + description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ + pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: FetchMarketplaceInstalledAddOnExtension - x-maturity: - - Preview + operationId: DeleteHostedNumbersHostedNumberOrder post: - description: Update an Extension for an Add-on installation. + description: Updates a specific HostedNumberOrder. + tags: + - PreviewHostedNumbersHostedNumberOrder 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. + description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ + pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + extension: '1234' + failure_reason: '' + friendly_name: new friendly name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: pending-loa + unique_name: new unique name + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 1 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: UpdateMarketplaceInstalledAddOnExtension - x-maturity: - - Preview + operationId: UpdateHostedNumbersHostedNumberOrder requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateMarketplaceInstalledAddOnExtensionRequest + title: UpdateHostedNumbersHostedNumberOrderRequest properties: - Enabled: - type: boolean - description: Whether the Extension should be invoked. - required: - - Enabled - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: + FriendlyName: + type: string + description: A 64 character string that is a human readable text + that describes this resource. + UniqueName: + type: string + description: Provides a unique and addressable name to be assigned + to this HostedNumberOrder, assigned by the developer, to be optionally + used in addition to SID. + Email: + type: string + description: Email of the owner of this phone number that is being + hosted. + CcEmails: + type: array + items: + type: string + description: Optional. A list of emails that LOA document for this + HostedNumberOrder will be carbon copied to. + Status: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_status' + description: User can only post to `pending-verification` status + to transition the HostedNumberOrder to initiate a verification + call or verification of ownership with a copy of a phone bill. + VerificationCode: + type: string + description: A verification code that is given to the user via a + phone call to the phone number that is being hosted. + VerificationType: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_verification_type' + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + VerificationDocumentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + description: Optional. The unique sid identifier of the Identity + Document that represents the document for verifying ownership + of the number to be hosted. Required when VerificationType is + phone-bill. + Extension: + type: string + description: Digits to dial after connecting the verification call. + CallDelay: + type: integer + description: The number of seconds, between 0 and 60, to delay before + initiating the verification call. Defaults to 0. + examples: + update: + value: + FriendlyName: new friendly name + UniqueName: new unique name + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + Status: pending-loa + Extension: '1234' + CallDelay: 15 + /HostedNumbers/HostedNumberOrders: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: list - parent: /InstalledAddOns/{Sid} - className: installed_add_on_extension get: - description: Retrieve a list of Extensions for the Installed Add-on. + description: Retrieve a list of HostedNumberOrders belonging to the account + initiating the request. + tags: + - PreviewHostedNumbersHostedNumberOrder parameters: - - name: InstalledAddOnSid - in: path - description: The SID of the InstalledAddOn resource with the extensions to - read. + - name: Status + in: query + description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, + `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, + `failed`, or `action-required`. + schema: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. + schema: + type: string + format: phone-number + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid + in: query + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - required: true + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 64 characters. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: example + - name: UniqueName + in: query + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in addition + to SID. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: something123 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4765,437 +2516,406 @@ paths: application/json: schema: type: object - title: ListMarketplaceInstalledAddOnExtensionResponse + title: ListHostedNumbersHostedNumberOrderResponse properties: - extensions: + items: type: array items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '1234' + failure_reason: '' + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + unique_name: foobar + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceInstalledAddOnExtension - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Documents/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - dependentProperties: - document_permission: '{service_sid: service_sid, document_sid: sid}' - parent: /Services/{Sid} - get: - description: '' - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: Sid - in: path - description: '' - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchSyncDocument - x-maturity: - - Preview - delete: - description: '' - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: Sid - in: path - description: '' - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteSyncDocument - x-maturity: - - Preview + operationId: ListHostedNumbersHostedNumberOrder post: - description: '' - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: Sid - in: path - description: '' - schema: - type: string - required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string + description: Host a phone number's capability on Twilio's platform. + tags: + - PreviewHostedNumbersHostedNumberOrder responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document' - description: OK + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: null + verification_type: phone-call + createWithoutOptionalLoaFields: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: null + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: null + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: null + verification_type: phone-call + createWithPhoneBillVerification: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: null + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: null + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_type: phone-bill + description: Created security: - accountSid_authToken: [] - operationId: UpdateSyncDocument - x-maturity: - - Preview + operationId: CreateHostedNumbersHostedNumberOrder requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncDocumentRequest + title: CreateHostedNumbersHostedNumberOrderRequest properties: - Data: - description: '' + PhoneNumber: + type: string + format: phone-number + description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) + format + SmsCapability: + type: boolean + description: Used to specify that the SMS capability will be hosted + on Twilio's platform. + AccountSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + description: This defaults to the AccountSid of the authorization + the user is using. This can be provided to specify a subaccount + to add the HostedNumberOrder to. + FriendlyName: + type: string + description: A 64 character string that is a human readable text + that describes this resource. + UniqueName: + type: string + description: Optional. Provides a unique and addressable name to + be assigned to this HostedNumberOrder, assigned by the developer, + to be optionally used in addition to SID. + CcEmails: + type: array + items: + type: string + description: Optional. A list of emails that the LOA document for + this HostedNumberOrder will be carbon copied to. + SmsUrl: + type: string + format: uri + description: The URL that Twilio should request when somebody sends + an SMS to the phone number. This will be copied onto the IncomingPhoneNumber + resource. + SmsMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: The HTTP method that should be used to request the + SmsUrl. Must be either `GET` or `POST`. This will be copied onto + the IncomingPhoneNumber resource. + SmsFallbackUrl: + type: string + format: uri + description: A URL that Twilio will request if an error occurs requesting + or executing the TwiML defined by SmsUrl. This will be copied + onto the IncomingPhoneNumber resource. + SmsFallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: The HTTP method that should be used to request the + SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied + onto the IncomingPhoneNumber resource. + StatusCallbackUrl: + type: string + format: uri + description: Optional. The Status Callback URL attached to the IncomingPhoneNumber + resource. + StatusCallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: Optional. The Status Callback Method attached to the + IncomingPhoneNumber resource. + SmsApplicationSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AP[0-9a-fA-F]{32}$ + description: Optional. The 34 character sid of the application Twilio + should use to handle SMS messages sent to this number. If a `SmsApplicationSid` + is present, Twilio will ignore all of the SMS urls above and use + those set on the application. + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: Optional. A 34 character string that uniquely identifies + the Address resource that represents the address of the owner + of this phone number. + Email: + type: string + description: Optional. Email of the owner of this phone number that + is being hosted. + VerificationType: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_verification_type' + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + VerificationDocumentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + description: Optional. The unique sid identifier of the Identity + Document that represents the document for verifying ownership + of the number to be hosted. Required when VerificationType is + phone-bill. required: - - Data - /Sync/Services/{ServiceSid}/Documents: + - PhoneNumber + - SmsCapability + examples: + create: + value: + AddressSid: AD11111111111111111111111111111111 + PhoneNumber: '+14153608311' + SmsCapability: true + Email: test@twilio.com + createWithoutOptionalLoaFields: + value: + PhoneNumber: '+14153608311' + SmsCapability: true + createWithPhoneBillVerification: + value: + PhoneNumber: '+14153608311' + SmsCapability: true + VerificationType: phone-bill + VerificationDocumentSid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /marketplace/AvailableAddOns/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list dependentProperties: - document_permission: '{service_sid: service_sid, document_sid: sid}' - parent: /Services/{Sid} - post: - description: '' - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSyncDocument - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSyncDocumentRequest - properties: - UniqueName: - type: string - description: '' - Data: - description: '' - get: - description: '' - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 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: ListSyncDocumentResponse - properties: - documents: - type: array - items: - $ref: '#/components/schemas/preview.sync.service.document' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListSyncDocument - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] + extensions: + mapping: + available_add_on_sid: sid + resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions pathType: instance - parent: /Services/{ServiceSid}/Documents/{Sid} - mountName: document_permissions get: - description: Fetch a specific Sync Document Permission. - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: DocumentSid - in: path - description: Identifier of the Sync Document. Either a SID or a unique name. - schema: - type: string - required: true - - name: Identity - in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchSyncDocumentPermission - x-maturity: - - Preview - delete: - description: Delete a specific Sync Document Permission. - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: DocumentSid - in: path - description: Identifier of the Sync Document. Either a SID or a unique name. - schema: - type: string - required: true - - name: Identity - in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteSyncDocumentPermission - x-maturity: - - Preview - post: - description: Update an identity's access to a specific Sync Document. + description: Fetch an instance of an Add-on currently available to be installed. + tags: + - PreviewMarketplaceAvailableAddOn parameters: - - name: ServiceSid + - name: Sid in: path - description: The unique SID identifier of the Sync Service Instance. + description: The SID of the AvailableAddOn resource to fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: DocumentSid - in: path - description: Identifier of the Sync Document. Either a SID or a unique name. - schema: - type: string - required: true - - name: Identity - in: path - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - schema: - type: string + pattern: ^XB[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.marketplace.available_add_on' + examples: + fetch: + value: + sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + pricing_type: per minute + configuration_schema: + type: object + properties: + bad_words: + type: boolean + required: + - bad_words + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncDocumentPermission - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateSyncDocumentPermissionRequest - properties: - Read: - type: boolean - description: Boolean flag specifying whether the identity can read - the Sync Document. - Write: - type: boolean - description: Boolean flag specifying whether the identity can update - the Sync Document. - Manage: - type: boolean - description: Boolean flag specifying whether the identity can delete - the Sync Document. - required: - - Read - - Write - - Manage - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: + operationId: FetchMarketplaceAvailableAddOn + /marketplace/AvailableAddOns: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + extensions: + mapping: + available_add_on_sid: sid + resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions pathType: list - parent: /Services/{ServiceSid}/Documents/{Sid} - mountName: document_permissions get: - description: Retrieve a list of all Permissions applying to a Sync Document. + description: Retrieve a list of Add-ons currently available to be installed. + tags: + - PreviewMarketplaceAvailableAddOn parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: DocumentSid - in: path - description: Identifier of the Sync Document. Either a SID or a unique name. - schema: - type: string - required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5221,188 +2941,152 @@ paths: application/json: schema: type: object - title: ListSyncDocumentPermissionResponse + title: ListMarketplaceAvailableAddOnResponse properties: - permissions: + available_add_ons: type: array items: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.marketplace.available_add_on' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + available_add_ons: + - sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + pricing_type: per minute + configuration_schema: + type: object + properties: + bad_words: + type: boolean + required: + - bad_words + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + next_page_url: null + key: available_add_ons + readEmpty: + value: + available_add_ons: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + next_page_url: null + key: available_add_ons description: OK security: - accountSid_authToken: [] - operationId: ListSyncDocumentPermission - x-maturity: - - Preview - /Sync/Services/{Sid}: + operationId: ListMarketplaceAvailableAddOn + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /AvailableAddOns/{Sid} + className: available_add_on_extension pathType: instance - dependentProperties: - document: '{service_sid: sid}' - sync_list: '{service_sid: sid}' - sync_map: '{service_sid: sid}' get: - description: '' - parameters: - - name: Sid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchSyncService - x-maturity: - - Preview - delete: - description: '' + description: Fetch an instance of an Extension for the Available Add-on. + tags: + - PreviewMarketplaceAvailableAddOnExtension parameters: - - name: Sid + - name: AvailableAddOnSid in: path - description: '' + description: The SID of the AvailableAddOn resource with the extension to + fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^XB[0-9a-fA-F]{32}$ required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteSyncService - x-maturity: - - Preview - post: - description: '' - parameters: - name: Sid in: path - description: '' + description: The SID of the AvailableAddOn Extension resource to fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + examples: + fetch: + value: + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncService - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateSyncServiceRequest - properties: - WebhookUrl: - type: string - format: uri - description: '' - FriendlyName: - type: string - description: '' - ReachabilityWebhooksEnabled: - type: boolean - description: '' - AclEnabled: - type: boolean - description: '' - /Sync/Services: + operationId: FetchMarketplaceAvailableAddOnExtension + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /AvailableAddOns/{Sid} + className: available_add_on_extension pathType: list - dependentProperties: - document: '{service_sid: sid}' - sync_list: '{service_sid: sid}' - sync_map: '{service_sid: sid}' - post: - description: '' - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSyncService - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSyncServiceRequest - properties: - FriendlyName: - type: string - description: '' - WebhookUrl: - type: string - format: uri - description: '' - ReachabilityWebhooksEnabled: - type: boolean - description: '' - AclEnabled: - type: boolean - description: '' get: - description: '' + description: Retrieve a list of Extensions for the Available Add-on. + tags: + - PreviewMarketplaceAvailableAddOnExtension 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 @@ -5428,167 +3112,152 @@ paths: application/json: schema: type: object - title: ListSyncServiceResponse + title: ListMarketplaceAvailableAddOnExtensionResponse properties: - services: + extensions: type: array items: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + extensions: + - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions + readEmpty: + value: + extensions: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions description: OK security: - accountSid_authToken: [] - operationId: ListSyncService - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Lists/{Sid}: + operationId: ListMarketplaceAvailableAddOnExtension + /marketplace/InstalledAddOns: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: - sync_list_item: '{service_sid: service_sid, list_sid: sid}' - sync_list_permission: '{service_sid: service_sid, list_sid: sid}' - parent: /Services/{Sid} - mountName: sync_lists - get: - description: '' - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: Sid - in: path - description: '' - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchSyncSyncList - x-maturity: - - Preview - delete: - description: '' - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: Sid - in: path - description: '' - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteSyncSyncList - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Lists: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] + extensions: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions + usage: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage pathType: list - dependentProperties: - sync_list_item: '{service_sid: service_sid, list_sid: sid}' - sync_list_permission: '{service_sid: service_sid, list_sid: sid}' - parent: /Services/{Sid} - mountName: sync_lists post: - description: '' - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true + description: Install an Add-on for the Account specified. + tags: + - PreviewMarketplaceInstalledAddOn responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + examples: + create: + value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription_1 + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateSyncSyncList - x-maturity: - - Preview + operationId: CreateMarketplaceInstalledAddOn requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncListRequest + 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: '' + 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: '' + description: Retrieve a list of Add-ons currently installed on this Account. + tags: + - PreviewMarketplaceInstalledAddOn parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5614,260 +3283,348 @@ paths: application/json: schema: type: object - title: ListSyncSyncListResponse + title: ListMarketplaceInstalledAddOnResponse properties: - lists: + installed_add_ons: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + installed_add_ons: + - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + next_page_url: null + key: installed_add_ons + readEmpty: + value: + installed_add_ons: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + next_page_url: null + key: installed_add_ons description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncList - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: + operationId: ListMarketplaceInstalledAddOn + /marketplace/InstalledAddOns/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + extensions: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions + usage: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage pathType: instance - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_items - get: - description: '' + delete: + description: Remove an Add-on installation from your account + tags: + - PreviewMarketplaceInstalledAddOn parameters: - - name: ServiceSid + - name: Sid in: path - description: '' + description: The SID of the InstalledAddOn resource to delete. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^XE[0-9a-fA-F]{32}$ required: true - - name: ListSid + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteMarketplaceInstalledAddOn + get: + description: Fetch an instance of an Add-on currently installed on this Account. + tags: + - PreviewMarketplaceInstalledAddOn + parameters: + - name: Sid in: path - description: '' + description: The SID of the InstalledAddOn resource to fetch. schema: type: string - required: true - - name: Index - in: path - description: '' - schema: - type: integer + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + examples: + fetch: + value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncListItem - x-maturity: - - Preview - delete: - description: '' + operationId: FetchMarketplaceInstalledAddOn + post: + description: Update an Add-on installation for the Account specified. + tags: + - PreviewMarketplaceInstalledAddOn parameters: - - name: ServiceSid + - name: Sid in: path - description: '' + description: The SID of the InstalledAddOn resource to update. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: '' - schema: - type: string - required: true - - name: Index - in: path - description: '' - schema: - type: integer + pattern: ^XE[0-9a-fA-F]{32}$ required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + examples: + update: + value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription_2 + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK security: - accountSid_authToken: [] - operationId: DeleteSyncSyncListItem - x-maturity: - - Preview - post: - description: '' + operationId: UpdateMarketplaceInstalledAddOn + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateMarketplaceInstalledAddOnRequest + properties: + Configuration: + description: Valid JSON object that conform to the configuration + schema exposed by the associated AvailableAddOn resource. This + is only required by Add-ons that need to be configured + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + examples: + update: + value: + Configuration: '{"bad_words": true}' + UniqueName: voicebase_high_accuracy_transcription_2 + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /InstalledAddOns/{Sid} + className: installed_add_on_extension + pathType: instance + get: + description: Fetch an instance of an Extension for the Installed Add-on. + tags: + - PreviewMarketplaceInstalledAddOnExtension parameters: - - name: ServiceSid + - name: InstalledAddOnSid in: path - description: '' + description: The SID of the InstalledAddOn resource with the extension to + fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^XE[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: Sid in: path - description: '' + 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 - - name: Index - in: path - description: '' - schema: - type: integer - required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + examples: + fetch: + value: + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: true + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncListItem - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateSyncSyncListItemRequest - properties: - Data: - description: '' - required: - - Data - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_items + operationId: FetchMarketplaceInstalledAddOnExtension post: - description: '' + description: Update an Extension for an Add-on installation. + tags: + - PreviewMarketplaceInstalledAddOnExtension parameters: - - name: ServiceSid + - name: InstalledAddOnSid in: path - description: '' + description: The SID of the InstalledAddOn resource with the extension to + update. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^XE[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: Sid in: path - description: '' + description: The SID of the InstalledAddOn Extension resource to update. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - description: Created + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + examples: + update: + value: + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: false + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK security: - accountSid_authToken: [] - operationId: CreateSyncSyncListItem - x-maturity: - - Preview + operationId: UpdateMarketplaceInstalledAddOnExtension requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncListItemRequest + title: UpdateMarketplaceInstalledAddOnExtensionRequest properties: - Data: - description: '' + Enabled: + type: boolean + description: Whether the Extension should be invoked. required: - - Data + - Enabled + examples: + update: + value: + Enabled: false + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /InstalledAddOns/{Sid} + className: installed_add_on_extension + pathType: list get: - description: '' + description: Retrieve a list of Extensions for the Installed Add-on. + tags: + - PreviewMarketplaceInstalledAddOnExtension parameters: - - name: ServiceSid + - name: InstalledAddOnSid in: path - description: '' + description: The SID of the InstalledAddOn resource with the extensions to + read. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: '' - schema: - type: string + pattern: ^XE[0-9a-fA-F]{32}$ required: true - - name: Order - in: query - description: '' - schema: - type: string - $ref: '#/components/schemas/sync_list_item_enum_query_result_order' - - name: From - in: query - description: '' - schema: - type: string - - name: Bounds - in: query - description: '' - schema: - type: string - $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5893,207 +3650,339 @@ paths: application/json: schema: type: object - title: ListSyncSyncListItemResponse + title: ListMarketplaceInstalledAddOnExtensionResponse properties: - items: + extensions: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + extensions: + - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: true + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions + readEmpty: + value: + extensions: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncListItem - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: + operationId: ListMarketplaceInstalledAddOnExtension + /wireless/Commands/{Sid}: servers: - 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 get: - description: Fetch a specific Sync List Permission. + description: '' + tags: + - PreviewWirelessCommand parameters: - - name: ServiceSid + - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: Identifier of the Sync List. Either a SID or a unique name. - schema: - type: string - required: true - - name: Identity - in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. - schema: - type: string + pattern: ^DC[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + $ref: '#/components/schemas/preview.wireless.command' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: command_mode + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: direction + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: status + url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncListPermission - x-maturity: - - Preview - delete: - description: Delete a specific Sync List Permission. + operationId: FetchWirelessCommand + /wireless/Commands: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + pathType: list + get: + description: '' + tags: + - PreviewWirelessCommand parameters: - - name: ServiceSid - in: path + - name: Device + in: query description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: Identifier of the Sync List. Either a SID or a unique name. + examples: + readEmpty: + value: device + readFull: + value: device + - name: Sim + in: query + description: '' schema: type: string - required: true - - name: Identity - in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + examples: + readEmpty: + value: sim + readFull: + value: sim + - name: Status + in: query + description: '' schema: type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteSyncSyncListPermission - x-maturity: - - Preview - post: - description: Update an identity's access to a specific Sync List. - parameters: - - name: ServiceSid - in: path - description: The unique SID identifier of the Sync Service Instance. + examples: + readEmpty: + value: status + readFull: + value: status + - name: Direction + in: query + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: Identifier of the Sync List. Either a SID or a unique name. + examples: + readEmpty: + value: direction + readFull: + value: direction + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. schema: - type: string - required: true - - name: Identity - in: path - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. schema: type: string - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + type: object + title: ListWirelessCommandResponse + properties: + commands: + type: array + items: + $ref: '#/components/schemas/preview.wireless.command' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readEmpty: + value: + commands: [] + meta: + first_page_url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 + key: commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 + readFull: + value: + commands: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: command_mode + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: direction + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: status + url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 + key: commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncListPermission - x-maturity: - - Preview + operationId: ListWirelessCommand + post: + description: '' + tags: + - PreviewWirelessCommand + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.command' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: command_mode + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: direction + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: status + url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateWirelessCommand requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncListPermissionRequest + title: CreateWirelessCommandRequest properties: - Read: - type: boolean - description: Boolean flag specifying whether the identity can read - the Sync List. - Write: - type: boolean - description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync List. - Manage: - type: boolean - description: Boolean flag specifying whether the identity can delete - the Sync List. + Command: + type: string + description: '' + Device: + type: string + description: '' + Sim: + type: string + description: '' + CallbackMethod: + type: string + description: '' + CallbackUrl: + type: string + format: uri + description: '' + CommandMode: + type: string + description: '' + IncludeSid: + type: string + description: '' required: - - Read - - Write - - Manage - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: + - Command + examples: + create: + value: + CallbackMethod: callback_method + CallbackUrl: http://www.example.com + Command: command + CommandMode: command_mode + Device: device + Sim: sim + IncludeSid: include_sid + /wireless/RatePlans: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: list - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_permissions get: - description: Retrieve a list of all Permissions applying to a Sync List. - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: Identifier of the Sync List. Either a SID or a unique name. - schema: - type: string - required: true + description: '' + tags: + - PreviewWirelessRatePlan + parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6119,65 +4008,221 @@ paths: application/json: schema: type: object - title: ListSyncSyncListPermissionResponse + title: ListWirelessRatePlanResponse properties: - permissions: + rate_plans: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + $ref: '#/components/schemas/preview.wireless.rate_plan' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + key: rate_plans + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + rate_plans: [] + readFull: + value: + meta: + first_page_url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + key: rate_plans + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + rate_plans: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncListPermission - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Maps/{Sid}: + operationId: ListWirelessRatePlan + post: + description: '' + tags: + - PreviewWirelessRatePlan + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateWirelessRatePlan + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateWirelessRatePlanRequest + properties: + UniqueName: + type: string + description: '' + FriendlyName: + type: string + description: '' + DataEnabled: + type: boolean + description: '' + DataLimit: + type: integer + description: '' + DataMetering: + type: string + description: '' + MessagingEnabled: + type: boolean + description: '' + VoiceEnabled: + type: boolean + description: '' + CommandsEnabled: + type: boolean + description: '' + NationalRoamingEnabled: + type: boolean + description: '' + InternationalRoaming: + type: array + items: + type: string + description: '' + examples: + create: + value: + UniqueName: unique_name + DataEnabled: true + DataLimit: 1000 + DataMetering: pooled + MessagingEnabled: true + VoiceEnabled: true + FriendlyName: friendly_name + NationalRoamingEnabled: true + InternationalRoaming: + - data + - voice + - messaging + Status: status + /wireless/RatePlans/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: instance - dependentProperties: - sync_map_item: '{service_sid: service_sid, map_sid: sid}' - sync_map_permission: '{service_sid: service_sid, map_sid: sid}' - parent: /Services/{Sid} - mountName: sync_maps get: description: '' + tags: + - PreviewWirelessRatePlan parameters: - - name: ServiceSid + - name: Sid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchWirelessRatePlan + post: + description: '' + tags: + - PreviewWirelessRatePlan + parameters: - name: Sid in: path description: '' @@ -6189,25 +4234,54 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' + $ref: '#/components/schemas/preview.wireless.rate_plan' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMap - x-maturity: - - Preview + operationId: UpdateWirelessRatePlan + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateWirelessRatePlanRequest + properties: + UniqueName: + type: string + description: '' + FriendlyName: + type: string + description: '' + examples: + update: + value: + UniqueName: unique_name + FriendlyName: friendly_name delete: description: '' + tags: + - PreviewWirelessRatePlan parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - name: Sid in: path description: '' @@ -6219,67 +4293,292 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMap - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Maps: + operationId: DeleteWirelessRatePlan + /wireless/Sims/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list dependentProperties: - sync_map_item: '{service_sid: service_sid, map_sid: sid}' - sync_map_permission: '{service_sid: service_sid, map_sid: sid}' - parent: /Services/{Sid} - mountName: sync_maps + usage: + mapping: + sim_sid: sid + resource_url: /wireless/Sims/{sim_sid}/Usage + pathType: instance + get: + description: '' + tags: + - PreviewWirelessSim + parameters: + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.sim' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: http_method + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + sms_fallback_method: http_method + sms_fallback_url: http://www.example.com + sms_method: http_method + sms_url: http://www.example.com + voice_fallback_method: http_method + voice_fallback_url: http://www.example.com + voice_method: http_method + voice_url: http://www.example.com + links: + usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage + rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: status + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchWirelessSim post: description: '' + tags: + - PreviewWirelessSim parameters: - - name: ServiceSid + - name: Sid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' - description: Created + $ref: '#/components/schemas/preview.wireless.sim' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: http_method + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage + rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: status + sms_fallback_method: http_method + sms_fallback_url: http://www.example.com + sms_method: http_method + sms_url: http://www.example.com + voice_fallback_method: http_method + voice_fallback_url: http://www.example.com + voice_method: http_method + voice_url: http://www.example.com + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK security: - accountSid_authToken: [] - operationId: CreateSyncSyncMap - x-maturity: - - Preview + operationId: UpdateWirelessSim requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncMapRequest + title: UpdateWirelessSimRequest properties: UniqueName: type: string description: '' + CallbackMethod: + type: string + description: '' + CallbackUrl: + type: string + format: uri + description: '' + FriendlyName: + type: string + description: '' + RatePlan: + type: string + description: '' + Status: + type: string + description: '' + CommandsCallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: '' + CommandsCallbackUrl: + type: string + format: uri + description: '' + SmsFallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: '' + SmsFallbackUrl: + type: string + format: uri + description: '' + SmsMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: '' + SmsUrl: + type: string + format: uri + description: '' + VoiceFallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: '' + VoiceFallbackUrl: + type: string + format: uri + description: '' + VoiceMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: '' + VoiceUrl: + type: string + format: uri + description: '' + examples: + update: + value: + UniqueName: unique_name + CallbackMethod: callback_method + CallbackUrl: http://www.example.com + CommandsCallbackMethod: http_method + CommandsCallbackUrl: http://www.example.com + VoiceMethod: http_method + VoiceUrl: http://www.example.com + VoiceFallbackMethod: http_method + VoiceFallbackUrl: http://www.example.com + SmsMethod: http_method + SmsUrl: http://www.example.com + SmsFallbackMethod: http_method + SmsFallbackUrl: http://www.example.com + FriendlyName: friendly_name + RatePlan: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Status: status + /wireless/Sims: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + usage: + mapping: + sim_sid: sid + resource_url: /wireless/Sims/{sim_sid}/Usage + pathType: list get: description: '' + tags: + - PreviewWirelessSim parameters: - - name: ServiceSid - in: path + - name: Status + in: query + description: '' + schema: + type: string + examples: + readEmpty: + value: status + readFull: + value: status + - name: Iccid + in: query + description: '' + schema: + type: string + examples: + readEmpty: + value: iccid + readFull: + value: iccid + - name: RatePlan + in: query + description: '' + schema: + type: string + examples: + readEmpty: + value: rate_plan + readFull: + value: rate_plan + - name: EId + in: query + description: '' + schema: + type: string + - name: SimRegistrationCode + in: query description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6305,197 +4604,305 @@ paths: application/json: schema: type: object - title: ListSyncSyncMapResponse + title: ListWirelessSimResponse properties: - maps: + sims: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map' + $ref: '#/components/schemas/preview.wireless.sim' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sims: [] + meta: + first_page_url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + readFull: + value: + sims: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: http_method + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage + rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: status + sms_fallback_method: http_method + sms_fallback_url: http://www.example.com + sms_method: http_method + sms_url: http://www.example.com + voice_fallback_method: http_method + voice_fallback_url: http://www.example.com + voice_method: http_method + voice_url: http://www.example.com + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMap - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: + operationId: ListWirelessSim + /wireless/Sims/{SimSid}/Usage: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Sims/{Sid} pathType: instance - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_items get: description: '' + tags: + - PreviewWirelessUsage parameters: - - name: ServiceSid + - name: SimSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid - in: path + - name: End + in: query description: '' schema: type: string - required: true - - name: Key - in: path + examples: + fetch: + value: end + - name: Start + in: query description: '' schema: type: string - required: true + examples: + fetch: + value: start responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.wireless.sim.usage' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + commands_costs: {} + commands_usage: {} + data_costs: {} + data_usage: {} + sim_unique_name: sim_unique_name + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + period: {} + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMapItem - x-maturity: - - Preview - delete: - description: '' + operationId: FetchWirelessUsage + /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Fleets/{Sid} + pathType: instance + get: + description: Fetch information about a specific Certificate credential in the + Fleet. + tags: + - PreviewDeployedDevicesCertificate parameters: - - name: ServiceSid + - name: FleetSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: Sid in: path - description: '' + description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ required: true - - name: Key + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + examples: + fetch: + value: + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchDeployedDevicesCertificate + delete: + description: Unregister a specific Certificate credential from the Fleet, effectively + disallowing any inbound client connections that are presenting it. + tags: + - PreviewDeployedDevicesCertificate + parameters: + - name: FleetSid in: path description: '' schema: type: string required: true - - name: If-Match - in: header - description: The If-Match HTTP request header + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMapItem - x-maturity: - - Preview + operationId: DeleteDeployedDevicesCertificate post: - description: '' + description: Update the given properties of a specific Certificate credential + in the Fleet, giving it a friendly name or assigning to a Device. + tags: + - PreviewDeployedDevicesCertificate parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid + - name: FleetSid in: path description: '' schema: type: string required: true - - name: Key + - name: Sid in: path - description: '' + description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + examples: + update: + value: + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncMapItem - x-maturity: - - Preview + operationId: UpdateDeployedDevicesCertificate requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncMapItemRequest + title: UpdateDeployedDevicesCertificateRequest properties: - Data: - description: '' - required: - - Data - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Certificate credential, up to 256 characters long. + DeviceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of an existing + Device to become authenticated with this Certificate credential. + examples: + update: + value: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + /DeployedDevices/Fleets/{FleetSid}/Certificates: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Fleets/{Sid} pathType: list - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_items post: - description: '' + description: Enroll a new Certificate credential to the Fleet, optionally giving + it a friendly name and assigning to a Device. + tags: + - PreviewDeployedDevicesCertificate parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid + - name: FleetSid in: path description: '' schema: @@ -6506,63 +4913,74 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + examples: + create: + value: + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateSyncSyncMapItem - x-maturity: - - Preview + operationId: CreateDeployedDevicesCertificate requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncMapItemRequest + title: CreateDeployedDevicesCertificateRequest properties: - Key: + CertificateData: type: string - description: '' - Data: - description: '' + description: Provides a URL encoded representation of the public + certificate in PEM format. + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Certificate credential, up to 256 characters long. + DeviceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of an existing + Device to become authenticated with this Certificate credential. required: - - Key - - Data + - CertificateData + examples: + create: + value: + CertificateData: 12345678abcdef + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name get: - description: '' + description: Retrieve a list of all Certificate credentials belonging to the + Fleet. + tags: + - PreviewDeployedDevicesCertificate parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid + - name: FleetSid in: path description: '' schema: type: string required: true - - name: Order - in: query - description: '' - schema: - type: string - $ref: '#/components/schemas/sync_map_item_enum_query_result_order' - - name: From - in: query - description: '' - schema: - type: string - - name: Bounds + - name: DeviceSid in: query - description: '' + description: Filters the resulting list of Certificates by a unique string + identifier of an authenticated Device. schema: type: string - $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6588,400 +5006,293 @@ paths: application/json: schema: type: object - title: ListSyncSyncMapItemResponse + title: ListDeployedDevicesCertificateResponse properties: - items: + certificates: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + certificates: [] + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + key: certificates + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + readFull: + value: + certificates: + - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + key: certificates + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMapItem - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: + operationId: ListDeployedDevicesCertificate + /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Fleets/{Sid} pathType: instance - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_permissions get: - description: Fetch a specific Sync Map Permission. + description: Fetch information about a specific Deployment in the Fleet. + tags: + - PreviewDeployedDevicesDeployment parameters: - - name: ServiceSid + - name: FleetSid in: path description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid - in: path - description: Identifier of the Sync Map. Either a SID or a unique name. schema: type: string required: true - - name: Identity + - name: Sid in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + examples: + fetch: + value: + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMapPermission - x-maturity: - - Preview + operationId: FetchDeployedDevicesDeployment delete: - description: Delete a specific Sync Map Permission. + description: Delete a specific Deployment from the Fleet, leaving associated + devices effectively undeployed. + tags: + - PreviewDeployedDevicesDeployment parameters: - - name: ServiceSid + - name: FleetSid in: path description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid - in: path - description: Identifier of the Sync Map. Either a SID or a unique name. schema: type: string required: true - - name: Identity + - name: Sid in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMapPermission - x-maturity: - - Preview + operationId: DeleteDeployedDevicesDeployment post: - description: Update an identity's access to a specific Sync Map. + description: Update the given properties of a specific Deployment credential + in the Fleet, giving it a friendly name or linking to a specific Twilio Sync + service instance. + tags: + - PreviewDeployedDevicesDeployment parameters: - - name: ServiceSid - in: path - description: The unique SID identifier of the Sync Service Instance. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid + - name: FleetSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: '' schema: type: string required: true - - name: Identity + - name: Sid in: path - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. + description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + examples: + update: + value: + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncMapPermission - x-maturity: - - Preview + operationId: UpdateDeployedDevicesDeployment requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncMapPermissionRequest + title: UpdateDeployedDevicesDeploymentRequest properties: - Read: - type: boolean - description: Boolean flag specifying whether the identity can read - the Sync Map. - Write: - type: boolean - description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync Map. - Manage: - type: boolean - description: Boolean flag specifying whether the identity can delete - the Sync Map. - required: - - Read - - Write - - Manage - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Deployment, up to 64 characters long + SyncServiceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of the Twilio + Sync service instance that will be linked to and accessible by + this Deployment. + examples: + update: + value: + FriendlyName: friendly_name + SyncServiceSid: sync_service_sid + /DeployedDevices/Fleets/{FleetSid}/Deployments: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Fleets/{Sid} pathType: list - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_permissions - get: - description: Retrieve a list of all Permissions applying to a Sync Map. - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid - in: path - description: Identifier of the Sync Map. Either a SID or a unique name. - schema: - type: string - required: true - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 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: ListSyncSyncMapPermissionResponse - properties: - permissions: - type: array - items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListSyncSyncMapPermission - x-maturity: - - Preview - /understand/Assistants/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - dependentProperties: - field_type: '{assistant_sid: sid}' - task: '{assistant_sid: sid}' - model_build: '{assistant_sid: sid}' - query: '{assistant_sid: sid}' - assistant_fallback_actions: '{assistant_sid: sid}' - assistant_initiation_actions: '{assistant_sid: sid}' - dialogue: '{assistant_sid: sid}' - style_sheet: '{assistant_sid: sid}' - get: - description: '' - parameters: - - name: Sid - in: path - description: A 34 character string that uniquely identifies this resource. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUnderstandAssistant - x-maturity: - - Preview post: - description: '' + description: Create a new Deployment in the Fleet, optionally giving it a friendly + name and linking to a specific Twilio Sync service instance. + tags: + - PreviewDeployedDevicesDeployment parameters: - - name: Sid + - name: FleetSid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant' - description: OK + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + examples: + create: + value: + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created security: - accountSid_authToken: [] - operationId: UpdateUnderstandAssistant - x-maturity: - - Preview + operationId: CreateDeployedDevicesDeployment requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandAssistantRequest + title: CreateDeployedDevicesDeploymentRequest properties: FriendlyName: type: string - description: A text description for the Assistant. It is non-unique - and can up to 255 characters long. - LogQueries: - type: boolean - description: A boolean that specifies whether queries should be - logged for 30 days further training. If false, no queries will - be stored, if true, queries will be stored for 30 days and deleted - thereafter. Defaults to true if no value is provided. - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - CallbackUrl: - type: string - format: uri - description: A user-provided URL to send event callbacks to. - CallbackEvents: + description: Provides a human readable descriptive text for this + Deployment, up to 256 characters long. + SyncServiceSid: type: string - description: Space-separated list of callback events that will trigger - callbacks. - FallbackActions: - description: The JSON actions to be executed when the user's input - is not recognized as matching any Task. - InitiationActions: - description: The JSON actions to be executed on inbound phone calls - when the Assistant has to say something first. - StyleSheet: - description: The JSON object that holds the style sheet for the - assistant - delete: - description: '' + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of the Twilio + Sync service instance that will be linked to and accessible by + this Deployment. + examples: + create: + value: + FriendlyName: friendly_name + SyncServiceSid: sync_service_sid + get: + description: Retrieve a list of all Deployments belonging to the Fleet. + tags: + - PreviewDeployedDevicesDeployment parameters: - - name: Sid + - name: FleetSid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteUnderstandAssistant - x-maturity: - - Preview - /understand/Assistants: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - dependentProperties: - field_type: '{assistant_sid: sid}' - task: '{assistant_sid: sid}' - model_build: '{assistant_sid: sid}' - query: '{assistant_sid: sid}' - assistant_fallback_actions: '{assistant_sid: sid}' - assistant_initiation_actions: '{assistant_sid: sid}' - dialogue: '{assistant_sid: sid}' - style_sheet: '{assistant_sid: sid}' - get: - description: '' - parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -7007,285 +5318,449 @@ paths: application/json: schema: type: object - title: ListUnderstandAssistantResponse + title: ListDeployedDevicesDeploymentResponse properties: - assistants: + deployments: type: array items: - $ref: '#/components/schemas/preview.understand.assistant' + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + deployments: [] + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + key: deployments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + readFull: + value: + deployments: + - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + key: deployments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandAssistant - x-maturity: - - Preview - post: - description: '' - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandAssistant - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandAssistantRequest - properties: - FriendlyName: - type: string - description: A text description for the Assistant. It is non-unique - and can up to 255 characters long. - LogQueries: - type: boolean - description: A boolean that specifies whether queries should be - logged for 30 days further training. If false, no queries will - be stored, if true, queries will be stored for 30 days and deleted - thereafter. Defaults to true if no value is provided. - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - CallbackUrl: - type: string - format: uri - description: A user-provided URL to send event callbacks to. - CallbackEvents: - type: string - description: Space-separated list of callback events that will trigger - callbacks. - FallbackActions: - description: The JSON actions to be executed when the user's input - is not recognized as matching any Task. - InitiationActions: - description: The JSON actions to be executed on inbound phone calls - when the Assistant has to say something first. - StyleSheet: - description: The JSON object that holds the style sheet for the - assistant - /understand/Assistants/{AssistantSid}/FallbackActions: + operationId: ListDeployedDevicesDeployment + /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Fleets/{Sid} pathType: instance - parent: /Assistants/{Sid} - mountName: assistant_fallback_actions - className: assistant_fallback_actions get: - description: '' + description: Fetch information about a specific Device in the Fleet. + tags: + - PreviewDeployedDevicesDevice parameters: - - name: AssistantSid + - name: FleetSid in: path description: '' schema: type: string required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Device resource. + schema: + type: string + required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + examples: + fetch: + value: + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandAssistantFallbackActions - x-maturity: - - Preview + operationId: FetchDeployedDevicesDevice + delete: + description: Delete a specific Device from the Fleet, also removing it from + associated Deployments. + tags: + - PreviewDeployedDevicesDevice + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Device resource. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteDeployedDevicesDevice post: - description: '' + description: Update the given properties of a specific Device in the Fleet, + giving it a friendly name, assigning to a Deployment, or a human identity. + tags: + - PreviewDeployedDevicesDevice parameters: - - name: AssistantSid + - name: FleetSid in: path description: '' schema: type: string required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Device resource. + schema: + type: string + required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + examples: + update: + value: + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandAssistantFallbackActions - x-maturity: - - Preview + operationId: UpdateDeployedDevicesDevice requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandAssistantFallbackActionsRequest + title: UpdateDeployedDevicesDeviceRequest properties: - FallbackActions: + FriendlyName: + type: string + description: Provides a human readable descriptive text to be assigned + to this Device, up to 256 characters long. + Identity: + type: string + description: Provides an arbitrary string identifier representing + a human user to be associated with this Device, up to 256 characters + long. + DeploymentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + description: Specifies the unique string identifier of the Deployment + group that this Device is going to be associated with. + Enabled: + type: boolean description: '' - /understand/Assistants/{AssistantSid}/InitiationActions: + examples: + update: + value: + FriendlyName: friendly_name + Identity: identity + /DeployedDevices/Fleets/{FleetSid}/Devices: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance - parent: /Assistants/{Sid} - mountName: assistant_initiation_actions - className: assistant_initiation_actions - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUnderstandAssistantInitiationActions - x-maturity: - - Preview + parent: /Fleets/{Sid} + pathType: list post: - description: '' + description: Create a new Device in the Fleet, optionally giving it a unique + name, friendly name, and assigning to a Deployment and/or human identity. + tags: + - PreviewDeployedDevicesDevice parameters: - - name: AssistantSid + - name: FleetSid in: path description: '' schema: type: string required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' - description: OK + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + examples: + create: + value: + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created security: - accountSid_authToken: [] - operationId: UpdateUnderstandAssistantInitiationActions - x-maturity: - - Preview + operationId: CreateDeployedDevicesDevice requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandAssistantInitiationActionsRequest + title: CreateDeployedDevicesDeviceRequest properties: - InitiationActions: + UniqueName: + type: string + description: Provides a unique and addressable name to be assigned + to this Device, to be used in addition to SID, up to 128 characters + long. + FriendlyName: + type: string + description: Provides a human readable descriptive text to be assigned + to this Device, up to 256 characters long. + Identity: + type: string + description: Provides an arbitrary string identifier representing + a human user to be associated with this Device, up to 256 characters + long. + DeploymentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + description: Specifies the unique string identifier of the Deployment + group that this Device is going to be associated with. + Enabled: + type: boolean description: '' - /understand/Assistants/{AssistantSid}/Dialogues/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Assistants/{Sid} + examples: + create: + value: + FriendlyName: friendly_name + UniqueName: unique_name + Identity: identity get: - description: '' + description: Retrieve a list of all Devices belonging to the Fleet. + tags: + - PreviewDeployedDevicesDevice parameters: - - name: AssistantSid + - name: FleetSid in: path description: '' schema: type: string required: true - - name: Sid - in: path - description: '' + - name: DeploymentSid + in: query + description: Filters the resulting list of Devices by a unique string identifier + of the Deployment they are associated with. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. schema: type: string - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.dialogue' + type: object + title: ListDeployedDevicesDeviceResponse + properties: + devices: + type: array + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + 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: + devices: [] + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + key: devices + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + readFull: + value: + devices: + - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + key: devices + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandDialogue - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/Dialogues: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /Assistants/{Sid} - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: + operationId: ListDeployedDevicesDevice + /DeployedDevices/Fleets/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + devices: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Devices + deployments: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Deployments + certificates: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Certificates + keys: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Keys pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: - description: '' + description: Fetch information about a specific Fleet in your account. + tags: + - PreviewDeployedDevicesFleet parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Field. - schema: - type: string - required: true - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. schema: type: string required: true @@ -7294,65 +5769,182 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task.field' + $ref: '#/components/schemas/preview.deployed_devices.fleet' + examples: + fetch: + value: + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandField - x-maturity: - - Preview + operationId: FetchDeployedDevicesFleet delete: - description: '' + description: 'Delete a specific Fleet from your account, also destroys all nested + resources: Devices, Deployments, Certificates, Keys.' + tags: + - PreviewDeployedDevicesFleet parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid + - name: Sid in: path - description: The unique ID of the Task associated with this Field. + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. schema: type: string required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteDeployedDevicesFleet + post: + description: Update the friendly name property of a specific Fleet in your account. + tags: + - PreviewDeployedDevicesFleet + parameters: - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. schema: type: string required: true responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + examples: + update: + value: + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys + description: OK security: - accountSid_authToken: [] - operationId: DeleteUnderstandField - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: + operationId: UpdateDeployedDevicesFleet + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateDeployedDevicesFleetRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Fleet, up to 256 characters long. + DefaultDeploymentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + description: Provides a string identifier of a Deployment that is + going to be used as a default one for this Fleet. + examples: + update: + value: + FriendlyName: friendly_name + DefaultDeploymentSid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /DeployedDevices/Fleets: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + devices: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Devices + deployments: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Deployments + certificates: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Certificates + keys: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Keys pathType: list - parent: /Assistants/{AssistantSid}/Tasks/{Sid} + post: + description: Create a new Fleet for scoping of deployed devices within your + account. + tags: + - PreviewDeployedDevicesFleet + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + examples: + create: + value: + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys + description: Created + security: + - accountSid_authToken: [] + operationId: CreateDeployedDevicesFleet + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateDeployedDevicesFleetRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Fleet, up to 256 characters long. + examples: + create: + value: + FriendlyName: friendly_name get: - description: '' + description: Retrieve a list of all Fleets belonging to your account. + tags: + - PreviewDeployedDevicesFleet parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Field. - schema: - type: string - required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -7378,102 +5970,133 @@ paths: application/json: schema: type: object - title: ListUnderstandFieldResponse + title: ListDeployedDevicesFleetResponse properties: - fields: + fleets: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.task.field' + $ref: '#/components/schemas/preview.deployed_devices.fleet' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + fleets: [] + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 + key: fleets + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 + readFull: + value: + fleets: + - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 + key: fleets + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandField - x-maturity: - - Preview - post: - description: '' + operationId: ListDeployedDevicesFleet + /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Fleets/{Sid} + pathType: instance + get: + description: Fetch information about a specific Key credential in the Fleet. + tags: + - PreviewDeployedDevicesKey parameters: - - name: AssistantSid + - name: FleetSid in: path - description: The unique ID of the parent Assistant. + description: '' schema: type: string required: true - - name: TaskSid + - name: Sid in: path - description: The unique ID of the Task associated with this Field. + description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task.field' - description: Created + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + examples: + fetch: + value: + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK security: - accountSid_authToken: [] - operationId: CreateUnderstandField - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandFieldRequest - properties: - FieldType: - type: string - description: The unique name or sid of the FieldType. It can be - any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) - or the unique_name or the Field Type sid of a custom Field Type. - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - required: - - FieldType - - UniqueName - /understand/Assistants/{AssistantSid}/FieldTypes/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - dependentProperties: - field_value: '{assistant_sid: assistant_sid, field_type_sid: sid}' - parent: /Assistants/{Sid} - get: - description: '' + operationId: FetchDeployedDevicesKey + delete: + description: Delete a specific Key credential from the Fleet, effectively disallowing + any inbound client connections that are presenting it. + tags: + - PreviewDeployedDevicesKey parameters: - - name: AssistantSid + - name: FleetSid in: path description: '' schema: @@ -7481,26 +6104,27 @@ paths: required: true - name: Sid in: path - description: '' + description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ required: true responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: FetchUnderstandFieldType - x-maturity: - - Preview + operationId: DeleteDeployedDevicesKey post: - description: '' + description: Update the given properties of a specific Key credential in the + Fleet, giving it a friendly name or assigning to a Device. + tags: + - PreviewDeployedDevicesKey parameters: - - name: AssistantSid + - name: FleetSid in: path description: '' schema: @@ -7508,80 +6132,144 @@ paths: required: true - name: Sid in: path - description: '' + description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + examples: + update: + value: + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandFieldType - x-maturity: - - Preview + operationId: UpdateDeployedDevicesKey requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandFieldTypeRequest + title: UpdateDeployedDevicesKeyRequest properties: FriendlyName: type: string - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - UniqueName: + description: Provides a human readable descriptive text for this + Key credential, up to 256 characters long. + DeviceSid: type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - delete: - description: '' + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of an existing + Device to become authenticated with this Key credential. + examples: + update: + value: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + /DeployedDevices/Fleets/{FleetSid}/Keys: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Fleets/{Sid} + pathType: list + post: + description: Create a new Key credential in the Fleet, optionally giving it + a friendly name and assigning to a Device. + tags: + - PreviewDeployedDevicesKey parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid + - name: FleetSid in: path description: '' schema: type: string required: true responses: - '204': - description: The resource was deleted successfully. + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + examples: + create: + value: + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created security: - accountSid_authToken: [] - operationId: DeleteUnderstandFieldType - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/FieldTypes: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - dependentProperties: - field_value: '{assistant_sid: assistant_sid, field_type_sid: sid}' - parent: /Assistants/{Sid} + operationId: CreateDeployedDevicesKey + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateDeployedDevicesKeyRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Key credential, up to 256 characters long. + DeviceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of an existing + Device to become authenticated with this Key credential. + examples: + create: + value: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name get: - description: '' + description: Retrieve a list of all Keys credentials belonging to the Fleet. + tags: + - PreviewDeployedDevicesKey parameters: - - name: AssistantSid + - name: FleetSid in: path description: '' schema: type: string required: true + - name: DeviceSid + in: query + description: Filters the resulting list of Keys by a unique string identifier + of an authenticated Device. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -7607,102 +6295,98 @@ paths: application/json: schema: type: object - title: ListUnderstandFieldTypeResponse + title: ListDeployedDevicesKeyResponse properties: - field_types: + keys: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.field_type' + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + keys: [] + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + key: keys + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + readFull: + value: + keys: + - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + key: keys + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandFieldType - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandFieldType - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandFieldTypeRequest - properties: - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - FriendlyName: - type: string - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - required: - - UniqueName - /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: + operationId: ListDeployedDevicesKey + /Sync/Services/{ServiceSid}/Documents/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + document_permissions: + mapping: + service_sid: service_sid + document_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions + parent: /Services/{Sid} pathType: instance - parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} get: description: '' + tags: + - PreviewSyncDocument parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - - name: FieldTypeSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path @@ -7715,27 +6399,65 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + $ref: '#/components/schemas/preview.sync.service.document' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandFieldValue - x-maturity: - - Preview + operationId: FetchSyncDocument delete: description: '' + tags: + - PreviewSyncDocument parameters: - - name: AssistantSid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: Sid in: path description: '' schema: type: string required: true - - name: FieldTypeSid + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncDocument + post: + description: '' + tags: + - PreviewSyncDocument + parameters: + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path @@ -7743,42 +6465,136 @@ paths: schema: type: string required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + description: OK security: - accountSid_authToken: [] - operationId: DeleteUnderstandFieldValue - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: + operationId: UpdateSyncDocument + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncDocumentRequest + properties: + Data: + description: '' + required: + - Data + examples: + update: + value: + Data: '{}' + UniqueName: unique_name + /Sync/Services/{ServiceSid}/Documents: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + document_permissions: + mapping: + service_sid: service_sid + document_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions + parent: /Services/{Sid} pathType: list - parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} - get: + post: description: '' + tags: + - PreviewSyncDocument parameters: - - name: AssistantSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: FieldTypeSid + responses: + '201': + content: + 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 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateSyncDocument + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSyncDocumentRequest + properties: + UniqueName: + type: string + description: '' + Data: + description: '' + examples: + create: + value: + Data: '{}' + UniqueName: unique_name + get: + description: '' + tags: + - PreviewSyncDocument + parameters: + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Language - in: query - description: 'An ISO language-country string of the value. For example: *en-US*' - schema: - type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -7804,137 +6620,188 @@ paths: application/json: schema: type: object - title: ListUnderstandFieldValueResponse + title: ListSyncDocumentResponse properties: - field_values: + documents: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + $ref: '#/components/schemas/preview.sync.service.document' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + documents: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + readFull: + value: + documents: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandFieldValue - x-maturity: - - Preview - post: - description: '' + operationId: ListSyncDocument + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Documents/{Sid} + mountName: document_permissions + pathType: instance + get: + description: Fetch a specific Sync Document Permission. + tags: + - PreviewSyncDocumentPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: DocumentSid + in: path + description: Identifier of the Sync Document. Either a SID or a unique name. schema: type: string required: true - - name: FieldTypeSid + - name: Identity in: path - description: '' + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' - description: Created + $ref: '#/components/schemas/preview.sync.service.document.document_permission' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + description: OK security: - accountSid_authToken: [] - operationId: CreateUnderstandFieldValue - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandFieldValueRequest - properties: - Language: - type: string - description: An ISO language-country string of the value. - Value: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - SynonymOf: - type: string - description: A value that indicates this field value is a synonym - of. Empty if the value is not a synonym. - required: - - Language - - Value - /understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Assistants/{Sid} - get: - description: '' + operationId: FetchSyncDocumentPermission + delete: + description: Delete a specific Sync Document Permission. + tags: + - PreviewSyncDocumentPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: DocumentSid + in: path + description: Identifier of the Sync Document. Either a SID or a unique name. schema: type: string required: true - - name: Sid + - name: Identity in: path - description: '' + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string required: true responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: FetchUnderstandModelBuild - x-maturity: - - Preview + operationId: DeleteSyncDocumentPermission post: - description: '' + description: Update an identity's access to a specific Sync Document. + tags: + - PreviewSyncDocumentPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: '' + description: The unique SID identifier of the Sync Service Instance. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: DocumentSid in: path - description: '' + description: Identifier of the Sync Document. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. schema: type: string required: true @@ -7943,62 +6810,77 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandModelBuild - x-maturity: - - Preview + operationId: UpdateSyncDocumentPermission requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandModelBuildRequest + title: UpdateSyncDocumentPermissionRequest properties: - UniqueName: - type: string - description: 'A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. For example: v0.1' - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: '' - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteUnderstandModelBuild - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/ModelBuilds: + Read: + type: boolean + description: Boolean flag specifying whether the identity can read + the Sync Document. + Write: + type: boolean + description: Boolean flag specifying whether the identity can update + the Sync Document. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync Document. + required: + - Read + - Write + - Manage + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Documents/{Sid} + mountName: document_permissions pathType: list - parent: /Assistants/{Sid} get: - description: '' + description: Retrieve a list of all Permissions applying to a Sync Document. + tags: + - PreviewSyncDocumentPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: DocumentSid + in: path + description: Identifier of the Sync Document. Either a SID or a unique name. schema: type: string required: true @@ -8027,214 +6909,297 @@ paths: application/json: schema: type: object - title: ListUnderstandModelBuildResponse + title: ListSyncDocumentPermissionResponse properties: - model_builds: + permissions: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.model_build' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + permissions: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + readFull: + value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandModelBuild - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandModelBuild - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandModelBuildRequest - properties: - StatusCallback: - type: string - format: uri - description: '' - UniqueName: - type: string - description: 'A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. For example: v0.1' - /understand/Assistants/{AssistantSid}/Queries/{Sid}: + operationId: ListSyncDocumentPermission + /Sync/Services/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + documents: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents + sync_lists: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists + sync_maps: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps pathType: instance - parent: /Assistants/{Sid} get: description: '' + tags: + - PreviewSyncService parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.query' + $ref: '#/components/schemas/preview.sync.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: false description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandQuery - x-maturity: - - Preview - post: + operationId: FetchSyncService + delete: description: '' + tags: + - PreviewSyncService parameters: - - name: AssistantSid + - name: Sid in: path - description: The unique ID of the parent Assistant. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncService + post: + description: '' + tags: + - PreviewSyncService + parameters: - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.query' + $ref: '#/components/schemas/preview.sync.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: true description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandQuery - x-maturity: - - Preview + operationId: UpdateSyncService requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandQueryRequest + title: UpdateSyncServiceRequest properties: - SampleSid: + WebhookUrl: type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - description: An optional reference to the Sample created from this - query. - Status: + format: uri + description: '' + FriendlyName: type: string - description: 'A string that described the query status. The values - can be: pending_review, reviewed, discarded' - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: Sid - in: path - description: A 34 character string that uniquely identifies this resource. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteUnderstandQuery - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/Queries: + description: '' + ReachabilityWebhooksEnabled: + type: boolean + description: '' + AclEnabled: + type: boolean + description: '' + examples: + update: + value: + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true + /Sync/Services: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + documents: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents + sync_lists: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists + sync_maps: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps pathType: list - parent: /Assistants/{Sid} + post: + description: '' + tags: + - PreviewSyncService + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: true + description: Created + security: + - accountSid_authToken: [] + operationId: CreateSyncService + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSyncServiceRequest + properties: + FriendlyName: + type: string + description: '' + WebhookUrl: + type: string + format: uri + description: '' + ReachabilityWebhooksEnabled: + type: boolean + description: '' + AclEnabled: + type: boolean + description: '' + examples: + create: + value: + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true get: description: '' + tags: + - PreviewSyncService parameters: - - name: AssistantSid - in: path - description: The unique ID of the parent Assistant. - schema: - type: string - required: true - - name: Language - in: query - description: An ISO language-country string of the sample. - schema: - type: string - - name: ModelBuild - in: query - description: The Model Build Sid or unique name of the Model Build to be queried. - schema: - type: string - - name: Status - in: query - description: 'A string that described the query status. The values can be: - pending_review, reviewed, discarded' - schema: - type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -8260,253 +7225,253 @@ paths: application/json: schema: type: object - title: ListUnderstandQueryResponse + title: ListSyncServiceResponse properties: - queries: + services: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.query' + $ref: '#/components/schemas/preview.sync.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: false description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandQuery - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the parent Assistant. - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.query' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandQuery - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandQueryRequest - properties: - Language: - type: string - description: An ISO language-country string of the sample. - Query: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. It can be up to 2048 characters - long. - Tasks: - type: string - description: Constraints the query to a set of tasks. Useful when - you need to constrain the paths the user can take. Tasks should - be comma separated *task-unique-name-1*, *task-unique-name-2* - ModelBuild: - type: string - description: The Model Build Sid or unique name of the Model Build - to be queried. - Field: - type: string - description: Constraints the query to a given Field with an task. - Useful when you know the Field you are expecting. It accepts one - field in the format *task-unique-name-1*:*field-unique-name* - required: - - Language - - Query - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: + operationId: ListSyncService + /Sync/Services/{ServiceSid}/Lists/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + sync_list_items: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items + sync_list_permissions: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_lists pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' + tags: + - PreviewSyncSyncList parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid + - name: ServiceSid in: path - description: The unique ID of the Task associated with this Sample. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' + $ref: '#/components/schemas/preview.sync.service.sync_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandSample - x-maturity: - - Preview - post: + operationId: FetchSyncSyncList + delete: description: '' + tags: + - PreviewSyncSyncList parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the Assistant. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: TaskSid + - name: Sid in: path - description: The unique ID of the Task associated with this Sample. + description: '' schema: type: string required: true - - name: Sid + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncSyncList + /Sync/Services/{ServiceSid}/Lists: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + sync_list_items: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items + sync_list_permissions: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_lists + pathType: list + post: + description: '' + tags: + - PreviewSyncSyncList + parameters: + - name: ServiceSid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - description: OK + $ref: '#/components/schemas/preview.sync.service.sync_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created security: - accountSid_authToken: [] - operationId: UpdateUnderstandSample - x-maturity: - - Preview + operationId: CreateSyncSyncList requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandSampleRequest + title: CreateSyncSyncListRequest properties: - Language: - type: string - description: An ISO language-country string of the sample. - TaggedText: - type: string - description: The text example of how end-users may express this - task. The sample may contain Field tag blocks. - SourceChannel: + UniqueName: type: string - description: 'The communication channel the sample was captured. - It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, - or *slack*. If not included the value will be null' - delete: + description: '' + examples: + create: + value: + UniqueName: unique_name + get: description: '' + tags: + - PreviewSyncSyncList parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Sample. - schema: - type: string - required: true - - name: Sid + - name: ServiceSid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteUnderstandSample - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Sample. - schema: - type: string + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Language - in: query - description: An ISO language-country string of the sample. - schema: - type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -8532,286 +7497,357 @@ paths: application/json: schema: type: object - title: ListUnderstandSampleResponse + title: ListSyncSyncListResponse properties: - samples: + lists: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' + $ref: '#/components/schemas/preview.sync.service.sync_list' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + lists: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + readFull: + value: + lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandSample - x-maturity: - - Preview - post: + operationId: ListSyncSyncList + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_items + pathType: instance + get: description: '' + tags: + - PreviewSyncSyncListItem parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the Assistant. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: TaskSid + - name: ListSid in: path - description: The unique ID of the Task associated with this Sample. + description: '' schema: type: string required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandSample - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandSampleRequest - properties: - Language: - type: string - description: An ISO language-country string of the sample. - TaggedText: - type: string - description: The text example of how end-users may express this - task. The sample may contain Field tag blocks. - SourceChannel: - type: string - description: 'The communication channel the sample was captured. - It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, - or *slack*. If not included the value will be null' - required: - - Language - - TaggedText - /understand/Assistants/{AssistantSid}/StyleSheet: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Assistants/{Sid} - get: - description: Returns Style sheet JSON object for this Assistant - parameters: - - name: AssistantSid + - name: Index in: path - description: The unique ID of the Assistant + description: '' schema: - type: string + type: integer required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.style_sheet' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandStyleSheet - x-maturity: - - Preview - post: - description: Updates the style sheet for an assistant identified by {AssistantSid} - or {AssistantUniqueName}. + operationId: FetchSyncSyncListItem + delete: + description: '' + tags: + - PreviewSyncSyncListItem parameters: - - name: AssistantSid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid in: path - description: The unique ID of the Assistant + description: '' schema: type: string required: true + - name: Index + in: path + description: '' + schema: + type: integer + required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.style_sheet' - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: UpdateUnderstandStyleSheet - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateUnderstandStyleSheetRequest - properties: - StyleSheet: - description: The JSON Style sheet string - /understand/Assistants/{AssistantSid}/Tasks/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - dependentProperties: - field: '{assistant_sid: assistant_sid, task_sid: sid}' - sample: '{assistant_sid: assistant_sid, task_sid: sid}' - task_actions: '{assistant_sid: assistant_sid, task_sid: sid}' - task_statistics: '{assistant_sid: assistant_sid, task_sid: sid}' - parent: /Assistants/{Sid} - get: + operationId: DeleteSyncSyncListItem + post: description: '' + tags: + - PreviewSyncSyncListItem parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the Assistant. + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: '' schema: type: string required: true - - name: Sid - in: path - description: A 34 character string that uniquely identifies this resource. + - name: Index + in: path + description: '' + schema: + type: integer + required: true + - name: If-Match + in: header + description: The If-Match HTTP request header schema: type: string - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandTask - x-maturity: - - Preview + operationId: UpdateSyncSyncListItem + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncSyncListItemRequest + properties: + Data: + description: '' + required: + - Data + examples: + update: + value: + Data: '{}' + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_items + pathType: list post: description: '' + tags: + - PreviewSyncSyncListItem parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the Assistant. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: ListSid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - description: OK + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + description: Created security: - accountSid_authToken: [] - operationId: UpdateUnderstandTask - x-maturity: - - Preview + operationId: CreateSyncSyncListItem requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandTaskRequest + title: CreateSyncSyncListItemRequest properties: - FriendlyName: - type: string - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - Actions: - description: A user-provided JSON object encoded as a string to - specify the actions for this task. It is optional and non-unique. - ActionsUrl: - type: string - format: uri - description: User-provided HTTP endpoint where from the assistant - fetches actions - delete: + Data: + description: '' + required: + - Data + examples: + create: + value: + Data: '{}' + get: description: '' + tags: + - PreviewSyncSyncListItem parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the Assistant. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: ListSid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteUnderstandTask - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/Tasks: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - dependentProperties: - field: '{assistant_sid: assistant_sid, task_sid: sid}' - sample: '{assistant_sid: assistant_sid, task_sid: sid}' - task_actions: '{assistant_sid: assistant_sid, task_sid: sid}' - task_statistics: '{assistant_sid: assistant_sid, task_sid: sid}' - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. + - name: Order + in: query + description: '' schema: type: string - required: true + $ref: '#/components/schemas/sync_list_item_enum_query_result_order' + examples: + readEmpty: + value: asc + readFull: + value: asc + - name: From + in: query + description: '' + schema: + type: string + examples: + readEmpty: + value: from + readFull: + value: from + - name: Bounds + in: query + description: '' + schema: + type: string + $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' + examples: + readEmpty: + value: inclusive + readFull: + value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -8837,110 +7873,105 @@ paths: application/json: schema: type: object - title: ListUnderstandTaskResponse + title: ListSyncSyncListItemResponse properties: - tasks: + items: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.task' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + items: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + readFull: + value: + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandTask - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandTask - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandTaskRequest - properties: - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - FriendlyName: - type: string - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - Actions: - description: A user-provided JSON object encoded as a string to - specify the actions for this task. It is optional and non-unique. - ActionsUrl: - type: string - format: uri - description: User-provided HTTP endpoint where from the assistant - fetches actions - required: - - UniqueName - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: + operationId: ListSyncSyncListItem + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_permissions pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - mountName: task_actions - className: task_actions get: - description: Returns JSON actions for this Task. + description: Fetch a specific Sync List Permission. + tags: + - PreviewSyncSyncListPermission parameters: - - name: AssistantSid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid in: path - description: The unique ID of the parent Assistant. + description: Identifier of the Sync List. Either a SID or a unique name. schema: type: string required: true - - name: TaskSid + - name: Identity in: path - description: The unique ID of the Task. + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string required: true @@ -8949,147 +7980,161 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandTaskActions - x-maturity: - - Preview - post: - description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. + operationId: FetchSyncSyncListPermission + delete: + description: Delete a specific Sync List Permission. + tags: + - PreviewSyncSyncListPermission parameters: - - name: AssistantSid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid in: path - description: The unique ID of the parent Assistant. + description: Identifier of the Sync List. Either a SID or a unique name. schema: type: string required: true - - name: TaskSid + - name: Identity in: path - description: The unique ID of the Task. + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string required: true responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: UpdateUnderstandTaskActions - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateUnderstandTaskActionsRequest - properties: - Actions: - description: The JSON actions that instruct the Assistant how to - perform this task. - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - className: task_statistics - get: - description: '' + operationId: DeleteSyncSyncListPermission + post: + description: Update an identity's access to a specific Sync List. + tags: + - PreviewSyncSyncListPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the parent Assistant. + description: The unique SID identifier of the Sync Service Instance. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: TaskSid + - name: ListSid in: path - description: The unique ID of the Task associated with this Field. + description: Identifier of the Sync List. Either a SID or a unique name. schema: type: string required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_statistics' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUnderstandTaskStatistics - x-maturity: - - Preview - /wireless/Commands/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - get: - description: '' - parameters: - - name: Sid + - name: Identity in: path - description: '' + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^DC[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.command' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: FetchWirelessCommand - x-maturity: - - Preview - /wireless/Commands: + operationId: UpdateSyncSyncListPermission + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncSyncListPermissionRequest + properties: + Read: + type: boolean + description: Boolean flag specifying whether the identity can read + the Sync List. + Write: + type: boolean + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync List. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync List. + required: + - Read + - Write + - Manage + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_permissions pathType: list get: - description: '' + description: Retrieve a list of all Permissions applying to a Sync List. + tags: + - PreviewSyncSyncListPermission parameters: - - name: Device - in: query - description: '' - schema: - type: string - - name: Sim - in: query - description: '' - schema: - type: string - - name: Status - in: query + - name: ServiceSid + in: path description: '' schema: type: string - - name: Direction - in: query - description: '' + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: Identifier of the Sync List. Either a SID or a unique name. schema: type: string + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9115,96 +8160,248 @@ paths: application/json: schema: type: object - title: ListWirelessCommandResponse + title: ListSyncSyncListPermissionResponse properties: - commands: + permissions: type: array items: - $ref: '#/components/schemas/preview.wireless.command' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + permissions: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + readFull: + value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListWirelessCommand - x-maturity: - - Preview + operationId: ListSyncSyncListPermission + /Sync/Services/{ServiceSid}/Maps/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + sync_map_items: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items + sync_map_permissions: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_maps + pathType: instance + get: + description: '' + tags: + - PreviewSyncSyncMap + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchSyncSyncMap + delete: + description: '' + tags: + - PreviewSyncSyncMap + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncSyncMap + /Sync/Services/{ServiceSid}/Maps: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + sync_map_items: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items + sync_map_permissions: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_maps + pathType: list post: description: '' + tags: + - PreviewSyncSyncMap + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.command' + $ref: '#/components/schemas/preview.sync.service.sync_map' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateWirelessCommand - x-maturity: - - Preview + operationId: CreateSyncSyncMap requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateWirelessCommandRequest + title: CreateSyncSyncMapRequest properties: - Command: - type: string - description: '' - Device: - type: string - description: '' - Sim: - type: string - description: '' - CallbackMethod: - type: string - description: '' - CallbackUrl: - type: string - format: uri - description: '' - CommandMode: - type: string - description: '' - IncludeSid: + UniqueName: type: string description: '' - required: - - Command - /wireless/RatePlans: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list + examples: + create: + value: + UniqueName: unique_name get: description: '' + tags: + - PreviewSyncSyncMap parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9230,126 +8427,104 @@ paths: application/json: schema: type: object - title: ListWirelessRatePlanResponse + title: ListSyncSyncMapResponse properties: - rate_plans: + maps: type: array items: - $ref: '#/components/schemas/preview.wireless.rate_plan' + $ref: '#/components/schemas/preview.sync.service.sync_map' meta: - type: object properties: first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string format: uri - nullable: true - url: type: string - format: uri key: type: string - description: OK - security: - - accountSid_authToken: [] - operationId: ListWirelessRatePlan - x-maturity: - - Preview - post: - description: '' - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateWirelessRatePlan - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateWirelessRatePlanRequest - properties: - UniqueName: - type: string - description: '' - FriendlyName: - type: string - description: '' - DataEnabled: - type: boolean - description: '' - DataLimit: - type: integer - description: '' - DataMetering: - type: string - description: '' - MessagingEnabled: - type: boolean - description: '' - VoiceEnabled: - type: boolean - description: '' - CommandsEnabled: - type: boolean - description: '' - NationalRoamingEnabled: - type: boolean - description: '' - InternationalRoaming: - type: array - items: - type: string - description: '' - /wireless/RatePlans/{Sid}: + 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: + maps: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + readFull: + value: + maps: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + description: OK + security: + - accountSid_authToken: [] + operationId: ListSyncSyncMap + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_items pathType: instance get: description: '' + tags: + - PreviewSyncSyncMapItem parameters: - - name: Sid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchWirelessRatePlan - x-maturity: - - Preview - post: - description: '' - parameters: - - name: Sid + - name: MapSid + in: path + description: '' + schema: + type: string + required: true + - name: Key in: path description: '' schema: @@ -9360,232 +8535,254 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: OK security: - accountSid_authToken: [] - operationId: UpdateWirelessRatePlan - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateWirelessRatePlanRequest - properties: - UniqueName: - type: string - description: '' - FriendlyName: - type: string - description: '' + operationId: FetchSyncSyncMapItem delete: description: '' + tags: + - PreviewSyncSyncMapItem parameters: - - name: Sid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: '' + schema: + type: string + required: true + - name: Key in: path description: '' schema: type: string required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteWirelessRatePlan - x-maturity: - - Preview - /wireless/Sims/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - dependentProperties: - usage: '{sim_sid: sid}' - get: + operationId: DeleteSyncSyncMapItem + post: description: '' + tags: + - PreviewSyncSyncMapItem parameters: - - name: Sid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: '' + schema: + type: string + required: true + - name: Key in: path description: '' schema: type: string required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.sim' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: OK security: - accountSid_authToken: [] - operationId: FetchWirelessSim - x-maturity: - - Preview + operationId: UpdateSyncSyncMapItem + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncSyncMapItemRequest + properties: + Data: + description: '' + required: + - Data + examples: + update: + value: + Data: '{}' + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_items + pathType: list post: description: '' + tags: + - PreviewSyncSyncMapItem parameters: - - name: Sid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid in: path description: '' schema: type: string required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.sim' - description: OK + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + description: Created security: - accountSid_authToken: [] - operationId: UpdateWirelessSim - x-maturity: - - Preview + operationId: CreateSyncSyncMapItem requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateWirelessSimRequest + title: CreateSyncSyncMapItemRequest properties: - UniqueName: - type: string - description: '' - CallbackMethod: - type: string - description: '' - CallbackUrl: - type: string - format: uri - description: '' - FriendlyName: - type: string - description: '' - RatePlan: - type: string - description: '' - Status: - type: string - description: '' - CommandsCallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: '' - CommandsCallbackUrl: - type: string - format: uri - description: '' - SmsFallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: '' - SmsFallbackUrl: - type: string - format: uri - description: '' - SmsMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: '' - SmsUrl: - type: string - format: uri - description: '' - VoiceFallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: '' - VoiceFallbackUrl: - type: string - format: uri - description: '' - VoiceMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: '' - VoiceUrl: + Key: type: string - format: uri description: '' - /wireless/Sims: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - dependentProperties: - usage: '{sim_sid: sid}' + Data: + description: '' + required: + - Key + - Data + examples: + create: + value: + Data: '{}' + Key: key get: description: '' + tags: + - PreviewSyncSyncMapItem parameters: - - name: Status - in: query + - name: ServiceSid + in: path description: '' schema: type: string - - name: Iccid - in: query + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path description: '' schema: type: string - - name: RatePlan + required: true + - name: Order in: query description: '' schema: type: string - - name: EId + $ref: '#/components/schemas/sync_map_item_enum_query_result_order' + examples: + readEmpty: + value: asc + readFull: + value: asc + - name: From in: query description: '' schema: type: string - - name: SimRegistrationCode + examples: + readEmpty: + value: from + readFull: + value: from + - name: Bounds in: query description: '' schema: type: string + $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' + examples: + readEmpty: + value: inclusive + readFull: + value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9611,66 +8808,285 @@ paths: application/json: schema: type: object - title: ListWirelessSimResponse + title: ListSyncSyncMapItemResponse properties: - sims: + items: type: array items: - $ref: '#/components/schemas/preview.wireless.sim' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + items: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + readFull: + value: + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListWirelessSim - x-maturity: - - Preview - /wireless/Sims/{SimSid}/Usage: + operationId: ListSyncSyncMapItem + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_permissions pathType: instance - parent: /Sims/{Sid} get: - description: '' + description: Fetch a specific Sync Map Permission. + tags: + - PreviewSyncSyncMapPermission parameters: - - name: SimSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: End - in: query + - name: MapSid + in: path + description: Identifier of the Sync Map. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + schema: + type: string + required: true + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchSyncSyncMapPermission + delete: + description: Delete a specific Sync Map Permission. + tags: + - PreviewSyncSyncMapPermission + parameters: + - name: ServiceSid + in: path description: '' schema: type: string - - name: Start - in: query + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: Identifier of the Sync Map. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncSyncMapPermission + post: + description: Update an identity's access to a specific Sync Map. + tags: + - PreviewSyncSyncMapPermission + parameters: + - name: ServiceSid + in: path + description: The unique SID identifier of the Sync Service Instance. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: Identifier of the Sync Map. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + schema: + type: string + required: true + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateSyncSyncMapPermission + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncSyncMapPermissionRequest + properties: + Read: + type: boolean + description: Boolean flag specifying whether the identity can read + the Sync Map. + Write: + type: boolean + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync Map. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync Map. + required: + - Read + - Write + - Manage + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_permissions + pathType: list + get: + description: Retrieve a list of all Permissions applying to a Sync Map. + tags: + - PreviewSyncSyncMapPermission + parameters: + - name: ServiceSid + in: path description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: Identifier of the Sync Map. Either a SID or a unique name. + schema: + type: string + required: true + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 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: @@ -9678,17 +9094,76 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.sim.usage' + type: object + title: ListSyncSyncMapPermissionResponse + properties: + permissions: + type: array + items: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + 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: + 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: FetchWirelessUsage - x-maturity: - - Preview + operationId: ListSyncSyncMapPermission servers: - url: https://preview.twilio.com -x-maturity: -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. +tags: +- name: PreviewHostedNumbersAuthorizationDocument +- name: PreviewHostedNumbersDependentHostedNumberOrder +- name: PreviewHostedNumbersHostedNumberOrder +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_pricing_v1.yaml b/spec/yaml/twilio_pricing_v1.yaml index c5c0cb81..c6d86ecb 100644 --- a/spec/yaml/twilio_pricing_v1.yaml +++ b/spec/yaml/twilio_pricing_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: pricing.v1.messaging: type: object @@ -312,10 +316,6 @@ components: format: uri nullable: true description: The absolute URL of the resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Pricing description: This is the public Twilio REST API. @@ -327,13 +327,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Messaging: servers: - url: https://pricing.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - name @@ -348,10 +348,12 @@ paths: - outbound_sms_prices - inbound_sms_prices - price_unit - pathType: list parent: /Messaging + pathType: list get: description: '' + tags: + - PricingV1Country parameters: - name: PageSize in: query @@ -385,34 +387,58 @@ paths: items: $ref: '#/components/schemas/pricing.v1.messaging.messaging_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + countries: [] + meta: + first_page_url: https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0 + readFull: + value: + countries: + - country: country + iso_country: US + url: https://pricing.twilio.com/v1/Messaging/Countries/US + meta: + first_page_url: https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListMessagingCountry - x-maturity: - - GA /v1/Messaging/Countries/{IsoCountry}: servers: - url: https://pricing.twilio.com @@ -423,10 +449,12 @@ paths: - outbound_sms_prices - inbound_sms_prices - price_unit - pathType: instance parent: /Messaging + pathType: instance get: description: '' + tags: + - PricingV1Country parameters: - name: IsoCountry in: path @@ -442,16 +470,33 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v1.messaging.messaging_country-instance' + examples: + fetch: + value: + country: country + inbound_sms_prices: + - base_price: '0.05' + current_price: '0.05' + number_type: mobile + iso_country: US + outbound_sms_prices: + - carrier: att + mcc: foo + mnc: bar + prices: + - base_price: '0.05' + current_price: '0.05' + number_type: mobile + price_unit: USD + url: https://pricing.twilio.com/v1/Messaging/Countries/US description: OK security: - accountSid_authToken: [] operationId: FetchMessagingCountry - x-maturity: - - GA /v1/PhoneNumbers: servers: - url: https://pricing.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - name @@ -464,10 +509,12 @@ paths: defaultOutputProperties: - country - price_unit - pathType: list parent: /PhoneNumbers + pathType: list get: description: '' + tags: + - PricingV1Country parameters: - name: PageSize in: query @@ -501,34 +548,58 @@ paths: items: $ref: '#/components/schemas/pricing.v1.phone_number.phone_number_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + countries: + - country: Austria + iso_country: AT + url: https://pricing.twilio.com/v1/PhoneNumbers/Countries/AT + meta: + page: 0 + page_size: 50 + first_page_url: https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0 + previous_page_url: null + url: https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0 + next_page_url: null + key: countries + readEmpty: + value: + countries: [] + meta: + first_page_url: https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListPhoneNumberCountry - x-maturity: - - GA /v1/PhoneNumbers/Countries/{IsoCountry}: servers: - url: https://pricing.twilio.com @@ -537,10 +608,12 @@ paths: defaultOutputProperties: - country - price_unit - pathType: instance parent: /PhoneNumbers + pathType: instance get: description: '' + tags: + - PricingV1Country parameters: - name: IsoCountry in: path @@ -556,16 +629,28 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v1.phone_number.phone_number_country-instance' + examples: + fetch: + value: + country: United States + iso_country: US + phone_number_prices: + - number_type: local + base_price: '1.00' + current_price: '1.00' + - number_type: toll free + base_price: '2.00' + current_price: '2.00' + price_unit: USD + url: https://pricing.twilio.com/v1/PhoneNumbers/Countries/US description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumberCountry - x-maturity: - - GA /v1/Voice: servers: - url: https://pricing.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - name @@ -578,10 +663,12 @@ paths: defaultOutputProperties: - country - price_unit - pathType: list parent: /Voice + pathType: list get: description: '' + tags: + - PricingV1Country parameters: - name: PageSize in: query @@ -615,34 +702,58 @@ paths: items: $ref: '#/components/schemas/pricing.v1.voice.voice_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + countries: + - country: Andorra + iso_country: AD + url: https://pricing.twilio.com/v1/Voice/Countries/AD + meta: + first_page_url: https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0 + readEmpty: + value: + countries: [] + meta: + first_page_url: https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListVoiceCountry - x-maturity: - - GA /v1/Voice/Countries/{IsoCountry}: servers: - url: https://pricing.twilio.com @@ -651,10 +762,12 @@ paths: defaultOutputProperties: - country - price_unit - pathType: instance parent: /Voice + pathType: instance get: description: '' + tags: + - PricingV1Country parameters: - name: IsoCountry in: path @@ -670,12 +783,31 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v1.voice.voice_country-instance' + examples: + fetch: + value: + country: United States + inbound_call_prices: + - current_price: '0.0085' + number_type: local + base_price: '0.0085' + - current_price: '0.022' + number_type: toll free + base_price: '0.022' + iso_country: US + outbound_prefix_prices: + - prefixes: + - '1907' + current_price: '0.090' + friendly_name: Programmable Outbound Minute - United States + - Alaska + base_price: '0.090' + price_unit: USD + url: https://pricing.twilio.com/v1/Voice/Countries/US description: OK security: - accountSid_authToken: [] operationId: FetchVoiceCountry - x-maturity: - - GA /v1/Voice/Numbers/{Number}: servers: - url: https://pricing.twilio.com @@ -686,10 +818,12 @@ paths: - outbound_call_price - inbound_call_price - price_unit - pathType: instance parent: /Voice + pathType: instance get: description: '' + tags: + - PricingV1Number parameters: - name: Number in: path @@ -704,12 +838,25 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v1.voice.voice_number' + examples: + fetch: + value: + country: Iran + inbound_call_price: + base_price: null + current_price: null + number_type: null + iso_country: IR + number: '+987654321' + outbound_call_price: + base_price: '0.255' + current_price: '0.255' + price_unit: USD + url: https://pricing.twilio.com/v1/Voice/Numbers/+987654321 description: OK security: - accountSid_authToken: [] operationId: FetchVoiceNumber - x-maturity: - - GA /v1/Voice/Numbers: servers: - url: https://pricing.twilio.com @@ -720,10 +867,12 @@ paths: - outbound_call_price - inbound_call_price - price_unit - pathType: list parent: /Voice + pathType: list servers: - url: https://pricing.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: PricingV1Country +- name: PricingV1Number +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_pricing_v2.yaml b/spec/yaml/twilio_pricing_v2.yaml index 3f04c06e..f00df7e5 100644 --- a/spec/yaml/twilio_pricing_v2.yaml +++ b/spec/yaml/twilio_pricing_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: pricing.v2.trunking_country: type: object @@ -315,10 +319,6 @@ components: format: uri nullable: true description: The absolute URL of the resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Pricing description: This is the public Twilio REST API. @@ -330,7 +330,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Trunking/Countries: @@ -344,6 +344,8 @@ paths: pathType: list get: description: '' + tags: + - PricingV2Country parameters: - name: PageSize in: query @@ -377,34 +379,58 @@ paths: items: $ref: '#/components/schemas/pricing.v2.trunking_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + countries: + - country: Andorra + iso_country: AD + url: https://pricing.twilio.com/v2/Trunking/Countries/AD + meta: + first_page_url: https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0 + readEmpty: + value: + countries: [] + meta: + first_page_url: https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListTrunkingCountry - x-maturity: - - GA /v2/Trunking/Countries/{IsoCountry}: servers: - url: https://pricing.twilio.com @@ -416,6 +442,8 @@ paths: pathType: instance get: description: Fetch a specific Country. + tags: + - PricingV2Country parameters: - name: IsoCountry in: path @@ -431,12 +459,59 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v2.trunking_country-instance' + examples: + fetch: + value: + country: United States + originating_call_prices: + - base_price: null + current_price: '0.0085' + number_type: local + - base_price: null + current_price: '0.022' + number_type: toll free + iso_country: US + terminating_prefix_prices: + - base_price: null + current_price: '0.090' + destination_prefixes: + - '1907' + friendly_name: Outbound Trunking Minute - United States - Alaska + origination_prefixes: + - ALL + - base_price: null + current_price: '0.013' + destination_prefixes: + - '1808' + friendly_name: Outbound Trunking Minute - United States - Hawaii + origination_prefixes: + - ALL + - base_price: null + current_price: '0.013' + destination_prefixes: + - '1800' + - '1844' + - '1855' + - '1866' + - '1877' + - '1888' + friendly_name: Outbound Trunking Minute - United States & Canada + - Toll Free + origination_prefixes: + - ALL + - base_price: null + current_price: '0.013' + destination_prefixes: + - '1' + friendly_name: Outbound Trunking Minute - United States & Canada + origination_prefixes: + - ALL + price_unit: USD + url: https://pricing.twilio.com/v2/Trunking/Countries/US description: OK security: - accountSid_authToken: [] operationId: FetchTrunkingCountry - x-maturity: - - GA /v2/Trunking/Numbers/{DestinationNumber}: servers: - url: https://pricing.twilio.com @@ -450,6 +525,8 @@ paths: get: description: Fetch pricing information for a specific destination and, optionally, origination phone number. + tags: + - PricingV2Number parameters: - name: DestinationNumber in: path @@ -468,18 +545,62 @@ paths: schema: type: string format: phone-number + examples: + fetchWithOrigination: + value: '+15105556789' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pricing.v2.trunking_number' + examples: + fetch: + value: + country: United States + destination_number: '+18001234567' + originating_call_price: + base_price: null + current_price: null + number_type: null + iso_country: US + origination_number: null + terminating_prefix_prices: + - base_price: null + current_price: '0.013' + destination_prefixes: + - '1800' + friendly_name: Trunking Outbound Minute - United States Zone + 1b + origination_prefixes: + - ALL + price_unit: USD + url: https://pricing.twilio.com/v2/Trunking/Numbers/+18001234567 + fetchWithOrigination: + value: + country: United States + destination_number: '+18001234567' + originating_call_price: + base_price: null + current_price: '0.013' + number_type: tollfree + iso_country: US + origination_number: '+15105556789' + terminating_prefix_prices: + - base_price: null + current_price: '0.001' + destination_prefixes: + - '1800' + friendly_name: Trunking Outbound Minute - United States - Toll + Free + origination_prefixes: + - ALL + price_unit: USD + url: https://pricing.twilio.com/v2/Trunking/Numbers/+18001234567 description: OK security: - accountSid_authToken: [] operationId: FetchTrunkingNumber - x-maturity: - - GA /v2/Trunking/Numbers: servers: - url: https://pricing.twilio.com @@ -506,10 +627,12 @@ paths: defaultOutputProperties: - country - price_unit - pathType: list parent: /Voice + pathType: list get: description: '' + tags: + - PricingV2Country parameters: - name: PageSize in: query @@ -543,34 +666,58 @@ paths: items: $ref: '#/components/schemas/pricing.v2.voice.voice_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + countries: + - country: Andorra + iso_country: AD + url: https://pricing.twilio.com/v2/Voice/Countries/AD + meta: + first_page_url: https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0 + readEmpty: + value: + countries: [] + meta: + first_page_url: https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListVoiceCountry - x-maturity: - - GA /v2/Voice/Countries/{IsoCountry}: servers: - url: https://pricing.twilio.com @@ -579,10 +726,12 @@ paths: defaultOutputProperties: - country - price_unit - pathType: instance parent: /Voice + pathType: instance get: description: Fetch a specific Country. + tags: + - PricingV2Country parameters: - name: IsoCountry in: path @@ -598,12 +747,62 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v2.voice.voice_country-instance' + examples: + fetch: + value: + country: United States + inbound_call_prices: + - base_price: '0.0085' + current_price: '0.0085' + number_type: local + - base_price: '0.022' + current_price: '0.022' + number_type: toll free + iso_country: US + outbound_prefix_prices: + - base_price: '0.090' + current_price: '0.090' + destination_prefixes: + - '1907' + friendly_name: Programmable Outbound Minute - United States + - Alaska + origination_prefixes: + - ALL + - base_price: '0.013' + current_price: '0.013' + destination_prefixes: + - '1808' + friendly_name: Programmable Outbound Minute - United States + - Hawaii + origination_prefixes: + - ALL + - base_price: '0.013' + current_price: '0.013' + destination_prefixes: + - '1800' + - '1844' + - '1855' + - '1866' + - '1877' + - '1888' + friendly_name: Programmable Outbound Minute - United States + & Canada - Toll Free + origination_prefixes: + - ALL + - base_price: '0.013' + current_price: '0.013' + destination_prefixes: + - '1' + friendly_name: Programmable Outbound Minute - United States + & Canada + origination_prefixes: + - ALL + price_unit: USD + url: https://pricing.twilio.com/v2/Voice/Countries/US description: OK security: - accountSid_authToken: [] operationId: FetchVoiceCountry - x-maturity: - - GA /v2/Voice/Numbers/{DestinationNumber}: servers: - url: https://pricing.twilio.com @@ -613,11 +812,13 @@ paths: - country - inbound_call_price - price_unit - pathType: instance parent: /Voice + pathType: instance get: description: Fetch pricing information for a specific destination and, optionally, origination phone number. + tags: + - PricingV2Number parameters: - name: DestinationNumber in: path @@ -636,18 +837,37 @@ paths: schema: type: string format: phone-number + examples: + fetch: + value: '+18001234567' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pricing.v2.voice.voice_number' + examples: + fetch: + value: + country: United States + destination_number: '+18001234567' + inbound_call_price: + base_price: null + current_price: null + number_type: null + iso_country: US + origination_number: '+987654321' + outbound_call_prices: + - base_price: '0.013' + current_price: '0.013' + origination_prefixes: + - ALL + price_unit: USD + url: https://pricing.twilio.com/v2/Voice/Numbers/+18001234567 description: OK security: - accountSid_authToken: [] operationId: FetchVoiceNumber - x-maturity: - - GA /v2/Voice/Numbers: servers: - url: https://pricing.twilio.com @@ -657,10 +877,12 @@ paths: - country - inbound_call_price - price_unit - pathType: list parent: /Voice + pathType: list servers: - url: https://pricing.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: PricingV2Country +- name: PricingV2Number +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_proxy_v1.yaml b/spec/yaml/twilio_proxy_v1.yaml index 358a454d..39736297 100644 --- a/spec/yaml/twilio_proxy_v1.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: proxy.v1.service.session.interaction: type: object @@ -41,6 +45,10 @@ components: description: 'A JSON string that includes the message body of message interactions (e.g. `{"body": "hello"}`) or the call duration (when available) of a call (e.g. `{"duration": "5"}`).' + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string $ref: '#/components/schemas/interaction_enum_type' @@ -62,7 +70,7 @@ components: pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: The SID of the inbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) - or [Message](https://www.twilio.com/docs/sms/api/message. + or [Message](https://www.twilio.com/docs/sms/api/message-resource). inbound_resource_status: type: string $ref: '#/components/schemas/interaction_enum_resource_status' @@ -200,6 +208,10 @@ components: nullable: true description: 'A JSON string that includes the message body sent to the participant. (e.g. `{"body": "hello"}`)' + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string $ref: '#/components/schemas/message_interaction_enum_type' @@ -366,6 +378,10 @@ components: nullable: true description: The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 proxy_identifier: type: string nullable: true @@ -569,7 +585,7 @@ components: format: uri nullable: true description: The URL we call when an inbound call or SMS action occurs on - a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/functions)) + a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect @@ -796,10 +812,6 @@ components: description: Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Proxy description: This is the public Twilio REST API. @@ -811,22 +823,24 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - type - data - pathType: instance parent: /Services/{ServiceSid}/Sessions/{Sid} + pathType: instance get: description: Retrieve a list of Interactions for a given [Session](https://www.twilio.com/docs/proxy/api/session). + tags: + - ProxyV1Interaction parameters: - name: ServiceSid in: path @@ -864,14 +878,36 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.interaction' + examples: + fetch: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: '{"body":"some message"}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + inbound_participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + inbound_resource_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + inbound_resource_status: sent + inbound_resource_type: Message + inbound_resource_url: null + outbound_participant_sid: KPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + outbound_resource_sid: SMbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + outbound_resource_status: sent + outbound_resource_type: Message + outbound_resource_url: null + sid: KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: message + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchInteraction - x-maturity: - - Beta delete: description: Delete a specific Interaction. + tags: + - ProxyV1Interaction parameters: - name: ServiceSid in: path @@ -909,22 +945,22 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInteraction - x-maturity: - - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - type - data - pathType: list parent: /Services/{ServiceSid}/Sessions/{Sid} + pathType: list get: description: Retrieve a list of all Interactions for a Session. A maximum of 100 records will be returned per page. + tags: + - ProxyV1Interaction parameters: - name: ServiceSid in: path @@ -978,49 +1014,61 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.session.interaction' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + interactions: [] + meta: + previous_page_url: null + next_page_url: null + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0 + page: 0 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0 + page_size: 50 + key: interactions description: OK security: - accountSid_authToken: [] operationId: ListInteraction - x-maturity: - - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - type - data - pathType: list parent: /Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} + pathType: list post: description: Create a new message Interaction to send directly from your system to one [Participant](https://www.twilio.com/docs/proxy/api/participant). The `inbound` properties for the Interaction will always be empty. + tags: + - ProxyV1MessageInteraction parameters: - name: ServiceSid in: path @@ -1058,12 +1106,33 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant.message_interaction' + examples: + create: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: '{"body":"some message"}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + inbound_participant_sid: null + inbound_resource_sid: null + inbound_resource_status: null + inbound_resource_type: null + inbound_resource_url: null + outbound_participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + outbound_resource_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + outbound_resource_status: sent + outbound_resource_type: Message + outbound_resource_url: null + sid: KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: message + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMessageInteraction - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1080,12 +1149,18 @@ paths: type: string format: uri description: Reserved. Not currently supported. + examples: + create: + value: + Body: some message x-twilio: conditional: - - body - media_url get: description: '' + tags: + - ProxyV1MessageInteraction parameters: - name: ServiceSid in: path @@ -1149,47 +1224,59 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.session.participant.message_interaction' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + interactions: [] + meta: + previous_page_url: null + next_page_url: null + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions?PageSize=50&Page=0 + page: 0 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions?PageSize=50&Page=0 + page_size: 50 + key: interactions description: OK security: - accountSid_authToken: [] operationId: ListMessageInteraction - x-maturity: - - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - type - data - pathType: instance parent: /Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} + pathType: instance get: description: '' + tags: + - ProxyV1MessageInteraction parameters: - name: ServiceSid in: path @@ -1237,29 +1324,56 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant.message_interaction' + examples: + fetch: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: '{"body":"some message"}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + inbound_participant_sid: null + inbound_resource_sid: null + inbound_resource_status: null + inbound_resource_type: null + inbound_resource_url: null + outbound_participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + outbound_resource_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + outbound_resource_status: sent + outbound_resource_type: Message + outbound_resource_url: null + sid: KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: message + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMessageInteraction - x-maturity: - - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - identifier - proxy_identifier - pathType: instance dependentProperties: - message_interaction: '{service_sid: service_sid, session_sid: session_sid, - participant_sid: sid}' + message_interactions: + mapping: + service_sid: service_sid + session_sid: session_sid + participant_sid: sid + resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Participants/{participant_sid}/MessageInteractions parent: /Services/{ServiceSid}/Sessions/{Sid} + pathType: instance get: description: Fetch a specific Participant. + tags: + - ProxyV1Participant parameters: - name: ServiceSid in: path @@ -1297,17 +1411,50 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant' + examples: + fetch: + value: + sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identifier: '+14155551212' + proxy_identifier: '+14155559999' + proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_deleted: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions + fetchChannel: + value: + sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identifier: messenger:14155551212 + proxy_identifier: messenger:14155559999 + proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: a facebook user + date_deleted: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions description: OK security: - accountSid_authToken: [] operationId: FetchParticipant - x-maturity: - - Beta delete: description: Delete a specific Participant. This is a soft-delete. The participant remains associated with the session and cannot be re-added. Participants are only permanently deleted when the [Session](https://www.twilio.com/docs/proxy/api/session) is deleted. + tags: + - ProxyV1Participant parameters: - name: ServiceSid in: path @@ -1345,25 +1492,29 @@ paths: security: - accountSid_authToken: [] operationId: DeleteParticipant - x-maturity: - - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - identifier - proxy_identifier - pathType: list dependentProperties: - message_interaction: '{service_sid: service_sid, session_sid: session_sid, - participant_sid: sid}' + message_interactions: + mapping: + service_sid: service_sid + session_sid: session_sid + participant_sid: sid + resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Participants/{participant_sid}/MessageInteractions parent: /Services/{ServiceSid}/Sessions/{Sid} + pathType: list get: description: Retrieve a list of all Participants in a Session. + tags: + - ProxyV1Participant parameters: - name: ServiceSid in: path @@ -1417,36 +1568,48 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.session.participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + page: 0 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + page_size: 50 + key: participants + participants: [] description: OK security: - accountSid_authToken: [] operationId: ListParticipant - x-maturity: - - Beta post: description: Add a new Participant to the Session + tags: + - ProxyV1Participant parameters: - name: ServiceSid in: path @@ -1474,12 +1637,43 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant' + examples: + create: + value: + sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identifier: '+14155551212' + proxy_identifier: '+14155559999' + proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_deleted: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions + createChannel: + value: + sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identifier: messenger:123456 + proxy_identifier: messenger:987654532 + proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: a facebook user + date_deleted: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions description: Created security: - accountSid_authToken: [] operationId: CreateParticipant - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1507,19 +1701,31 @@ paths: description: The SID of the Proxy Identifier to assign to the Participant. required: - Identifier + examples: + create: + value: + FriendlyName: friendly_name + Identifier: '+14155551212' + createChannel: + value: + FriendlyName: a facebook user + Identifier: messenger:123456 + ProxyIdentifier: messenger:987654532 /v1/Services/{ServiceSid}/PhoneNumbers: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - phone_number - pathType: list parent: /Services/{Sid} + pathType: list post: description: Add a Phone Number to a Service's Proxy Number Pool. + tags: + - ProxyV1PhoneNumber parameters: - name: ServiceSid in: path @@ -1537,12 +1743,27 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.phone_number' + examples: + create: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + phone_number: '+1987654321' + friendly_name: Friendly Name + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false + in_use: 0 description: Created security: - accountSid_authToken: [] operationId: CreatePhoneNumber - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1571,9 +1792,15 @@ paths: not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. + examples: + create: + value: + Sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Phone Numbers in the Proxy Number Pool for a Service. A maximum of 100 records will be returned per page. + tags: + - ProxyV1PhoneNumber parameters: - name: ServiceSid in: path @@ -1617,47 +1844,73 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.phone_number' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: phone_numbers + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0 + phone_numbers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + phone_number: '+1987654321' + friendly_name: Friendly Name + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false + in_use: 0 description: OK security: - accountSid_authToken: [] operationId: ListPhoneNumber - x-maturity: - - Beta /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - phone_number - pathType: instance parent: /Services/{Sid} + pathType: instance delete: description: Delete a specific Phone Number from a Service. + tags: + - ProxyV1PhoneNumber parameters: - name: ServiceSid in: path @@ -1685,10 +1938,10 @@ paths: security: - accountSid_authToken: [] operationId: DeletePhoneNumber - x-maturity: - - Beta get: description: Fetch a specific Phone Number. + tags: + - ProxyV1PhoneNumber parameters: - name: ServiceSid in: path @@ -1716,14 +1969,31 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.phone_number' + examples: + fetch: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + phone_number: '12345' + friendly_name: Friendly Name + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false + in_use: 0 description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - Beta post: description: Update a specific Proxy Number. + tags: + - ProxyV1PhoneNumber parameters: - name: ServiceSid in: path @@ -1751,12 +2021,27 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.phone_number' + examples: + update: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + phone_number: '12345' + friendly_name: Friendly Name + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: true + in_use: 0 description: OK security: - accountSid_authToken: [] operationId: UpdatePhoneNumber - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1770,22 +2055,37 @@ paths: be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. + examples: + update: + value: + IsReserved: true /v1/Services/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_created - pathType: instance dependentProperties: - session: '{service_sid: sid}' - phone_number: '{service_sid: sid}' - short_code: '{service_sid: sid}' + sessions: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Sessions + phone_numbers: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/PhoneNumbers + short_codes: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/ShortCodes + pathType: instance get: description: Fetch a specific Service. + tags: + - ProxyV1Service parameters: - name: Sid in: path @@ -1800,14 +2100,34 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service' + examples: + fetch: + value: + sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My Service + default_ttl: 3600 + callback_url: http://www.example.com + geo_match_level: country + number_selection_behavior: prefer-sticky + intercept_callback_url: http://www.example.com + out_of_session_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sessions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions + phone_numbers: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - Beta delete: description: Delete a specific Service. + tags: + - ProxyV1Service parameters: - name: Sid in: path @@ -1825,10 +2145,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - Beta post: description: Update a specific Service. + tags: + - ProxyV1Service parameters: - name: Sid in: path @@ -1846,12 +2166,30 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service' + examples: + update: + value: + sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My Service + default_ttl: 3600 + callback_url: http://www.example.com + geo_match_level: country + number_selection_behavior: prefer-sticky + intercept_callback_url: http://www.example.com + out_of_session_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sessions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions + phone_numbers: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1906,10 +2244,10 @@ paths: format: uri description: The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server - (or a Twilio [function](https://www.twilio.com/functions)) responds - with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we - will process it. This means it is possible, for example, to play - a message for a call, send an automated text message response, + (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) + responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), + we will process it. This means it is possible, for example, to + play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information. @@ -1921,23 +2259,41 @@ paths: description: The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship. + examples: + update: + value: + DefaultTtl: 3600 + CallbackUrl: http://www.example.com + UniqueName: My Service + ChatInstanceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Services: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_created - pathType: list dependentProperties: - session: '{service_sid: sid}' - phone_number: '{service_sid: sid}' - short_code: '{service_sid: sid}' + sessions: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Sessions + phone_numbers: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/PhoneNumbers + short_codes: + mapping: + service_sid: sid + 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. + tags: + - ProxyV1Service parameters: - name: PageSize in: query @@ -1971,48 +2327,78 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + services: [] + meta: + first_page_url: https://proxy.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://proxy.twilio.com/v1/Services?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - Beta post: description: Create a new Service for Twilio Proxy + tags: + - ProxyV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service' + examples: + create: + value: + sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My Service + default_ttl: 3600 + callback_url: http://www.example.com + geo_match_level: country + number_selection_behavior: prefer-sticky + intercept_callback_url: http://www.example.com + out_of_session_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sessions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions + phone_numbers: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2067,10 +2453,10 @@ paths: format: uri description: The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server - (or a Twilio [function](https://www.twilio.com/functions)) responds - with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we - will process it. This means it is possible, for example, to play - a message for a call, send an automated text message response, + (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) + responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), + we will process it. This means it is possible, for example, to + play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information. @@ -2084,23 +2470,40 @@ paths: messages to this chat instance. This is a one-to-one relationship. required: - UniqueName + examples: + create: + value: + DefaultTtl: 3600 + CallbackUrl: http://www.example.com + UniqueName: My Service + ChatInstanceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Services/{ServiceSid}/Sessions/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_started - date_ended - pathType: instance dependentProperties: - interaction: '{service_sid: service_sid, session_sid: sid}' - participant: '{service_sid: service_sid, session_sid: sid}' + interactions: + mapping: + service_sid: service_sid + session_sid: sid + resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Interactions + participants: + mapping: + service_sid: service_sid + session_sid: sid + resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Participants parent: /Services/{Sid} + pathType: instance get: description: Fetch a specific Session. + tags: + - ProxyV1Session parameters: - name: ServiceSid in: path @@ -2125,14 +2528,35 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session' + examples: + fetch: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: open + unique_name: 'Order #1234' + date_started: '2015-07-30T20:00:00Z' + date_ended: '2015-07-30T20:00:00Z' + date_last_interaction: '2015-07-30T20:00:00Z' + date_expiry: '2015-07-30T20:00:00Z' + ttl: 3600 + mode: voice-and-message + closed_reason: '' + sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions + participants: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: FetchSession - x-maturity: - - Beta delete: description: Delete a specific Session. + tags: + - ProxyV1Session parameters: - name: ServiceSid in: path @@ -2160,10 +2584,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSession - x-maturity: - - Beta post: description: Update a specific Session. + tags: + - ProxyV1Session parameters: - name: ServiceSid in: path @@ -2191,12 +2615,31 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session' + examples: + update: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: in-progress + unique_name: 'Order #1234' + date_started: '2015-07-30T20:00:00Z' + date_ended: '2015-07-30T20:00:00Z' + date_last_interaction: '2015-07-30T20:00:00Z' + date_expiry: '2015-07-30T20:00:00Z' + ttl: 3600 + mode: voice-and-message + closed_reason: '' + sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions + participants: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: UpdateSession - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2220,24 +2663,39 @@ paths: $ref: '#/components/schemas/session_enum_status' description: 'The new status of the resource. Can be: `in-progress` to re-open a session or `closed` to close a session.' + examples: + update: + value: + Ttl: 3600 + Status: in-progress /v1/Services/{ServiceSid}/Sessions: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_started - date_ended - pathType: list dependentProperties: - interaction: '{service_sid: service_sid, session_sid: sid}' - participant: '{service_sid: service_sid, session_sid: sid}' + interactions: + mapping: + service_sid: service_sid + session_sid: sid + resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Interactions + participants: + mapping: + service_sid: service_sid + session_sid: sid + resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Participants 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. + tags: + - ProxyV1Session parameters: - name: ServiceSid in: path @@ -2281,36 +2739,48 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.session' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sessions: [] + meta: + previous_page_url: null + next_page_url: null + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0 + page: 0 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0 + page_size: 50 + key: sessions description: OK security: - accountSid_authToken: [] operationId: ListSession - x-maturity: - - Beta post: description: Create a new Session + tags: + - ProxyV1Session parameters: - name: ServiceSid in: path @@ -2328,12 +2798,31 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session' + examples: + create: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: open + unique_name: 'Order #1234' + date_started: '2015-07-30T20:00:00Z' + date_ended: '2015-07-30T20:00:00Z' + date_last_interaction: '2015-07-30T20:00:00Z' + date_expiry: '2015-07-30T20:00:00Z' + ttl: 3600 + mode: voice-and-message + closed_reason: '' + sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions + participants: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: Created security: - accountSid_authToken: [] operationId: CreateSession - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2372,19 +2861,26 @@ paths: type: array items: {} description: The Participant objects to include in the new session. + examples: + create: + value: + Ttl: 3600 + UniqueName: 'Order #1234' /v1/Services/{ServiceSid}/ShortCodes: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - short_code - iso_country - pathType: list parent: /Services/{Sid} + pathType: list post: description: Add a Short Code to the Proxy Number Pool for the Service. + tags: + - ProxyV1ShortCode parameters: - name: ServiceSid in: path @@ -2402,12 +2898,25 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.short_code' + examples: + create: + value: + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + short_code: '12345' + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false description: Created security: - accountSid_authToken: [] operationId: CreateShortCode - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2420,14 +2929,20 @@ paths: minLength: 34 maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ - description: The SID of a Twilio [ShortCode](https://www.twilio.com/docs/sms/api/short-code) + description: The SID of a Twilio [ShortCode](https://www.twilio.com/en-us/messaging/channels/sms/short-codes) resource that represents the short code you would like to assign to your Proxy Service. required: - Sid + examples: + create: + value: + Sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Short Codes in the Proxy Number Pool for the Service. A maximum of 100 records will be returned per page. + tags: + - ProxyV1ShortCode parameters: - name: ServiceSid in: path @@ -2471,47 +2986,71 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.short_code' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: short_codes + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0 + short_codes: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + short_code: '12345' + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false description: OK security: - accountSid_authToken: [] operationId: ListShortCode - x-maturity: - - Beta /v1/Services/{ServiceSid}/ShortCodes/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - short_code - iso_country - pathType: instance parent: /Services/{Sid} + pathType: instance delete: description: Delete a specific Short Code from a Service. + tags: + - ProxyV1ShortCode parameters: - name: ServiceSid in: path @@ -2539,10 +3078,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteShortCode - x-maturity: - - Beta get: description: Fetch a specific Short Code. + tags: + - ProxyV1ShortCode parameters: - name: ServiceSid in: path @@ -2570,14 +3109,29 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.short_code' + examples: + fetch: + value: + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + short_code: '12345' + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false description: OK security: - accountSid_authToken: [] operationId: FetchShortCode - x-maturity: - - Beta post: description: Update a specific Short Code. + tags: + - ProxyV1ShortCode parameters: - name: ServiceSid in: path @@ -2605,12 +3159,25 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.short_code' + examples: + update: + value: + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + short_code: '12345' + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: true description: OK security: - accountSid_authToken: [] operationId: UpdateShortCode - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2624,9 +3191,19 @@ paths: assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. + examples: + update: + value: + IsReserved: true servers: - url: https://proxy.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: ProxyV1Interaction +- name: ProxyV1MessageInteraction +- name: ProxyV1Participant +- name: ProxyV1PhoneNumber +- name: ProxyV1Service +- name: ProxyV1Session +- name: ProxyV1ShortCode +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_routes_v2.yaml b/spec/yaml/twilio_routes_v2.yaml index b308573e..4e243978 100644 --- a/spec/yaml/twilio_routes_v2.yaml +++ b/spec/yaml/twilio_routes_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: routes.v2.phone_number: type: object @@ -133,10 +137,6 @@ components: nullable: true description: The date that the Inbound Processing Region was updated for this SIP Trunk, given in ISO 8601 format. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Routes description: This is the public Twilio REST API. @@ -148,13 +148,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/PhoneNumbers/{PhoneNumber}: servers: - url: https://routes.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -163,6 +163,8 @@ paths: pathType: instance post: description: Assign an Inbound Processing Region to a phone number. + tags: + - RoutesV2PhoneNumber parameters: - name: PhoneNumber in: path @@ -176,12 +178,21 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.phone_number' + examples: + update: + value: + phone_number: '+18001234567' + url: https://routes.twilio.com/v2/PhoneNumbers/+18001234567 + sid: QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_region: au1 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: OK security: - accountSid_authToken: [] operationId: UpdatePhoneNumber - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -197,8 +208,15 @@ paths: type: string description: A human readable description of this resource, up to 64 characters. + examples: + update: + value: + FriendlyName: friendly_name + VoiceRegion: au1 get: description: Fetch the Inbound Processing Region assigned to a phone number. + tags: + - RoutesV2PhoneNumber parameters: - name: PhoneNumber in: path @@ -212,16 +230,25 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.phone_number' + examples: + fetch: + value: + phone_number: '+18001234567' + url: https://routes.twilio.com/v2/PhoneNumbers/+18001234567 + sid: QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_region: au1 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - GA /v2/SipDomains/{SipDomain}: servers: - url: https://routes.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -230,6 +257,8 @@ paths: pathType: instance post: description: '' + tags: + - RoutesV2SipDomain parameters: - name: SipDomain in: path @@ -243,12 +272,21 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.sip_domain' + examples: + update: + value: + url: https://routes.twilio.com/v2/SipDomains/test.sip.twilio.com + sip_domain: test.sip.twilio.com + sid: QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_region: au1 + date_created: '2020-08-07T22:29:24Z' + date_updated: '2020-08-07T22:29:24Z' description: OK security: - accountSid_authToken: [] operationId: UpdateSipDomain - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -262,8 +300,15 @@ paths: FriendlyName: type: string description: '' + examples: + update: + value: + FriendlyName: friendly_name + VoiceRegion: au1 get: description: '' + tags: + - RoutesV2SipDomain parameters: - name: SipDomain in: path @@ -277,16 +322,25 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.sip_domain' + examples: + fetch: + value: + url: https://routes.twilio.com/v2/SipDomains/test.sip.twilio.com + account_sid: AC00000000000000000000000000000000 + sid: QQ00000000000000000000000000000000 + sip_domain: test.sip.twilio.com + friendly_name: string + voice_region: string + date_created: '2022-06-02T22:33:47Z' + date_updated: '2022-06-02T22:33:47Z' description: OK security: - accountSid_authToken: [] operationId: FetchSipDomain - x-maturity: - - GA /v2/Trunks/{SipTrunkDomain}: servers: - url: https://routes.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -295,6 +349,8 @@ paths: pathType: instance post: description: Assign an Inbound Processing Region to a SIP Trunk + tags: + - RoutesV2Trunk parameters: - name: SipTrunkDomain in: path @@ -308,12 +364,21 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.trunks' + examples: + update: + value: + sip_trunk_domain: test.pstn.twilio.com + url: https://routes.twilio.com/v2/Trunks/test.pstn.twilio.com + sid: QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_region: au1 + date_created: '2020-08-07T22:29:24Z' + date_updated: '2020-08-07T22:29:24Z' description: OK security: - accountSid_authToken: [] operationId: UpdateTrunks - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -329,8 +394,15 @@ paths: type: string description: A human readable description of this resource, up to 64 characters. + examples: + update: + value: + FriendlyName: friendly_name + VoiceRegion: au1 get: description: Fetch the Inbound Processing Region assigned to a SIP Trunk. + tags: + - RoutesV2Trunk parameters: - name: SipTrunkDomain in: path @@ -344,14 +416,26 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.trunks' + examples: + fetch: + value: + sip_trunk_domain: test.pstn.twilio.com + url: https://routes.twilio.com/v2/Trunks/test.pstn.twilio.com + account_sid: AC00000000000000000000000000000000 + sid: QQ00000000000000000000000000000000 + friendly_name: string + voice_region: string + date_created: '2022-06-02T22:33:47Z' + date_updated: '2022-06-02T22:33:47Z' description: OK security: - accountSid_authToken: [] operationId: FetchTrunks - x-maturity: - - GA servers: - url: https://routes.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: RoutesV2PhoneNumber +- name: RoutesV2SipDomain +- name: RoutesV2Trunk +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_serverless_v1.yaml b/spec/yaml/twilio_serverless_v1.yaml index 357e8469..5317b039 100644 --- a/spec/yaml/twilio_serverless_v1.yaml +++ b/spec/yaml/twilio_serverless_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: serverless.v1.service.asset: type: object @@ -31,6 +35,10 @@ components: nullable: true description: The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters. + x-twilio: + pii: + handling: standard + deleteSla: 7 date_created: type: string format: date-time @@ -96,6 +104,10 @@ components: slash ('/'). If an Asset Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one. + x-twilio: + pii: + handling: standard + deleteSla: 7 visibility: type: string $ref: '#/components/schemas/asset_version_enum_visibility' @@ -211,6 +223,7 @@ components: - node12 - node14 - node16 + - node18 serverless.v1.service.build.build_status: type: object properties: @@ -352,17 +365,29 @@ components: nullable: true description: A user-defined string that uniquely identifies the Environment resource. + x-twilio: + pii: + handling: standard + deleteSla: 7 domain_suffix: type: string nullable: true description: A URL-friendly name that represents the environment and forms part of the domain name. + x-twilio: + pii: + handling: standard + deleteSla: 7 domain_name: type: string nullable: true description: The domain name for all Functions and Assets deployed in the Environment, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix. + x-twilio: + pii: + handling: standard + deleteSla: 7 date_created: type: string format: date-time @@ -419,6 +444,10 @@ components: nullable: true description: The string that you assigned to describe the Function resource. It can be a maximum of 255 characters. + x-twilio: + pii: + handling: standard + deleteSla: 7 date_created: type: string format: date-time @@ -485,6 +514,10 @@ components: with a forward slash ('/'). If a Function Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one. + x-twilio: + pii: + handling: standard + deleteSla: 7 visibility: type: string $ref: '#/components/schemas/function_version_enum_visibility' @@ -665,12 +698,20 @@ components: type: string nullable: true description: The string that you assigned to describe the Service resource. + x-twilio: + pii: + handling: standard + deleteSla: 7 unique_name: type: string nullable: true description: A user-defined string that uniquely identifies the Service resource. It can be used in place of the Service resource's `sid` in the URL to address the Service resource. + x-twilio: + pii: + handling: standard + deleteSla: 7 include_credentials: type: boolean nullable: true @@ -747,10 +788,18 @@ components: type: string nullable: true description: A string by which the Variable resource can be referenced. + x-twilio: + pii: + handling: standard + deleteSla: 7 value: type: string nullable: true description: A string that contains the actual value of the Variable. + x-twilio: + pii: + handling: standard + deleteSla: 7 date_created: type: string format: date-time @@ -769,10 +818,6 @@ components: format: uri nullable: true description: The absolute URL of the Variable resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Serverless description: This is the public Twilio REST API. @@ -784,7 +829,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Assets: @@ -797,12 +842,18 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: - asset_version: '{service_sid: service_sid, asset_sid: sid}' + asset_versions: + mapping: + service_sid: service_sid + asset_sid: sid + resource_url: /v1/Services/{service_sid}/Assets/{asset_sid}/Versions parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all Assets. + tags: + - ServerlessV1Asset parameters: - name: ServiceSid in: path @@ -842,36 +893,48 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.asset' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + assets: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0 + key: assets + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListAsset - x-maturity: - - Beta post: description: Create a new Asset resource. + tags: + - ServerlessV1Asset parameters: - name: ServiceSid in: path @@ -885,12 +948,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset' + examples: + create: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: asset-friendly + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000 + links: + asset_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions description: Created security: - accountSid_authToken: [] operationId: CreateAsset - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -904,6 +977,10 @@ paths: Asset resource. It can be a maximum of 255 characters. required: - FriendlyName + examples: + create: + value: + FriendlyName: asset-friendly /v1/Services/{ServiceSid}/Assets/{Sid}: servers: - url: https://serverless.twilio.com @@ -914,12 +991,18 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: - asset_version: '{service_sid: service_sid, asset_sid: sid}' + asset_versions: + mapping: + service_sid: service_sid + asset_sid: sid + resource_url: /v1/Services/{service_sid}/Assets/{asset_sid}/Versions parent: /Services/{Sid} + pathType: instance get: description: Retrieve a specific Asset resource. + tags: + - ServerlessV1Asset parameters: - name: ServiceSid in: path @@ -942,14 +1025,26 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset' + examples: + fetch: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: test-asset + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000 + links: + asset_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions description: OK security: - accountSid_authToken: [] operationId: FetchAsset - x-maturity: - - Beta delete: description: Delete an Asset resource. + tags: + - ServerlessV1Asset parameters: - name: ServiceSid in: path @@ -972,10 +1067,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteAsset - x-maturity: - - Beta post: description: Update a specific Asset resource. + tags: + - ServerlessV1Asset parameters: - name: ServiceSid in: path @@ -998,12 +1093,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset' + examples: + update: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: asset-friendly-update + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000 + links: + asset_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions description: OK security: - accountSid_authToken: [] operationId: UpdateAsset - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1017,6 +1122,10 @@ paths: Asset resource. It can be a maximum of 255 characters. required: - FriendlyName + examples: + update: + value: + FriendlyName: asset-friendly-update /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions: servers: - url: https://serverless.twilio.com @@ -1027,11 +1136,13 @@ paths: - path - visibility - date_created - pathType: list parent: /Services/{ServiceSid}/Assets/{Sid} mountName: asset_versions + pathType: list get: description: Retrieve a list of all Asset Versions. + tags: + - ServerlessV1AssetVersion parameters: - name: ServiceSid in: path @@ -1081,34 +1192,44 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.asset.asset_version' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + asset_versions: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0 + key: asset_versions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListAssetVersion - x-maturity: - - Beta /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid}: servers: - url: https://serverless.twilio.com @@ -1119,11 +1240,13 @@ paths: - path - visibility - date_created - pathType: instance parent: /Services/{ServiceSid}/Assets/{Sid} mountName: asset_versions + pathType: instance get: description: Retrieve a specific Asset Version. + tags: + - ServerlessV1AssetVersion parameters: - name: ServiceSid in: path @@ -1156,12 +1279,21 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset.asset_version' + examples: + fetch: + value: + sid: ZN00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + asset_sid: ZH00000000000000000000000000000000 + path: /test-path + visibility: public + date_created: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000 description: OK security: - accountSid_authToken: [] operationId: FetchAssetVersion - x-maturity: - - Beta /v1/Services/{ServiceSid}/Builds: servers: - url: https://serverless.twilio.com @@ -1172,12 +1304,18 @@ paths: - sid - status - date_created - pathType: list dependentProperties: - build_status: '{service_sid: service_sid, sid: sid}' + build_status: + mapping: + service_sid: service_sid + sid: sid + resource_url: /v1/Services/{service_sid}/Builds/{sid}/Status parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all Builds. + tags: + - ServerlessV1Build parameters: - name: ServiceSid in: path @@ -1217,37 +1355,49 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.build' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + builds: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds?PageSize=50&Page=0 + key: builds + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListBuild - x-maturity: - - Beta post: description: Create a new Build resource. At least one function version or asset version is required. + tags: + - ServerlessV1Build parameters: - name: ServiceSid in: path @@ -1261,12 +1411,44 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.build' + examples: + create: + value: + sid: ZB00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + asset_versions: + - sid: ZN00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + asset_sid: ZH00000000000000000000000000000000 + date_created: '2018-11-10T20:00:00Z' + path: /asset-path + visibility: PUBLIC + function_versions: + - sid: ZN00000000000000000000000000000001 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + function_sid: ZH00000000000000000000000000000001 + date_created: '2018-11-10T20:00:00Z' + path: /function-path + visibility: PUBLIC + dependencies: + - name: twilio + version: 3.29.2 + - name: '@twilio/runtime-handler' + version: 1.0.1 + runtime: 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 description: Created security: - accountSid_authToken: [] operationId: CreateBuild - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1301,6 +1483,15 @@ paths: type: string description: The Runtime version that will be used to run the Build resource when it is deployed. + examples: + create: + value: + AssetVersions: + - ZN00000000000000000000000000000000 + FunctionVersions: + - ZN00000000000000000000000000000001 + Dependencies: '[{"name":"twilio", "version":"3.29.2"}, {"name":"@twilio/runtime-handler", + "version": "1.0.1"}]' /v1/Services/{ServiceSid}/Builds/{Sid}: servers: - url: https://serverless.twilio.com @@ -1311,12 +1502,18 @@ paths: - sid - status - date_created - pathType: instance dependentProperties: - build_status: '{service_sid: service_sid, sid: sid}' + build_status: + mapping: + service_sid: service_sid + sid: sid + resource_url: /v1/Services/{service_sid}/Builds/{sid}/Status parent: /Services/{Sid} + pathType: instance get: description: Retrieve a specific Build resource. + tags: + - ServerlessV1Build parameters: - name: ServiceSid in: path @@ -1339,14 +1536,48 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.build' + examples: + fetch: + value: + sid: ZB00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + asset_versions: + - sid: ZN00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + asset_sid: ZH00000000000000000000000000000000 + date_created: '2018-11-10T20:00:00Z' + path: /asset-path + visibility: PUBLIC + function_versions: + - sid: ZN00000000000000000000000000000001 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + function_sid: ZH00000000000000000000000000000001 + date_created: '2018-11-10T20:00:00Z' + path: /function-path + visibility: PUBLIC + dependencies: + - name: twilio + version: 3.29.2 + - name: '@twilio/runtime-handler' + version: 1.0.1 + runtime: 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 description: OK security: - accountSid_authToken: [] operationId: FetchBuild - x-maturity: - - Beta delete: description: Delete a Build resource. + tags: + - ServerlessV1Build parameters: - name: ServiceSid in: path @@ -1369,8 +1600,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBuild - x-maturity: - - Beta /v1/Services/{ServiceSid}/Builds/{Sid}/Status: servers: - url: https://serverless.twilio.com @@ -1379,11 +1608,13 @@ paths: defaultOutputProperties: - sid - status - pathType: instance parent: /Services/{ServiceSid}/Builds/{Sid} mountName: build_status + pathType: instance get: description: Retrieve a specific Build resource. + tags: + - ServerlessV1BuildStatus parameters: - name: ServiceSid in: path @@ -1406,12 +1637,18 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.build.build_status' + examples: + fetch: + value: + sid: ZB00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + status: completed + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status description: OK security: - accountSid_authToken: [] operationId: FetchBuildStatus - x-maturity: - - Beta /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments: servers: - url: https://serverless.twilio.com @@ -1422,10 +1659,12 @@ paths: - sid - build_sid - date_created - pathType: list parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: list get: description: Retrieve a list of all Deployments. + tags: + - ServerlessV1Deployment parameters: - name: ServiceSid in: path @@ -1475,36 +1714,48 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.environment.deployment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + deployments: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments?PageSize=50&Page=0 + key: deployments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDeployment - x-maturity: - - Beta post: description: Create a new Deployment. + tags: + - ServerlessV1Deployment parameters: - name: ServiceSid in: path @@ -1527,12 +1778,21 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.deployment' + examples: + create: + value: + sid: ZD00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + build_sid: ZB00000000000000000000000000000000 + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments/ZD00000000000000000000000000000000 description: Created security: - accountSid_authToken: [] operationId: CreateDeployment - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1546,6 +1806,10 @@ paths: maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ description: The SID of the Build for the Deployment. + examples: + create: + value: + BuildSid: ZB00000000000000000000000000000000 /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments/{Sid}: servers: - url: https://serverless.twilio.com @@ -1556,10 +1820,12 @@ paths: - sid - build_sid - date_created - pathType: instance parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: instance get: description: Retrieve a specific Deployment. + tags: + - ServerlessV1Deployment parameters: - name: ServiceSid in: path @@ -1591,12 +1857,21 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.deployment' + examples: + fetch: + value: + sid: ZD00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + build_sid: ZB00000000000000000000000000000000 + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments/ZD00000000000000000000000000000000 description: OK security: - accountSid_authToken: [] operationId: FetchDeployment - x-maturity: - - Beta /v1/Services/{ServiceSid}/Environments: servers: - url: https://serverless.twilio.com @@ -1608,14 +1883,28 @@ paths: - unique_name - domain_name - build_sid - pathType: list dependentProperties: - variable: '{service_sid: service_sid, environment_sid: sid}' - deployment: '{service_sid: service_sid, environment_sid: sid}' - log: '{service_sid: service_sid, environment_sid: sid}' + variables: + mapping: + service_sid: service_sid + environment_sid: sid + resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Variables + deployments: + mapping: + service_sid: service_sid + environment_sid: sid + resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Deployments + logs: + mapping: + service_sid: service_sid + environment_sid: sid + resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Logs parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all environments. + tags: + - ServerlessV1Environment parameters: - name: ServiceSid in: path @@ -1655,36 +1944,48 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.environment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + environments: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments?PageSize=50&Page=0 + key: environments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListEnvironment - x-maturity: - - Beta post: description: Create a new environment. + tags: + - ServerlessV1Environment parameters: - name: ServiceSid in: path @@ -1698,12 +1999,28 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment' + examples: + create: + value: + sid: ZE00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + build_sid: null + unique_name: staging + domain_suffix: stage + domain_name: foobar-1234-stage.twil.io + custom_domain_name: null + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000 + links: + variables: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables + deployments: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments + logs: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs description: Created security: - accountSid_authToken: [] operationId: CreateEnvironment - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1721,6 +2038,11 @@ paths: and forms part of the domain name. It can be a maximum of 16 characters. required: - UniqueName + examples: + create: + value: + UniqueName: staging + DomainSuffix: stage /v1/Services/{ServiceSid}/Environments/{Sid}: servers: - url: https://serverless.twilio.com @@ -1732,14 +2054,28 @@ paths: - unique_name - domain_name - build_sid - pathType: instance dependentProperties: - variable: '{service_sid: service_sid, environment_sid: sid}' - deployment: '{service_sid: service_sid, environment_sid: sid}' - log: '{service_sid: service_sid, environment_sid: sid}' + variables: + mapping: + service_sid: service_sid + environment_sid: sid + resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Variables + deployments: + mapping: + service_sid: service_sid + environment_sid: sid + resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Deployments + logs: + mapping: + service_sid: service_sid + environment_sid: sid + resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Logs parent: /Services/{Sid} + pathType: instance get: description: Retrieve a specific environment. + tags: + - ServerlessV1Environment parameters: - name: ServiceSid in: path @@ -1762,14 +2098,32 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment' + examples: + fetch: + value: + sid: ZE00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + build_sid: ZB00000000000000000000000000000000 + unique_name: testing-environment + domain_suffix: testing + domain_name: foobar-1234-testing.twil.io + custom_domain_name: null + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000 + links: + variables: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables + deployments: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments + logs: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs description: OK security: - accountSid_authToken: [] operationId: FetchEnvironment - x-maturity: - - Beta delete: description: Delete a specific environment. + tags: + - ServerlessV1Environment parameters: - name: ServiceSid in: path @@ -1792,8 +2146,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteEnvironment - x-maturity: - - Beta /v1/Services/{ServiceSid}/Functions: servers: - url: https://serverless.twilio.com @@ -1804,12 +2156,18 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: - function_version: '{service_sid: service_sid, function_sid: sid}' + function_versions: + mapping: + service_sid: service_sid + function_sid: sid + resource_url: /v1/Services/{service_sid}/Functions/{function_sid}/Versions parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all Functions. + tags: + - ServerlessV1Function parameters: - name: ServiceSid in: path @@ -1849,36 +2207,48 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.function' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + functions: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0 + key: functions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListFunction - x-maturity: - - Beta post: description: Create a new Function resource. + tags: + - ServerlessV1Function parameters: - name: ServiceSid in: path @@ -1892,12 +2262,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function' + examples: + create: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: function-friendly + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000 + links: + function_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions description: Created security: - accountSid_authToken: [] operationId: CreateFunction - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1911,6 +2291,10 @@ paths: Function resource. It can be a maximum of 255 characters. required: - FriendlyName + examples: + create: + value: + FriendlyName: function-friendly /v1/Services/{ServiceSid}/Functions/{Sid}: servers: - url: https://serverless.twilio.com @@ -1921,12 +2305,18 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: - function_version: '{service_sid: service_sid, function_sid: sid}' + function_versions: + mapping: + service_sid: service_sid + function_sid: sid + resource_url: /v1/Services/{service_sid}/Functions/{function_sid}/Versions parent: /Services/{Sid} + pathType: instance get: description: Retrieve a specific Function resource. + tags: + - ServerlessV1Function parameters: - name: ServiceSid in: path @@ -1949,14 +2339,26 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function' + examples: + fetch: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: test-function + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000 + links: + function_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions description: OK security: - accountSid_authToken: [] operationId: FetchFunction - x-maturity: - - Beta delete: description: Delete a Function resource. + tags: + - ServerlessV1Function parameters: - name: ServiceSid in: path @@ -1979,10 +2381,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteFunction - x-maturity: - - Beta post: description: Update a specific Function resource. + tags: + - ServerlessV1Function parameters: - name: ServiceSid in: path @@ -2005,12 +2407,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function' + examples: + update: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: function-friendly-update + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000 + links: + function_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions description: OK security: - accountSid_authToken: [] operationId: UpdateFunction - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2024,6 +2436,10 @@ paths: Function resource. It can be a maximum of 255 characters. required: - FriendlyName + examples: + update: + value: + FriendlyName: function-friendly-update /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions: servers: - url: https://serverless.twilio.com @@ -2034,14 +2450,20 @@ paths: - path - visibility - date_created - pathType: list dependentProperties: - function_version_content: '{service_sid: service_sid, function_sid: function_sid, - sid: sid}' + function_version_content: + mapping: + service_sid: service_sid + function_sid: function_sid + sid: sid + resource_url: /v1/Services/{service_sid}/Functions/{function_sid}/Versions/{sid}/Content parent: /Services/{ServiceSid}/Functions/{Sid} mountName: function_versions + pathType: list get: description: Retrieve a list of all Function Version resources. + tags: + - ServerlessV1FunctionVersion parameters: - name: ServiceSid in: path @@ -2092,34 +2514,44 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.function.function_version' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + function_versions: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0 + key: function_versions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListFunctionVersion - x-maturity: - - Beta /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}: servers: - url: https://serverless.twilio.com @@ -2130,14 +2562,20 @@ paths: - path - visibility - date_created - pathType: instance dependentProperties: - function_version_content: '{service_sid: service_sid, function_sid: function_sid, - sid: sid}' + function_version_content: + mapping: + service_sid: service_sid + function_sid: function_sid + sid: sid + resource_url: /v1/Services/{service_sid}/Functions/{function_sid}/Versions/{sid}/Content parent: /Services/{ServiceSid}/Functions/{Sid} mountName: function_versions + pathType: instance get: description: Retrieve a specific Function Version resource. + tags: + - ServerlessV1FunctionVersion parameters: - name: ServiceSid in: path @@ -2171,12 +2609,23 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function.function_version' + examples: + fetch: + value: + sid: ZN00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + function_sid: ZH00000000000000000000000000000000 + path: /test-path + visibility: public + date_created: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000 + links: + function_version_content: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000/Content description: OK security: - accountSid_authToken: [] operationId: FetchFunctionVersion - x-maturity: - - Beta /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}/Content: servers: - url: https://serverless.twilio.com @@ -2185,11 +2634,13 @@ paths: defaultOutputProperties: - sid - content - pathType: instance parent: /Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid} mountName: function_version_content + pathType: instance get: description: Retrieve a the content of a specific Function Version resource. + tags: + - ServerlessV1FunctionVersionContent parameters: - name: ServiceSid in: path @@ -2223,22 +2674,34 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function.function_version.function_version_content' + examples: + fetch: + value: + sid: ZN00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + function_sid: ZH00000000000000000000000000000000 + content: "exports.handler = function (context, event, callback)\ + \ {\n const request = require(\"request\");\n return request(\"\ + http://www.google.com\", function (error, response, body) {\n\ + \ callback(null, response.statusCode);\n });\n};" + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000/Content description: OK security: - accountSid_authToken: [] operationId: FetchFunctionVersionContent - x-maturity: - - Beta /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs: servers: - url: https://serverless.twilio.com description: A record of an event that occurred related to a function invocation. x-twilio: defaultOutputProperties: [] - pathType: list parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: list get: description: Retrieve a list of all logs. + tags: + - ServerlessV1Log parameters: - name: ServiceSid in: path @@ -2264,6 +2727,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: ZH00000000000000000000000000000000 - name: StartDate in: query description: The date/time (in GMT, ISO 8601) after which the Log resources @@ -2271,6 +2737,9 @@ paths: schema: type: string format: date-time + examples: + readEmpty: + value: '2018-11-10T20:00:00Z' - name: EndDate in: query description: The date/time (in GMT, ISO 8601) before which the Log resources @@ -2278,6 +2747,9 @@ paths: schema: type: string format: date-time + examples: + readEmpty: + value: '2018-12-10T20:00:00Z' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2310,44 +2782,56 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.environment.log' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + logs: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs?StartDate=2018-11-10T20%3A00%3A00Z&EndDate=2018-12-10T20%3A00%3A00Z&FunctionSid=ZH00000000000000000000000000000000&PageSize=50&Page=0 + key: logs + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs?StartDate=2018-11-10T20%3A00%3A00Z&EndDate=2018-12-10T20%3A00%3A00Z&FunctionSid=ZH00000000000000000000000000000000&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListLog - x-maturity: - - Beta /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs/{Sid}: servers: - url: https://serverless.twilio.com description: A record of an event that occurred related to a function invocation. x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: instance get: description: Retrieve a specific log. + tags: + - ServerlessV1Log parameters: - name: ServiceSid in: path @@ -2379,12 +2863,25 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.log' + examples: + fetch: + value: + sid: NO00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + build_sid: ZB00000000000000000000000000000000 + deployment_sid: ZD00000000000000000000000000000000 + function_sid: ZH00000000000000000000000000000000 + request_sid: RQ00000000000000000000000000000000 + level: warn + message: This is a warning + date_created: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs/NO00000000000000000000000000000000 description: OK security: - accountSid_authToken: [] operationId: FetchLog - x-maturity: - - Beta /v1/Services: servers: - url: https://serverless.twilio.com @@ -2395,14 +2892,28 @@ paths: - sid - unique_name - friendly_name - pathType: list dependentProperties: - environment: '{service_sid: sid}' - function: '{service_sid: sid}' - asset: '{service_sid: sid}' - build: '{service_sid: sid}' + environments: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Environments + functions: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Functions + assets: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Assets + builds: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Builds + pathType: list get: description: Retrieve a list of all Services. + tags: + - ServerlessV1Service parameters: - name: PageSize in: query @@ -2436,48 +2947,76 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + services: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - Beta post: description: Create a new Service resource. + tags: + - ServerlessV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service' + examples: + create: + value: + sid: ZS00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: service-friendly + unique_name: service-unique + include_credentials: true + ui_editable: false + domain_base: service-unique-1234 + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000 + links: + environments: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments + functions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions + assets: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets + builds: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2506,6 +3045,11 @@ paths: required: - UniqueName - FriendlyName + examples: + create: + value: + FriendlyName: service-friendly + UniqueName: service-unique /v1/Services/{Sid}: servers: - url: https://serverless.twilio.com @@ -2516,14 +3060,28 @@ paths: - sid - unique_name - friendly_name - pathType: instance dependentProperties: - environment: '{service_sid: sid}' - function: '{service_sid: sid}' - asset: '{service_sid: sid}' - build: '{service_sid: sid}' + environments: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Environments + functions: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Functions + assets: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Assets + builds: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Builds + pathType: instance get: description: Retrieve a specific Service resource. + tags: + - ServerlessV1Service parameters: - name: Sid in: path @@ -2537,14 +3095,32 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service' + examples: + fetch: + value: + sid: ZS00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: test-service + unique_name: test-service-1 + include_credentials: true + ui_editable: false + domain_base: test-service-1-1234 + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000 + links: + environments: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments + functions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions + assets: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets + builds: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - Beta delete: description: Delete a Service resource. + tags: + - ServerlessV1Service parameters: - name: Sid in: path @@ -2558,10 +3134,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - Beta post: description: Update a specific Service resource. + tags: + - ServerlessV1Service parameters: - name: Sid in: path @@ -2575,12 +3151,28 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service' + examples: + update: + value: + sid: ZS00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: service-friendly-update + unique_name: service-unique-update + include_credentials: true + ui_editable: true + domain_base: service-unique-update-1234 + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000 + links: + environments: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments + functions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions + assets: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets + builds: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2600,6 +3192,12 @@ paths: type: boolean description: Whether the Service resource's properties and subresources can be edited via the UI. The default value is `false`. + examples: + update: + value: + FriendlyName: service-friendly-update + IncludeCredentials: true + UiEditable: true /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables: servers: - url: https://serverless.twilio.com @@ -2609,10 +3207,12 @@ paths: - sid - key - date_created - pathType: list parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: list get: description: Retrieve a list of all Variables. + tags: + - ServerlessV1Variable parameters: - name: ServiceSid in: path @@ -2661,36 +3261,48 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.environment.variable' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + variables: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables?PageSize=50&Page=0 + key: variables + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListVariable - x-maturity: - - Beta post: description: Create a new Variable. + tags: + - ServerlessV1Variable parameters: - name: ServiceSid in: path @@ -2713,12 +3325,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.variable' + examples: + create: + value: + sid: ZV00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + key: new-key + value: new-value + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000 description: Created security: - accountSid_authToken: [] operationId: CreateVariable - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2737,6 +3359,11 @@ paths: required: - Key - Value + examples: + create: + value: + Key: new-key + Value: new-value /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables/{Sid}: servers: - url: https://serverless.twilio.com @@ -2746,10 +3373,12 @@ paths: - sid - key - date_created - pathType: instance parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: instance get: description: Retrieve a specific Variable. + tags: + - ServerlessV1Variable parameters: - name: ServiceSid in: path @@ -2781,14 +3410,26 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.variable' + examples: + fetch: + value: + sid: ZV00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + key: test-key + value: test-value + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000 description: OK security: - accountSid_authToken: [] operationId: FetchVariable - x-maturity: - - Beta post: description: Update a specific Variable. + tags: + - ServerlessV1Variable parameters: - name: ServiceSid in: path @@ -2820,12 +3461,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.variable' + examples: + update: + value: + sid: ZV00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + key: update-key + value: update-value + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-11T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000 description: OK security: - accountSid_authToken: [] operationId: UpdateVariable - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2841,8 +3492,15 @@ paths: type: string description: A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size. + examples: + update: + value: + Key: update-key + Value: update-value delete: description: Delete a specific Variable. + tags: + - ServerlessV1Variable parameters: - name: ServiceSid in: path @@ -2874,11 +3532,20 @@ paths: security: - accountSid_authToken: [] operationId: DeleteVariable - x-maturity: - - Beta servers: - url: https://serverless.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: ServerlessV1Asset +- name: ServerlessV1AssetVersion +- name: ServerlessV1Build +- name: ServerlessV1BuildStatus +- name: ServerlessV1Deployment +- name: ServerlessV1Environment +- name: ServerlessV1Function +- name: ServerlessV1FunctionVersion +- name: ServerlessV1FunctionVersionContent +- name: ServerlessV1Log +- name: ServerlessV1Service +- name: ServerlessV1Variable +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_studio_v1.yaml b/spec/yaml/twilio_studio_v1.yaml index cc5ed58b..f2ad1945 100644 --- a/spec/yaml/twilio_studio_v1.yaml +++ b/spec/yaml/twilio_studio_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: studio.v1.flow.engagement: type: object @@ -153,12 +157,20 @@ components: the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. + x-twilio: + pii: + handling: standard + deleteSla: 30 context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 status: type: string $ref: '#/components/schemas/execution_enum_status' @@ -208,6 +220,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 flow_sid: type: string minLength: 34 @@ -270,6 +286,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 transitioned_from: type: string nullable: true @@ -317,6 +337,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 execution_sid: type: string minLength: 34 @@ -443,6 +467,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 transitioned_from: type: string nullable: true @@ -490,6 +518,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 engagement_sid: type: string minLength: 34 @@ -516,10 +548,6 @@ components: format: uri nullable: true description: The absolute URL of the resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Studio description: This is the public Twilio REST API. @@ -531,7 +559,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Flows/{FlowSid}/Engagements: @@ -544,13 +572,23 @@ paths: - contact_sid - status - date_created - pathType: list dependentProperties: - step: '{flow_sid: flow_sid, engagement_sid: sid}' - engagement_context: '{flow_sid: flow_sid, engagement_sid: sid}' + steps: + mapping: + flow_sid: flow_sid + engagement_sid: sid + resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps + engagement_context: + mapping: + flow_sid: flow_sid + engagement_sid: sid + resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Context parent: /Flows/{Sid} + pathType: list get: description: Retrieve a list of all Engagements for the Flow. + tags: + - StudioV1Engagement parameters: - name: FlowSid in: path @@ -593,36 +631,48 @@ paths: items: $ref: '#/components/schemas/studio.v1.flow.engagement' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements?PageSize=50&Page=0 + page_size: 50 + key: engagements + engagements: [] description: OK security: - accountSid_authToken: [] operationId: ListEngagement - x-maturity: - - GA post: description: Triggers a new Engagement for the Flow + tags: + - StudioV1Engagement parameters: - name: FlowSid in: path @@ -639,12 +689,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement' + examples: + create: + value: + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: {} + contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+18001234567' + status: active + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + engagement_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: Created security: - accountSid_authToken: [] operationId: CreateEngagement - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -674,6 +738,12 @@ paths: required: - To - From + examples: + create: + value: + To: '+18001234567' + From: '+18007654321' + Parameters: '{"first_name":"Foo"}' /v1/Flows/{FlowSid}/Engagements/{Sid}: servers: - url: https://studio.twilio.com @@ -684,13 +754,23 @@ paths: - contact_sid - status - date_created - pathType: instance dependentProperties: - step: '{flow_sid: flow_sid, engagement_sid: sid}' - engagement_context: '{flow_sid: flow_sid, engagement_sid: sid}' + steps: + mapping: + flow_sid: flow_sid + engagement_sid: sid + resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps + engagement_context: + mapping: + flow_sid: flow_sid + engagement_sid: sid + resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Context parent: /Flows/{Sid} + pathType: instance get: description: Retrieve an Engagement + tags: + - StudioV1Engagement parameters: - name: FlowSid in: path @@ -716,14 +796,30 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement' + examples: + fetch: + value: + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+14155555555' + status: ended + context: {} + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + engagement_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchEngagement - x-maturity: - - GA delete: description: Delete this Engagement and all Steps relating to it. + tags: + - StudioV1Engagement parameters: - name: FlowSid in: path @@ -749,8 +845,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteEngagement - x-maturity: - - GA /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context: servers: - url: https://studio.twilio.com @@ -758,11 +852,13 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Engagements/{Sid} mountName: engagement_context + pathType: instance get: description: Retrieve the most recent context for an Engagement. + tags: + - StudioV1EngagementContext parameters: - name: FlowSid in: path @@ -788,12 +884,19 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement.engagement_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + engagement_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchEngagementContext - x-maturity: - - GA /v1/Flows/{FlowSid}/Executions: servers: - url: https://studio.twilio.com @@ -804,13 +907,23 @@ paths: - contact_sid - status - date_created - pathType: list dependentProperties: - execution_step: '{flow_sid: flow_sid, execution_sid: sid}' - execution_context: '{flow_sid: flow_sid, execution_sid: sid}' + steps: + mapping: + flow_sid: flow_sid + execution_sid: sid + resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps + execution_context: + mapping: + flow_sid: flow_sid + execution_sid: sid + resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Context parent: /Flows/{Sid} + pathType: list get: description: Retrieve a list of all Executions for the Flow. + tags: + - StudioV1Execution parameters: - name: FlowSid in: path @@ -867,36 +980,48 @@ paths: items: $ref: '#/components/schemas/studio.v1.flow.execution' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0 + page_size: 50 + key: executions + executions: [] description: OK security: - accountSid_authToken: [] operationId: ListExecution - x-maturity: - - GA post: description: Triggers a new Execution for the Flow + tags: + - StudioV1Execution parameters: - name: FlowSid in: path @@ -913,12 +1038,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution' + examples: + create: + value: + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: {} + contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+18001234567' + status: active + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: Created security: - accountSid_authToken: [] operationId: CreateExecution - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -949,6 +1088,12 @@ paths: required: - To - From + examples: + create: + value: + To: '+18001234567' + From: '+18007654321' + Parameters: '{"first_name":"Foo"}' /v1/Flows/{FlowSid}/Executions/{Sid}: servers: - url: https://studio.twilio.com @@ -959,13 +1104,23 @@ paths: - contact_sid - status - date_created - pathType: instance dependentProperties: - execution_step: '{flow_sid: flow_sid, execution_sid: sid}' - execution_context: '{flow_sid: flow_sid, execution_sid: sid}' + steps: + mapping: + flow_sid: flow_sid + execution_sid: sid + resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps + execution_context: + mapping: + flow_sid: flow_sid + execution_sid: sid + resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Context parent: /Flows/{Sid} + pathType: instance get: description: Retrieve an Execution + tags: + - StudioV1Execution parameters: - name: FlowSid in: path @@ -991,14 +1146,30 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution' + examples: + fetch: + value: + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+14155555555' + status: ended + context: {} + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecution - x-maturity: - - GA delete: description: Delete the Execution and all Steps relating to it. + tags: + - StudioV1Execution parameters: - name: FlowSid in: path @@ -1024,10 +1195,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteExecution - x-maturity: - - GA post: description: Update the status of an Execution to `ended`. + tags: + - StudioV1Execution parameters: - name: FlowSid in: path @@ -1053,12 +1224,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution' + examples: + update: + value: + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: {} + contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+14155555555' + status: ended + date_created: '2017-11-06T12:00:00Z' + date_updated: '2017-11-06T12:00:00Z' + links: + steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: UpdateExecution - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1072,6 +1257,10 @@ paths: description: The status of the Execution. Can only be `ended`. required: - Status + examples: + update: + value: + Status: ended /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Context: servers: - url: https://studio.twilio.com @@ -1079,11 +1268,13 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Executions/{Sid} mountName: execution_context + pathType: instance get: description: Retrieve the most recent context for an Execution. + tags: + - StudioV1ExecutionContext parameters: - name: FlowSid in: path @@ -1109,12 +1300,19 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution.execution_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionContext - x-maturity: - - GA /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps: servers: - url: https://studio.twilio.com @@ -1124,14 +1322,20 @@ paths: - sid - name - date_created - pathType: list dependentProperties: - execution_step_context: '{flow_sid: flow_sid, execution_sid: execution_sid, - step_sid: sid}' + step_context: + mapping: + flow_sid: flow_sid + execution_sid: execution_sid + step_sid: sid + resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step + pathType: list get: description: Retrieve a list of all Steps for an Execution. + tags: + - StudioV1ExecutionStep parameters: - name: FlowSid in: path @@ -1183,34 +1387,44 @@ paths: items: $ref: '#/components/schemas/studio.v1.flow.execution.execution_step' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page_size: 50 + key: steps + steps: [] description: OK security: - accountSid_authToken: [] operationId: ListExecutionStep - x-maturity: - - GA /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}: servers: - url: https://studio.twilio.com @@ -1220,14 +1434,20 @@ paths: - sid - name - date_created - pathType: instance dependentProperties: - execution_step_context: '{flow_sid: flow_sid, execution_sid: execution_sid, - step_sid: sid}' + step_context: + mapping: + flow_sid: flow_sid + execution_sid: execution_sid + step_sid: sid + resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step + pathType: instance get: description: Retrieve a Step. + tags: + - StudioV1ExecutionStep parameters: - name: FlowSid in: path @@ -1262,12 +1482,27 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution.execution_step' + examples: + fetch: + value: + sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + parent_step_sid: null + name: incomingRequest + context: {} + transitioned_from: Trigger + transitioned_to: Ended + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + step_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionStep - x-maturity: - - GA /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context: servers: - url: https://studio.twilio.com @@ -1275,12 +1510,14 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid} mountName: step_context className: execution_step_context + pathType: instance get: description: Retrieve the context for an Execution Step. + tags: + - StudioV1ExecutionStepContext parameters: - name: FlowSid in: path @@ -1315,12 +1552,20 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution.execution_step.execution_step_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + step_sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionStepContext - x-maturity: - - GA /v1/Flows: servers: - url: https://studio.twilio.com @@ -1331,12 +1576,20 @@ paths: - friendly_name - status - version - pathType: list dependentProperties: - engagement: '{flow_sid: sid}' - execution: '{flow_sid: sid}' + engagements: + mapping: + flow_sid: sid + resource_url: /v1/Flows/{flow_sid}/Engagements + executions: + mapping: + flow_sid: sid + resource_url: /v1/Flows/{flow_sid}/Executions + pathType: list get: description: Retrieve a list of all Flows. + tags: + - StudioV1Flow parameters: - name: PageSize in: query @@ -1370,34 +1623,44 @@ paths: items: $ref: '#/components/schemas/studio.v1.flow' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v1/Flows?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v1/Flows?PageSize=50&Page=0 + page_size: 50 + key: flows + flows: [] description: OK security: - accountSid_authToken: [] operationId: ListFlow - x-maturity: - - GA /v1/Flows/{Sid}: servers: - url: https://studio.twilio.com @@ -1408,12 +1671,20 @@ paths: - friendly_name - status - version - pathType: instance dependentProperties: - engagement: '{flow_sid: sid}' - execution: '{flow_sid: sid}' + engagements: + mapping: + flow_sid: sid + resource_url: /v1/Flows/{flow_sid}/Engagements + executions: + mapping: + flow_sid: sid + resource_url: /v1/Flows/{flow_sid}/Executions + pathType: instance get: description: Retrieve a specific Flow. + tags: + - StudioV1Flow parameters: - name: Sid in: path @@ -1430,14 +1701,28 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow' + examples: + fetch: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test Flow + status: published + version: 1 + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + engagements: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements + executions: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions description: OK security: - accountSid_authToken: [] operationId: FetchFlow - x-maturity: - - GA delete: description: Delete a specific Flow. + tags: + - StudioV1Flow parameters: - name: Sid in: path @@ -1454,8 +1739,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteFlow - x-maturity: - - GA /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps: servers: - url: https://studio.twilio.com @@ -1466,13 +1749,19 @@ paths: - name - transitioned_from - transitioned_to - pathType: list dependentProperties: - step_context: '{flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: - sid}' + step_context: + mapping: + flow_sid: flow_sid + engagement_sid: engagement_sid + step_sid: sid + resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Engagements/{Sid} + pathType: list get: description: Retrieve a list of all Steps for an Engagement. + tags: + - StudioV1Step parameters: - name: FlowSid in: path @@ -1524,34 +1813,44 @@ paths: items: $ref: '#/components/schemas/studio.v1.flow.engagement.step' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page_size: 50 + key: steps + steps: [] description: OK security: - accountSid_authToken: [] operationId: ListStep - x-maturity: - - GA /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid}: servers: - url: https://studio.twilio.com @@ -1562,13 +1861,19 @@ paths: - name - transitioned_from - transitioned_to - pathType: instance dependentProperties: - step_context: '{flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: - sid}' + step_context: + mapping: + flow_sid: flow_sid + engagement_sid: engagement_sid + step_sid: sid + resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Engagements/{Sid} + pathType: instance get: description: Retrieve a Step. + tags: + - StudioV1Step parameters: - name: FlowSid in: path @@ -1603,12 +1908,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement.step' + examples: + fetch: + value: + sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + engagement_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: incomingRequest + context: {} + transitioned_from: Trigger + transitioned_to: Ended + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + step_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchStep - x-maturity: - - GA /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{StepSid}/Context: servers: - url: https://studio.twilio.com @@ -1616,11 +1935,13 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid} mountName: step_context + pathType: instance get: description: Retrieve the context for an Engagement Step. + tags: + - StudioV1StepContext parameters: - name: FlowSid in: path @@ -1655,14 +1976,31 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement.step.step_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + engagement_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + step_sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchStepContext - x-maturity: - - GA servers: - url: https://studio.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: StudioV1Engagement +- name: StudioV1EngagementContext +- name: StudioV1Execution +- name: StudioV1ExecutionContext +- name: StudioV1ExecutionStep +- name: StudioV1ExecutionStepContext +- name: StudioV1Flow +- name: StudioV1Step +- name: StudioV1StepContext +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_studio_v2.yaml b/spec/yaml/twilio_studio_v2.yaml index 9f74cdf6..14aa1828 100644 --- a/spec/yaml/twilio_studio_v2.yaml +++ b/spec/yaml/twilio_studio_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: studio.v2.flow.execution: type: object @@ -33,12 +37,20 @@ components: the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. + x-twilio: + pii: + handling: standard + deleteSla: 30 context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 status: type: string $ref: '#/components/schemas/execution_enum_status' @@ -88,6 +100,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 flow_sid: type: string minLength: 34 @@ -150,6 +166,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 transitioned_from: type: string nullable: true @@ -197,6 +217,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 execution_sid: type: string minLength: 34 @@ -409,10 +433,6 @@ components: format: uri nullable: true description: The URL of this resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Studio description: This is the public Twilio REST API. @@ -424,7 +444,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Flows/{FlowSid}/Executions: @@ -436,13 +456,23 @@ paths: - sid - status - date_created - pathType: list dependentProperties: - execution_step: '{flow_sid: flow_sid, execution_sid: sid}' - execution_context: '{flow_sid: flow_sid, execution_sid: sid}' + steps: + mapping: + flow_sid: flow_sid + execution_sid: sid + resource_url: /v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps + execution_context: + mapping: + flow_sid: flow_sid + execution_sid: sid + resource_url: /v2/Flows/{flow_sid}/Executions/{execution_sid}/Context parent: /Flows/{Sid} + pathType: list get: description: Retrieve a list of all Executions for the Flow. + tags: + - StudioV2Execution parameters: - name: FlowSid in: path @@ -499,36 +529,48 @@ paths: items: $ref: '#/components/schemas/studio.v2.flow.execution' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0 + page_size: 50 + key: executions + executions: [] description: OK security: - accountSid_authToken: [] operationId: ListExecution - x-maturity: - - GA post: description: Triggers a new Execution for the Flow + tags: + - StudioV2Execution parameters: - name: FlowSid in: path @@ -545,12 +587,25 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution' + examples: + create: + value: + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: {} + contact_channel_address: '+18001234567' + status: active + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + steps: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: Created security: - accountSid_authToken: [] operationId: CreateExecution - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -581,6 +636,12 @@ paths: required: - To - From + examples: + create: + value: + To: '+18001234567' + From: '+18007654321' + Parameters: '{"first_name":"Foo"}' /v2/Flows/{FlowSid}/Executions/{Sid}: servers: - url: https://studio.twilio.com @@ -590,13 +651,23 @@ paths: - sid - status - date_created - pathType: instance dependentProperties: - execution_step: '{flow_sid: flow_sid, execution_sid: sid}' - execution_context: '{flow_sid: flow_sid, execution_sid: sid}' + steps: + mapping: + flow_sid: flow_sid + execution_sid: sid + resource_url: /v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps + execution_context: + mapping: + flow_sid: flow_sid + execution_sid: sid + resource_url: /v2/Flows/{flow_sid}/Executions/{execution_sid}/Context parent: /Flows/{Sid} + pathType: instance get: description: Retrieve an Execution + tags: + - StudioV2Execution parameters: - name: FlowSid in: path @@ -622,14 +693,29 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution' + examples: + fetch: + value: + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+14155555555' + status: ended + context: {} + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + steps: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecution - x-maturity: - - GA delete: description: Delete the Execution and all Steps relating to it. + tags: + - StudioV2Execution parameters: - name: FlowSid in: path @@ -655,10 +741,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteExecution - x-maturity: - - GA post: description: Update the status of an Execution to `ended`. + tags: + - StudioV2Execution parameters: - name: FlowSid in: path @@ -684,12 +770,25 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution' + examples: + update: + value: + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: {} + contact_channel_address: '+14155555555' + status: ended + date_created: '2017-11-06T12:00:00Z' + date_updated: '2017-11-06T12:00:00Z' + links: + steps: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: UpdateExecution - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -703,6 +802,10 @@ paths: description: The status of the Execution. Can only be `ended`. required: - Status + examples: + update: + value: + Status: ended /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Context: servers: - url: https://studio.twilio.com @@ -710,11 +813,13 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Executions/{Sid} mountName: execution_context + pathType: instance get: description: Retrieve the most recent context for an Execution. + tags: + - StudioV2ExecutionContext parameters: - name: FlowSid in: path @@ -740,12 +845,19 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution.execution_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionContext - x-maturity: - - GA /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps: servers: - url: https://studio.twilio.com @@ -755,14 +867,20 @@ paths: - sid - name - date_created - pathType: list dependentProperties: - execution_step_context: '{flow_sid: flow_sid, execution_sid: execution_sid, - step_sid: sid}' + step_context: + mapping: + flow_sid: flow_sid + execution_sid: execution_sid + step_sid: sid + resource_url: /v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step + pathType: list get: description: Retrieve a list of all Steps for an Execution. + tags: + - StudioV2ExecutionStep parameters: - name: FlowSid in: path @@ -814,34 +932,44 @@ paths: items: $ref: '#/components/schemas/studio.v2.flow.execution.execution_step' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page_size: 50 + key: steps + steps: [] description: OK security: - accountSid_authToken: [] operationId: ListExecutionStep - x-maturity: - - GA /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}: servers: - url: https://studio.twilio.com @@ -851,14 +979,20 @@ paths: - sid - name - date_created - pathType: instance dependentProperties: - execution_step_context: '{flow_sid: flow_sid, execution_sid: execution_sid, - step_sid: sid}' + step_context: + mapping: + flow_sid: flow_sid + execution_sid: execution_sid + step_sid: sid + resource_url: /v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step + pathType: instance get: description: Retrieve a Step. + tags: + - StudioV2ExecutionStep parameters: - name: FlowSid in: path @@ -893,12 +1027,27 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution.execution_step' + examples: + fetch: + value: + sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + parent_step_sid: null + name: incomingRequest + context: {} + transitioned_from: Trigger + transitioned_to: Ended + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + step_context: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionStep - x-maturity: - - GA /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context: servers: - url: https://studio.twilio.com @@ -906,12 +1055,14 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid} mountName: step_context className: execution_step_context + pathType: instance get: description: Retrieve the context for an Execution Step. + tags: + - StudioV2ExecutionStepContext parameters: - name: FlowSid in: path @@ -946,12 +1097,20 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution.execution_step.execution_step_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + step_sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionStepContext - x-maturity: - - GA /v2/Flows: servers: - url: https://studio.twilio.com @@ -962,25 +1121,56 @@ paths: - friendly_name - status - revision - pathType: list dependentProperties: - flow_revision: '{sid: sid}' - flow_test_user: '{sid: sid}' - execution: '{flow_sid: sid}' + revisions: + mapping: + sid: sid + resource_url: /v2/Flows/{sid}/Revisions + test_users: + mapping: + sid: sid + resource_url: /v2/Flows/{sid}/TestUsers + executions: + mapping: + flow_sid: sid + resource_url: /v2/Flows/{flow_sid}/Executions + pathType: list post: description: Create a Flow. + tags: + - StudioV2Flow responses: '201': content: application/json: schema: $ref: '#/components/schemas/studio.v2.flow' + examples: + create: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + definition: + initial_state: Trigger + friendly_name: Test Flow + status: published + revision: 1 + commit_message: null + valid: true + errors: [] + warnings: [] + webhook_url: http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + test_users: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers + revisions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions + executions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions description: Created security: - accountSid_authToken: [] operationId: CreateFlow - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1004,8 +1194,16 @@ paths: - FriendlyName - Status - Definition + examples: + create: + value: + FriendlyName: Test Flow + Status: published + Definition: '{"initial_state": "Trigger"}' get: description: Retrieve a list of all Flows. + tags: + - StudioV2Flow parameters: - name: PageSize in: query @@ -1039,34 +1237,62 @@ paths: items: $ref: '#/components/schemas/studio.v2.flow' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v2/Flows?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v2/Flows?PageSize=50&Page=0 + page_size: 50 + key: flows + flows: + - sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test Flow + status: published + revision: 1 + definition: null + commit_message: null + valid: null + errors: null + warnings: null + webhook_url: http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-11-06T12:00:00Z' + date_updated: '2017-11-06T12:00:00Z' + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + test_users: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers + revisions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions + executions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions description: OK security: - accountSid_authToken: [] operationId: ListFlow - x-maturity: - - GA /v2/Flows/{Sid}: servers: - url: https://studio.twilio.com @@ -1077,13 +1303,24 @@ paths: - friendly_name - status - revision - pathType: instance dependentProperties: - flow_revision: '{sid: sid}' - flow_test_user: '{sid: sid}' - execution: '{flow_sid: sid}' + revisions: + mapping: + sid: sid + resource_url: /v2/Flows/{sid}/Revisions + test_users: + mapping: + sid: sid + resource_url: /v2/Flows/{sid}/TestUsers + executions: + mapping: + flow_sid: sid + resource_url: /v2/Flows/{flow_sid}/Executions + pathType: instance post: description: Update a Flow. + tags: + - StudioV2Flow parameters: - name: Sid in: path @@ -1100,12 +1337,32 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow' + examples: + update: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + definition: + initial_state: Trigger + friendly_name: Test Flow + status: published + revision: 1 + commit_message: null + valid: true + errors: [] + warnings: [] + webhook_url: http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-11-06T12:00:00Z' + date_updated: '2017-11-06T12:00:00Z' + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + test_users: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers + revisions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions + executions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions description: OK security: - accountSid_authToken: [] operationId: UpdateFlow - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1127,8 +1384,16 @@ paths: description: Description of change made in the revision. required: - Status + examples: + update: + value: + FriendlyName: Test Flow + Status: published + Definition: '{"initial_state": "Trigger"}' get: description: Retrieve a specific Flow. + tags: + - StudioV2Flow parameters: - name: Sid in: path @@ -1145,14 +1410,36 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow' + examples: + fetch: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test Flow + definition: + initial_state: Trigger + status: published + revision: 1 + commit_message: commit + valid: true + errors: [] + warnings: [] + webhook_url: http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + test_users: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers + revisions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions + executions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions description: OK security: - accountSid_authToken: [] operationId: FetchFlow - x-maturity: - - GA delete: description: Delete a specific Flow. + tags: + - StudioV2Flow parameters: - name: Sid in: path @@ -1169,8 +1456,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteFlow - x-maturity: - - GA /v2/Flows/{Sid}/Revisions: servers: - url: https://studio.twilio.com @@ -1181,11 +1466,13 @@ paths: - friendly_name - status - revision - pathType: list parent: /Flows/{Sid} className: flow_revision + pathType: list get: description: Retrieve a list of all Flows revisions. + tags: + - StudioV2FlowRevision parameters: - name: Sid in: path @@ -1228,34 +1515,56 @@ paths: items: $ref: '#/components/schemas/studio.v2.flow.flow_revision' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions?PageSize=50&Page=0 + page_size: 50 + key: revisions + revisions: + - sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test Flow + status: published + revision: 1 + definition: null + commit_message: null + valid: null + errors: null + date_created: '2017-11-06T12:00:00Z' + date_updated: '2017-11-06T12:00:00Z' + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions/1 description: OK security: - accountSid_authToken: [] operationId: ListFlowRevision - x-maturity: - - GA /v2/Flows/{Sid}/Revisions/{Revision}: servers: - url: https://studio.twilio.com @@ -1266,11 +1575,13 @@ paths: - friendly_name - status - revision - pathType: instance parent: /Flows/{Sid} className: flow_revision + pathType: instance get: description: Retrieve a specific Flow revision. + tags: + - StudioV2FlowRevision parameters: - name: Sid in: path @@ -1293,12 +1604,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.flow_revision' + examples: + fetch: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + definition: + initial_state: Trigger + friendly_name: Test Flow + status: published + revision: 1 + commit_message: null + valid: true + errors: [] + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions/1 description: OK security: - accountSid_authToken: [] operationId: FetchFlowRevision - x-maturity: - - GA /v2/Flows/Validate: servers: - url: https://studio.twilio.com @@ -1306,22 +1631,26 @@ paths: x-twilio: defaultOutputProperties: - valid - pathType: list mountName: flow_validate + pathType: list post: description: Validate flow JSON definition + tags: + - StudioV2FlowValidate responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v2.flow_validate' + examples: + update: + value: + valid: true description: OK security: - accountSid_authToken: [] operationId: UpdateFlowValidate - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1345,6 +1674,12 @@ paths: - FriendlyName - Status - Definition + examples: + update: + value: + FriendlyName: Test Flow + Status: published + Definition: '{"initial_state": "Trigger"}' /v2/Flows/{Sid}/TestUsers: servers: - url: https://studio.twilio.com @@ -1352,11 +1687,13 @@ paths: x-twilio: defaultOutputProperties: - test_users - pathType: instance parent: /Flows/{Sid} className: flow_test_user + pathType: instance get: description: Fetch flow test users + tags: + - StudioV2FlowTestUser parameters: - name: Sid in: path @@ -1373,14 +1710,22 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.test_user' + examples: + fetch: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + test_users: + - user1 + - user2 + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers description: OK security: - accountSid_authToken: [] operationId: FetchTestUser - x-maturity: - - GA post: description: Update flow test users + tags: + - StudioV2FlowTestUser parameters: - name: Sid in: path @@ -1397,12 +1742,18 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.test_user' + examples: + update: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + test_users: + - user1 + - user2 + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers description: OK security: - accountSid_authToken: [] operationId: UpdateTestUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1418,8 +1769,22 @@ paths: of the flow. required: - TestUsers + examples: + update: + value: + TestUsers: + - user1 + - user2 servers: - url: https://studio.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: StudioV2Execution +- name: StudioV2ExecutionContext +- name: StudioV2ExecutionStep +- name: StudioV2ExecutionStepContext +- name: StudioV2Flow +- name: StudioV2FlowRevision +- name: StudioV2FlowTestUser +- name: StudioV2FlowValidate +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_supersim_v1.yaml b/spec/yaml/twilio_supersim_v1.yaml index 068545ac..98530005 100644 --- a/spec/yaml/twilio_supersim_v1.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: supersim.v1.sim.billing_period: type: object @@ -83,20 +87,25 @@ components: nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [Sim](https://www.twilio.com/docs/wireless/api/sim-resource) + description: The SID of the [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource that this eSIM Profile controls. status: type: string $ref: '#/components/schemas/esim_profile_enum_status' nullable: true - description: 'The status of the eSIM Profile. Can be: `reserving`, `available`, - `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) + description: 'The status of the eSIM Profile. Can be: `new`, `reserving`, + `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile + Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) for a description of each.' eid: type: string @@ -356,6 +365,10 @@ components: \ in binary encoding. For an IP Command sent from a Super SIM, the payload\ \ should not exceed 1300 bytes. If it is larger than 1300 bytes, there\ \ might be fragmentation on the upstream and the message may appear truncated." + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -597,6 +610,10 @@ components: nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM. + x-twilio: + pii: + handling: standard + deleteSla: 30 status: type: string $ref: '#/components/schemas/sim_enum_status' @@ -695,6 +712,10 @@ components: nullable: true description: The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 status: type: string $ref: '#/components/schemas/sms_command_enum_status' @@ -843,10 +864,6 @@ components: type: string enum: - time - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Supersim description: This is the public Twilio REST API. @@ -858,7 +875,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Sims/{SimSid}/BillingPeriods: @@ -872,10 +889,12 @@ paths: - start_time - end_time - period_type - pathType: list parent: /Sims/{Sid} + pathType: list get: description: Retrieve a list of Billing Periods for a Super SIM. + tags: + - SupersimV1BillingPeriod parameters: - name: SimSid in: path @@ -915,34 +934,82 @@ paths: items: $ref: '#/components/schemas/supersim.v1.sim.billing_period' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + billing_periods: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + next_page_url: null + key: billing_periods + readFullActivePeriod: + value: + billing_periods: + - sid: HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + period_type: active + start_time: '2021-06-09T13:18:15Z' + end_time: '2021-07-09T13:18:15Z' + date_created: '2021-06-09T13:18:16Z' + date_updated: '2021-06-09T13:18:16Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + next_page_url: null + key: billing_periods + readFullReadyPeriod: + value: + billing_periods: + - sid: HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + period_type: ready + start_time: '2021-06-09T13:18:15Z' + end_time: '2021-07-09T13:18:15Z' + date_created: '2021-06-09T13:18:16Z' + date_updated: '2021-06-09T13:18:16Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + next_page_url: null + key: billing_periods description: OK security: - accountSid_authToken: [] operationId: ListBillingPeriod - x-maturity: - - GA /v1/ESimProfiles: servers: - url: https://supersim.twilio.com @@ -951,22 +1018,71 @@ paths: defaultOutputProperties: - sid - status - pathType: list mountName: esim_profiles + pathType: list post: description: Order an eSIM Profile. + tags: + - SupersimV1EsimProfile responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.esim_profile' + examples: + createDefaultSmdp: + value: + sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: null + sim_sid: null + status: new + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: null + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createActivationCode: + value: + sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: null + sim_sid: null + status: new + eid: null + smdp_plus_address: null + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithCallback: + value: + sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: null + sim_sid: null + status: reserving + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: null + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateEsimProfile - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1003,27 +1119,50 @@ paths: Eid: type: string description: Identifier of the eUICC that will claim the eSIM Profile. + examples: + createDefaultSmdp: + value: + Eid: 89049032005008882600033489aaaaaa + createActivationCode: + value: + GenerateMatchingId: true + createWithCallback: + value: + Eid: 89049032005008882600033489aaaaaa + CallbackUrl: http://callback.twilio.com + CallbackMethod: POST get: description: Retrieve a list of eSIM Profiles. + tags: + - SupersimV1EsimProfile parameters: - name: Eid in: query description: List the eSIM Profiles that have been associated with an EId. schema: type: string + examples: + readByEid: + value: 89049032005008882600033489aaaaaa - name: SimSid in: query - description: Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/wireless/api/sim-resource) + 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 - name: Status in: query description: List the eSIM Profiles that are in a given status. schema: type: string $ref: '#/components/schemas/esim_profile_enum_status' + examples: + readByStatus: + value: downloaded - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1056,34 +1195,133 @@ paths: items: $ref: '#/components/schemas/supersim.v1.esim_profile' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readAll: + value: + esim_profiles: + - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: available + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://supersim.twilio.com/v1/ESimProfiles?PageSize=50&Page=0 + key: esim_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/ESimProfiles?PageSize=50&Page=0 + readByEid: + value: + esim_profiles: + - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: available + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://supersim.twilio.com/v1/ESimProfiles?Eid=89049032005008882600033489aaaaaa&PageSize=50&Page=0 + key: esim_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/ESimProfiles?Eid=89049032005008882600033489aaaaaa&PageSize=50&Page=0 + readBySimSid: + value: + esim_profiles: + - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: available + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://supersim.twilio.com/v1/ESimProfiles?SimSid=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: esim_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/ESimProfiles?SimSid=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readByStatus: + value: + esim_profiles: + - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: downloaded + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://supersim.twilio.com/v1/ESimProfiles?Status=downloaded&PageSize=50&Page=0 + key: esim_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/ESimProfiles?Status=downloaded&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListEsimProfile - x-maturity: - - Beta /v1/ESimProfiles/{Sid}: servers: - url: https://supersim.twilio.com @@ -1092,10 +1330,12 @@ paths: defaultOutputProperties: - sid - status - pathType: instance mountName: esim_profiles + pathType: instance get: description: Fetch an eSIM Profile. + tags: + - SupersimV1EsimProfile parameters: - name: Sid in: path @@ -1109,12 +1349,43 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.esim_profile' + examples: + fetchDefaultSmdp: + value: + sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: available + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchActivationCode: + value: + sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: available + eid: null + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: AAAAA-BBBBB-CCCCC-DDDDD-EEEEE + activation_code: 1$SM-DP-PLUS.TWILIO.COM$AAAAA-BBBBB-CCCCC-DDDDD-EEEEE + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEsimProfile - x-maturity: - - Beta /v1/Fleets: servers: - url: https://supersim.twilio.com @@ -1128,18 +1399,36 @@ paths: pathType: list post: description: Create a Fleet + tags: + - SupersimV1Fleet responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.fleet' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 500 + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + sms_commands_enabled: true + sms_commands_method: GET + sms_commands_url: https://google.com + ip_commands_method: GET + ip_commands_url: https://google.com + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateFleet - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1214,8 +1503,22 @@ paths: Defaults to `POST`. required: - NetworkAccessProfile + examples: + create: + value: + UniqueName: unique_name + DataEnabled: true + DataLimit: 500 + SmsCommandsEnabled: true + SmsCommandsMethod: GET + SmsCommandsUrl: https://google.com + IpCommandsMethod: GET + IpCommandsUrl: https://google.com + NetworkAccessProfile: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of Fleets from your account. + tags: + - SupersimV1Fleet parameters: - name: NetworkAccessProfile in: query @@ -1223,6 +1526,11 @@ paths: which cellular networks the Fleet's SIMs can connect to. schema: type: string + examples: + readEmpty: + value: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFull: + value: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1255,34 +1563,70 @@ paths: items: $ref: '#/components/schemas/supersim.v1.fleet' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + fleets: [] + meta: + first_page_url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: fleets + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readFull: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: fleets + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + fleets: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: Pilot Fleet + data_enabled: true + data_limit: 1000 + data_metering: payg + date_created: '2019-10-15T20:00:00Z' + date_updated: '2019-10-15T20:00:00Z' + sms_commands_enabled: true + sms_commands_method: POST + sms_commands_url: null + ip_commands_method: POST + ip_commands_url: null + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListFleet - x-maturity: - - Beta /v1/Fleets/{Sid}: servers: - url: https://supersim.twilio.com @@ -1296,6 +1640,8 @@ paths: pathType: instance get: description: Fetch a Fleet instance from your account. + tags: + - SupersimV1Fleet parameters: - name: Sid in: path @@ -1309,15 +1655,33 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.fleet' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + sms_commands_enabled: true + sms_commands_method: POST + sms_commands_url: null + ip_commands_method: POST + ip_commands_url: null + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchFleet - x-maturity: - - Beta post: description: Updates the given properties of a Super SIM Fleet instance from your account. + tags: + - SupersimV1Fleet parameters: - name: Sid in: path @@ -1331,12 +1695,28 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.fleet' + examples: + updateUniqueNameAndDataLimit: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: GPS Trackers Fleet 5GB + data_enabled: true + data_limit: 5000 + data_metering: payg + date_created: '2019-10-15T20:00:00Z' + date_updated: '2019-10-15T20:00:00Z' + sms_commands_enabled: true + sms_commands_method: POST + sms_commands_url: null + ip_commands_method: POST + ip_commands_url: null + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateFleet - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1400,6 +1780,12 @@ paths: in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000). + examples: + updateUniqueNameAndDataLimit: + value: + UniqueName: GPS Trackers Fleet 5GB + NetworkAccessProfile: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DataLimit: 5000 /v1/IpCommands: servers: - url: https://supersim.twilio.com @@ -1412,18 +1798,49 @@ paths: pathType: list post: description: Send an IP Command to a Super SIM. + tags: + - SupersimV1IpCommand responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.ip_command' + examples: + createFull: + value: + sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_iccid: '89883070000123456789' + status: queued + direction: to_sim + device_ip: 100.64.0.123 + device_port: 100 + payload_type: text + payload: 'checkin: firmware update' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createMinimal: + value: + sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_iccid: '89883070000123456789' + status: queued + direction: to_sim + device_ip: 100.64.0.123 + device_port: 100 + payload_type: text + payload: 'checkin: firmware update' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateIpCommand - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1470,8 +1887,24 @@ paths: - Sim - Payload - DevicePort + examples: + createFull: + value: + Sim: sim + Payload: 'checkin: firmware update' + DevicePort: 100 + PayloadType: text + CallbackUrl: http://www.example.com + CallbackMethod: GET + createMinimal: + value: + Sim: sim + Payload: 'checkin: firmware update' + DevicePort: 100 get: description: Retrieve a list of IP Commands from your account. + tags: + - SupersimV1IpCommand parameters: - name: Sim in: query @@ -1479,6 +1912,11 @@ paths: sent to or from. schema: type: string + examples: + readEmpty: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFull: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: SimIccid in: query description: The ICCID of the Sim resource that IP Command was sent to or @@ -1488,11 +1926,16 @@ paths: - name: Status in: query description: 'The status of the IP Command. Can be: `queued`, `sent`, `received` - or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/wireless/api/ipcommand-resource#status-values) + or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/iot/supersim/api/ipcommand-resource#status-values) for a description of each.' schema: type: string $ref: '#/components/schemas/ip_command_enum_status' + examples: + readEmpty: + value: received + readFull: + value: received - name: Direction in: query description: The direction of the IP Command. Can be `to_sim` or `from_sim`. @@ -1533,34 +1976,68 @@ paths: items: $ref: '#/components/schemas/supersim.v1.ip_command' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + ip_commands: [] + meta: + first_page_url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: ip_commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readFull: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: ip_commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + ip_commands: + - sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_iccid: '89883070000123456789' + status: received + direction: from_sim + device_ip: 100.64.0.123 + device_port: 100 + payload_type: text + payload: 'checkin: firmware update' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListIpCommand - x-maturity: - - Beta /v1/IpCommands/{Sid}: servers: - url: https://supersim.twilio.com @@ -1573,6 +2050,8 @@ paths: pathType: instance get: description: Fetch IP Command instance from your account. + tags: + - SupersimV1IpCommand parameters: - name: Sid in: path @@ -1589,12 +2068,26 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.ip_command' + examples: + fetch: + value: + sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_iccid: '89883070000123456789' + status: queued + direction: to_sim + device_ip: 100.64.0.123 + device_port: 100 + payload_type: text + payload: 'checkin: firmware update' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchIpCommand - x-maturity: - - Beta /v1/Networks/{Sid}: servers: - url: https://supersim.twilio.com @@ -1605,6 +2098,8 @@ paths: pathType: instance get: description: Fetch a Network resource. + tags: + - SupersimV1Network parameters: - name: Sid in: path @@ -1621,12 +2116,20 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.network' + examples: + fetch: + value: + friendly_name: AT&T + iso_country: US + identifiers: + - mcc: '310' + mnc: '410' + sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchNetwork - x-maturity: - - Beta /v1/Networks: servers: - url: https://supersim.twilio.com @@ -1637,6 +2140,8 @@ paths: pathType: list get: description: Retrieve a list of Network resources. + tags: + - SupersimV1Network parameters: - name: IsoCountry in: query @@ -1644,18 +2149,27 @@ paths: of the Network resources to read. schema: type: string + examples: + readWithFilters: + value: US - name: Mcc in: query description: The 'mobile country code' of a country. Network resources with this `mcc` in their `identifiers` will be read. schema: type: string + examples: + readWithFilters: + value: '310' - name: Mnc in: query description: The 'mobile network code' of a mobile operator network. Network resources with this `mnc` in their `identifiers` will be read. schema: type: string + examples: + readWithFilters: + value: '410' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1688,60 +2202,119 @@ paths: items: $ref: '#/components/schemas/supersim.v1.network' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Networks?PageSize=50&Page=0 + key: networks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Networks?PageSize=50&Page=0 + networks: + - friendly_name: AT&T + iso_country: US + identifiers: + - mcc: '310' + mnc: '410' + sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readWithFilters: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0 + key: networks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0 + networks: + - friendly_name: AT&T + iso_country: US + identifiers: + - mcc: '310' + mnc: '410' + sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListNetwork - x-maturity: - - Beta /v1/NetworkAccessProfiles: servers: - url: https://supersim.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - fleets_count - pathType: list dependentProperties: - network_access_profile_network: '{network_access_profile_sid: sid}' + networks: + mapping: + network_access_profile_sid: sid + resource_url: /v1/NetworkAccessProfiles/{network_access_profile_sid}/Networks + pathType: list post: description: Create a new Network Access Profile + tags: + - SupersimV1NetworkAccessProfile responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile' + examples: + createMinimal: + value: + unique_name: null + sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-05-01T20:00:00Z' + date_updated: '2020-05-01T20:00:00Z' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks + createWithNameAndNetworks: + value: + unique_name: My Network Access Profile + sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-05-01T20:00:00Z' + date_updated: '2020-05-01T20:00:00Z' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks description: Created security: - accountSid_authToken: [] operationId: CreateNetworkAccessProfile - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1760,8 +2333,19 @@ paths: type: string description: List of Network SIDs that this Network Access Profile will allow connections to. + examples: + createMinimal: + value: {} + createWithNameAndNetworks: + value: + UniqueName: My Network Access Profile + Networks: + - HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab get: description: Retrieve a list of Network Access Profiles from your account. + tags: + - SupersimV1NetworkAccessProfile parameters: - name: PageSize in: query @@ -1795,48 +2379,82 @@ paths: items: $ref: '#/components/schemas/supersim.v1.network_access_profile' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + network_access_profiles: [] + meta: + first_page_url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 + key: network_access_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 + readFull: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 + key: network_access_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 + network_access_profiles: + - unique_name: My Network Access Profile + sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-05-01T20:00:00Z' + date_updated: '2020-05-01T20:00:00Z' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks description: OK security: - accountSid_authToken: [] operationId: ListNetworkAccessProfile - x-maturity: - - Beta /v1/NetworkAccessProfiles/{Sid}: servers: - url: https://supersim.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - fleets_count - pathType: instance dependentProperties: - network_access_profile_network: '{network_access_profile_sid: sid}' + networks: + mapping: + network_access_profile_sid: sid + resource_url: /v1/NetworkAccessProfiles/{network_access_profile_sid}/Networks + pathType: instance get: description: Fetch a Network Access Profile instance from your account. + tags: + - SupersimV1NetworkAccessProfile parameters: - name: Sid in: path @@ -1850,15 +2468,26 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile' + examples: + fetch: + value: + unique_name: My Network Access Profile + sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-05-01T20:00:00Z' + date_updated: '2020-05-01T20:00:00Z' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks description: OK security: - accountSid_authToken: [] operationId: FetchNetworkAccessProfile - x-maturity: - - Beta post: description: Updates the given properties of a Network Access Profile in your account. + tags: + - SupersimV1NetworkAccessProfile parameters: - name: Sid in: path @@ -1872,12 +2501,21 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile' + examples: + updateUniqueName: + value: + unique_name: My Network Access Profile + sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-05-01T20:00:00Z' + date_updated: '2020-05-01T20:00:00Z' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks description: OK security: - accountSid_authToken: [] operationId: UpdateNetworkAccessProfile - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1888,6 +2526,10 @@ paths: UniqueName: type: string description: The new unique name of the Network Access Profile. + examples: + updateUniqueName: + value: + UniqueName: My Network Access Profile /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks: servers: - url: https://supersim.twilio.com @@ -1896,11 +2538,13 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: list parent: /NetworkAccessProfiles/{Sid} className: network_access_profile_network + pathType: list get: description: Retrieve a list of Network Access Profile resource's Network resource. + tags: + - SupersimV1NetworkAccessProfileNetwork parameters: - name: NetworkAccessProfileSid in: path @@ -1941,36 +2585,56 @@ paths: items: $ref: '#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0 + key: networks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0 + networks: + - sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: AT&T + iso_country: us + identifiers: + - mcc: '310' + mnc: '410' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListNetworkAccessProfileNetwork - x-maturity: - - Beta post: description: Add a Network resource to the Network Access Profile resource. + tags: + - SupersimV1NetworkAccessProfileNetwork parameters: - name: NetworkAccessProfileSid in: path @@ -1985,12 +2649,21 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network' + examples: + create: + value: + sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: AT&T + iso_country: us + identifiers: + - mcc: '310' + mnc: '410' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateNetworkAccessProfileNetwork - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2007,6 +2680,10 @@ paths: Network Access Profile resource. required: - Network + examples: + create: + value: + Network: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}: servers: - url: https://supersim.twilio.com @@ -2015,11 +2692,13 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /NetworkAccessProfiles/{Sid} className: network_access_profile_network + pathType: instance delete: description: Remove a Network resource from the Network Access Profile resource's. + tags: + - SupersimV1NetworkAccessProfileNetwork parameters: - name: NetworkAccessProfileSid in: path @@ -2047,10 +2726,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteNetworkAccessProfileNetwork - x-maturity: - - Beta get: description: Fetch a Network Access Profile resource's Network resource. + tags: + - SupersimV1NetworkAccessProfileNetwork parameters: - name: NetworkAccessProfileSid in: path @@ -2074,16 +2753,25 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network' + examples: + fetch: + value: + sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: AT&T + iso_country: us + identifiers: + - mcc: '310' + mnc: '410' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchNetworkAccessProfileNetwork - x-maturity: - - Beta /v1/SettingsUpdates: servers: - url: https://supersim.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2093,12 +2781,19 @@ paths: pathType: list get: description: Retrieve a list of Settings Updates. + tags: + - SupersimV1SettingsUpdate parameters: - name: Sim in: query description: Filter the Settings Updates by a Super SIM's SID or UniqueName. schema: type: string + examples: + readSimOnly: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFull: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: Filter the Settings Updates by status. Can be `scheduled`, `in-progress`, @@ -2106,6 +2801,11 @@ paths: schema: type: string $ref: '#/components/schemas/settings_update_enum_status' + examples: + readStatusOnly: + value: scheduled + readFull: + value: scheduled - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2138,34 +2838,110 @@ paths: items: $ref: '#/components/schemas/supersim.v1.settings_update' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + settings_updates: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0 + next_page_url: null + key: settings_updates + readSimOnly: + value: + settings_updates: + - sid: OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: successful + packages: + - name: base-settings + version: 1.0.0 + more_info: https://twilio.com/docs/iot/supersim/settings-packages/base-settings + date_completed: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: settings_updates + readStatusOnly: + value: + settings_updates: + - sid: OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: scheduled + packages: + - name: base-settings + version: 1.0.0 + more_info: https://twilio.com/docs/iot/supersim/settings-packages/base-settings + date_completed: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0 + next_page_url: null + key: settings_updates + readFull: + value: + settings_updates: + - sid: OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: scheduled + packages: + - name: base-settings + version: 1.0.0 + more_info: https://twilio.com/docs/iot/supersim/settings-packages/base-settings + date_completed: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: settings_updates description: OK security: - accountSid_authToken: [] operationId: ListSettingsUpdate - x-maturity: - - Beta /v1/Sims: servers: - url: https://supersim.twilio.com @@ -2175,24 +2951,45 @@ paths: - sid - unique_name - status - pathType: list dependentProperties: - billing_period: '{sim_sid: sid}' - sim_ip_address: '{sim_sid: sid}' + billing_periods: + mapping: + sim_sid: sid + resource_url: /v1/Sims/{sim_sid}/BillingPeriods + sim_ip_addresses: + mapping: + sim_sid: sid + resource_url: /v1/Sims/{sim_sid}/IpAddresses + pathType: list post: description: Register a Super SIM to your Account + tags: + - SupersimV1Sim responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' + examples: + create: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: '' + status: new + fleet_sid: null + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses description: Created security: - accountSid_authToken: [] operationId: CreateSim - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2211,8 +3008,15 @@ paths: required: - Iccid - RegistrationCode + examples: + create: + value: + Iccid: '89883070000123456789' + RegistrationCode: H3LL0W0RLD get: description: Retrieve a list of Super SIMs from your account. + tags: + - SupersimV1Sim parameters: - name: Status in: query @@ -2221,12 +3025,26 @@ paths: schema: type: string $ref: '#/components/schemas/sim_enum_status' + examples: + readEmpty: + value: new + readFullByFleetSid: + value: new + readFullByFleetName: + value: new - name: Fleet in: query description: The SID or unique name of the Fleet to which a list of Sims are assigned. schema: type: string + examples: + readEmpty: + value: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFullByFleetSid: + value: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFullByFleetName: + value: MyFleet - name: Iccid in: query description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) @@ -2234,6 +3052,13 @@ paths: will always return a list containing zero or one SIMs. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readByIccid: + value: '89883070000123456789' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2266,34 +3091,113 @@ paths: items: $ref: '#/components/schemas/supersim.v1.sim' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sims: [] + meta: + first_page_url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readFullByFleetSid: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + sims: + - sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My SIM + status: new + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses + readFullByFleetName: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=MyFleet&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=MyFleet&PageSize=50&Page=0 + sims: + - sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My SIM + status: new + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses + readByIccid: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Sims?Iccid=89883070000123456789&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims?Iccid=89883070000123456789&PageSize=50&Page=0 + sims: + - sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My SIM + status: new + fleet_sid: null + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses description: OK security: - accountSid_authToken: [] operationId: ListSim - x-maturity: - - Beta /v1/Sims/{Sid}: servers: - url: https://supersim.twilio.com @@ -2303,12 +3207,20 @@ paths: - sid - unique_name - status - pathType: instance dependentProperties: - billing_period: '{sim_sid: sid}' - sim_ip_address: '{sim_sid: sid}' + billing_periods: + mapping: + sim_sid: sid + resource_url: /v1/Sims/{sim_sid}/BillingPeriods + sim_ip_addresses: + mapping: + sim_sid: sid + resource_url: /v1/Sims/{sim_sid}/IpAddresses + pathType: instance get: description: Fetch a Super SIM instance from your account. + tags: + - SupersimV1Sim parameters: - name: Sid in: path @@ -2322,15 +3234,30 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' + examples: + fetch: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My SIM + status: new + fleet_sid: null + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses description: OK security: - accountSid_authToken: [] operationId: FetchSim - x-maturity: - - Beta post: description: Updates the given properties of a Super SIM instance from your account. + tags: + - SupersimV1Sim parameters: - name: Sid in: path @@ -2344,18 +3271,88 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' + examples: + updateUniqueName: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: MySIM + status: new + fleet_sid: null + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses + updateFleetWithSid: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: null + status: new + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses + updateFleetWithUniqueName: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: null + status: new + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses + transferSimToAnotherAccount: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + unique_name: null + status: new + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses description: OK '202': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' + examples: + updateStatus: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: null + status: scheduled + fleet_sid: null + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses description: Accepted security: - accountSid_authToken: [] operationId: UpdateSim - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2401,6 +3398,29 @@ paths: belong. The Account SID can only be that of the requesting Account or that of a Subaccount of the requesting Account. Only valid when the Sim resource's status is new. + examples: + updateUniqueName: + value: + UniqueName: MySIM + updateStatus: + value: + Status: active + CallbackUrl: http://127.0.0.1:9876/path + CallbackMethod: POST + updateFleetWithSid: + value: + Fleet: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + CallbackUrl: http://127.0.0.1:9876/path + CallbackMethod: POST + updateFleetWithUniqueName: + value: + Fleet: My Fleet + CallbackUrl: http://127.0.0.1:9876/path + CallbackMethod: POST + transferSimToAnotherAccount: + value: + AccountSid: ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + Fleet: My Fleet /v1/Sims/{SimSid}/IpAddresses: servers: - url: https://supersim.twilio.com @@ -2409,11 +3429,13 @@ paths: defaultOutputProperties: - ip_address - ip_address_version - pathType: list parent: /Sims/{Sid} mountName: sim_ip_addresses + pathType: list get: description: Retrieve a list of IP Addresses for the given Super SIM. + tags: + - SupersimV1SimIpAddress parameters: - name: SimSid in: path @@ -2453,34 +3475,57 @@ paths: items: $ref: '#/components/schemas/supersim.v1.sim.sim_ip_address' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + key: ip_addresses + first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 + ip_addresses: [] + readNonEmpty: + value: + meta: + key: ip_addresses + first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 + ip_addresses: + - ip_address: 8.8.8.8 + ip_address_version: IPv4 description: OK security: - accountSid_authToken: [] operationId: ListSimIpAddress - x-maturity: - - Beta /v1/SmsCommands: servers: - url: https://supersim.twilio.com @@ -2493,18 +3538,41 @@ paths: pathType: list post: description: Send SMS Command to a Sim. + tags: + - SupersimV1SmsCommand responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.sms_command' + examples: + createCommandMinimal: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + payload: 'checkin: firmware update' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + direction: to_sim + url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createCommandFull: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + payload: 'Report location: (52.520008, 13.404954)' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + direction: to_sim + url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSmsCommand - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2539,8 +3607,21 @@ paths: required: - Sim - Payload + examples: + createCommandMinimal: + value: + Payload: 'checkin: firmware update' + Sim: SimSidOrUniqueName + createCommandFull: + value: + Payload: 'Report location: (52.520008, 13.404954)' + Sim: SimSidOrUniqueName + CallbackMethod: POST + CallbackUrl: http://blahblah.com/go get: description: Retrieve a list of SMS Commands from your account. + tags: + - SupersimV1SmsCommand parameters: - name: Sim in: query @@ -2548,6 +3629,11 @@ paths: sent to or from. schema: type: string + examples: + readEmpty: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFull: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: 'The status of the SMS Command. Can be: `queued`, `sent`, `delivered`, @@ -2556,6 +3642,11 @@ paths: schema: type: string $ref: '#/components/schemas/sms_command_enum_status' + examples: + readEmpty: + value: received + readFull: + value: received - name: Direction in: query description: The direction of the SMS Command. Can be `to_sim` or `from_sim`. @@ -2596,34 +3687,64 @@ paths: items: $ref: '#/components/schemas/supersim.v1.sms_command' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sms_commands: [] + meta: + first_page_url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: sms_commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readFull: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: sms_commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + sms_commands: + - sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + payload: content of the command + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: received + direction: from_sim + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListSmsCommand - x-maturity: - - Beta /v1/SmsCommands/{Sid}: servers: - url: https://supersim.twilio.com @@ -2636,6 +3757,8 @@ paths: pathType: instance get: description: Fetch SMS Command instance from your account. + tags: + - SupersimV1SmsCommand parameters: - name: Sid in: path @@ -2652,12 +3775,22 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.sms_command' + examples: + fetch: + value: + sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + payload: content of the command + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + direction: to_sim + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSmsCommand - x-maturity: - - Beta /v1/UsageRecords: servers: - url: https://supersim.twilio.com @@ -2669,6 +3802,8 @@ paths: pathType: list get: description: List UsageRecords + tags: + - SupersimV1UsageRecord parameters: - name: Sim in: query @@ -2676,6 +3811,9 @@ paths: representing usage incurred by this Super SIM. schema: type: string + examples: + readDaySimFilter: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Fleet in: query description: SID or unique name of a Fleet resource. Only show UsageRecords @@ -2683,6 +3821,9 @@ paths: time the usage occurred. schema: type: string + examples: + readDayFleetFilter: + value: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Network in: query description: SID of a Network resource. Only show UsageRecords representing @@ -2692,6 +3833,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ + examples: + readDayNetworkFilter: + value: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: IsoCountry in: query description: Alpha-2 ISO Country Code. Only show UsageRecords representing @@ -2699,6 +3843,11 @@ paths: schema: type: string format: iso-country-code + examples: + readDayCountryFilter: + value: FR + readDayGroupBySimAndFilterByCountry: + value: FR - name: Group in: query description: 'Dimension over which to aggregate usage records. Can be: `sim`, @@ -2708,6 +3857,17 @@ paths: schema: type: string $ref: '#/components/schemas/usage_record_enum_group' + examples: + readDayGroupBySim: + value: sim + readDayGroupByFleet: + value: fleet + readDayGroupByNetwork: + value: network + readDayGroupByIsoCountry: + value: isoCountry + readDayGroupBySimAndFilterByCountry: + value: sim - name: Granularity in: query description: 'Time-based grouping that UsageRecords should be aggregated by. @@ -2716,6 +3876,19 @@ paths: schema: type: string $ref: '#/components/schemas/usage_record_enum_granularity' + examples: + readAllDay: + value: day + readAllHour: + value: hour + readDaySimFilter: + value: day + readDayNetworkFilter: + value: day + readDayCountryFilter: + value: day + readDayFleetFilter: + value: day - name: StartTime in: query description: Only include usage that occurred at or after this time, specified @@ -2764,39 +3937,503 @@ paths: items: $ref: '#/components/schemas/supersim.v1.usage_record' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readAll: + value: + usage_records: + - period: + start_time: '2015-05-01T20:00:00Z' + end_time: '2015-06-01T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 + readAllDay: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + - period: + start_time: '2019-05-02T00:00:00Z' + end_time: '2019-05-03T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Granularity=day&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Granularity=day&PageSize=50&Page=0 + readAllHour: + value: + usage_records: + - period: + start_time: '2019-05-01T01:00:00Z' + end_time: '2019-05-01T02:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + - period: + start_time: '2019-05-01T00:00:00Z' + end_time: '2019-05-01T01:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Granularity=hour&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Granularity=hour&PageSize=50&Page=0 + readDaySimFilter: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + fleet_sid: null + network_sid: null + iso_country: null + - period: + start_time: '2019-05-02T00:00:00Z' + end_time: '2019-05-03T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + readDayNetworkFilter: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iso_country: null + - period: + start_time: '2019-05-02T00:00:00Z' + end_time: '2019-05-03T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Network=HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Network=HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + readDayCountryFilter: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: FR + - period: + start_time: '2019-05-02T00:00:00Z' + end_time: '2019-05-03T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: FR + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Granularity=day&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Granularity=day&PageSize=50&Page=0 + readDayFleetFilter: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_sid: null + iso_country: null + - period: + start_time: '2019-05-02T00:00:00Z' + end_time: '2019-05-03T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + readDayGroupBySim: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: null + network_sid: null + iso_country: null + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: HSbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=sim&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Group=sim&PageSize=50&Page=0 + readDayGroupByFleet: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_sid: null + iso_country: null + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: HFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=fleet&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Group=fleet&PageSize=50&Page=0 + readDayGroupByNetwork: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iso_country: null + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: HWbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=network&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Group=network&PageSize=50&Page=0 + readDayGroupByIsoCountry: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: FR + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: US + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=isoCountry&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Group=isoCountry&PageSize=50&Page=0 + readDayGroupBySimAndFilterByCountry: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: null + network_sid: null + iso_country: FR + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: HSbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + fleet_sid: null + network_sid: null + iso_country: FR + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Group=sim&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Group=sim&PageSize=50&Page=0 + readAllNoBilling: + value: + usage_records: + - period: + start_time: '2015-05-01T20:00:00Z' + end_time: '2015-06-01T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 1000 + data_download: 1000 + data_total: 2000 + data_total_billed: '0' + billed_unit: null + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListUsageRecord - x-maturity: - - Beta servers: - url: https://supersim.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: SupersimV1BillingPeriod +- name: SupersimV1EsimProfile +- name: SupersimV1Fleet +- name: SupersimV1IpCommand +- name: SupersimV1Network +- name: SupersimV1NetworkAccessProfile +- name: SupersimV1NetworkAccessProfileNetwork +- name: SupersimV1Ota +- name: SupersimV1SettingsUpdate +- name: SupersimV1Sim +- name: SupersimV1SimIpAddress +- name: SupersimV1SmsCommand +- name: SupersimV1UsageRecord +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_sync_v1.yaml b/spec/yaml/twilio_sync_v1.yaml index bb704224..b8820a14 100644 --- a/spec/yaml/twilio_sync_v1.yaml +++ b/spec/yaml/twilio_sync_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: sync.v1.service.document: type: object @@ -17,6 +21,10 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -53,6 +61,10 @@ components: nullable: true description: An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length. + x-twilio: + pii: + handling: sensitive + deleteSla: 7 date_expires: type: string format: date-time @@ -80,6 +92,10 @@ components: is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sync.v1.service.document.document_permission: type: object properties: @@ -112,6 +128,10 @@ components: nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. + x-twilio: + pii: + handling: standard + deleteSla: 30 read: type: boolean nullable: true @@ -158,6 +178,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 7 date_created: type: string format: date-time @@ -233,6 +257,10 @@ components: nullable: true description: An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length. + x-twilio: + pii: + handling: sensitive + deleteSla: 0 sync.v1.service.sync_list: type: object properties: @@ -250,6 +278,10 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -306,6 +338,10 @@ components: description: The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync List was created from the REST API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sync.v1.service.sync_list.sync_list_item: type: object properties: @@ -350,6 +386,10 @@ components: nullable: true description: An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length. + x-twilio: + pii: + handling: sensitive + deleteSla: 7 date_expires: type: string format: date-time @@ -376,6 +416,10 @@ components: description: The identity of the List Item's creator. If the item is created from the client SDK, the value matches the Access Token's `identity` field. If the item was created from the REST API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sync_list_item_enum_query_result_order: type: string enum: @@ -417,6 +461,10 @@ components: nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. + x-twilio: + pii: + handling: standard + deleteSla: 30 read: type: boolean nullable: true @@ -452,6 +500,10 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -508,6 +560,10 @@ components: description: The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Map was created from the REST API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sync.v1.service.sync_map.sync_map_item: type: object properties: @@ -515,6 +571,10 @@ components: type: string nullable: true description: The unique, user-defined key for the Map Item. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -551,6 +611,10 @@ components: nullable: true description: An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length. + x-twilio: + pii: + handling: sensitive + deleteSla: 7 date_expires: type: string format: date-time @@ -577,6 +641,10 @@ components: description: The identity of the Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sync_map_item_enum_query_result_order: type: string enum: @@ -618,6 +686,10 @@ components: nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. + x-twilio: + pii: + handling: standard + deleteSla: 30 read: type: boolean nullable: true @@ -653,6 +725,10 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -705,10 +781,10 @@ components: description: The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic + x-twilio: + pii: + handling: standard + deleteSla: 30 info: title: Twilio - Sync description: This is the public Twilio REST API. @@ -720,7 +796,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Documents/{Sid}: @@ -732,12 +808,18 @@ paths: - sid - unique_name - revision - pathType: instance dependentProperties: - document_permission: '{service_sid: service_sid, document_sid: sid}' + document_permissions: + mapping: + service_sid: service_sid + document_sid: sid + resource_url: /v1/Services/{service_sid}/Documents/{document_sid}/Permissions parent: /Services/{Sid} + pathType: instance get: description: '' + tags: + - SyncV1Document parameters: - name: ServiceSid in: path @@ -759,14 +841,30 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions description: OK security: - accountSid_authToken: [] operationId: FetchDocument - x-maturity: - - GA delete: description: '' + tags: + - SyncV1Document parameters: - name: ServiceSid in: path @@ -788,10 +886,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDocument - x-maturity: - - GA post: description: '' + tags: + - SyncV1Document parameters: - name: ServiceSid in: path @@ -818,12 +916,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions description: OK security: - accountSid_authToken: [] operationId: UpdateDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -838,6 +950,12 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live). + examples: + update: + value: + Data: '{}' + UniqueName: unique_name + Ttl: 3600 /v1/Services/{ServiceSid}/Documents: servers: - url: https://sync.twilio.com @@ -847,12 +965,18 @@ paths: - sid - unique_name - revision - pathType: list dependentProperties: - document_permission: '{service_sid: service_sid, document_sid: sid}' + document_permissions: + mapping: + service_sid: service_sid + document_sid: sid + resource_url: /v1/Services/{service_sid}/Documents/{document_sid}/Permissions parent: /Services/{Sid} + pathType: list post: description: '' + tags: + - SyncV1Document parameters: - name: ServiceSid in: path @@ -867,12 +991,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions description: Created security: - accountSid_authToken: [] operationId: CreateDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -892,8 +1030,16 @@ paths: description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (the Sync Document's time-to-live). + examples: + create: + value: + Data: '{}' + UniqueName: unique_name + Ttl: 3600 get: description: '' + tags: + - SyncV1Document parameters: - name: ServiceSid in: path @@ -934,34 +1080,68 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.document' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + documents: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + readFull: + value: + documents: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDocument - x-maturity: - - GA /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: servers: - url: https://sync.twilio.com @@ -972,11 +1152,13 @@ paths: - read - write - manage - pathType: instance parent: /Services/{ServiceSid}/Documents/{Sid} mountName: document_permissions + pathType: instance get: description: Fetch a specific Sync Document Permission. + tags: + - SyncV1DocumentPermission parameters: - name: ServiceSid in: path @@ -998,6 +1180,10 @@ paths: Document Permission resource to fetch. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -1005,14 +1191,25 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document.document_permission' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: FetchDocumentPermission - x-maturity: - - GA delete: description: Delete a specific Sync Document Permission. + tags: + - SyncV1DocumentPermission parameters: - name: ServiceSid in: path @@ -1034,6 +1231,10 @@ paths: Document Permission resource to delete. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '204': @@ -1041,10 +1242,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDocumentPermission - x-maturity: - - GA post: description: Update an identity's access to a specific Sync Document. + tags: + - SyncV1DocumentPermission parameters: - name: ServiceSid in: path @@ -1066,6 +1267,10 @@ paths: Document Permission resource to update. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -1073,12 +1278,21 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document.document_permission' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: UpdateDocumentPermission - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1102,6 +1316,12 @@ paths: - Read - Write - Manage + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: servers: - url: https://sync.twilio.com @@ -1112,11 +1332,13 @@ paths: - read - write - manage - pathType: list parent: /Services/{ServiceSid}/Documents/{Sid} mountName: document_permissions + pathType: list get: description: Retrieve a list of all Permissions applying to a Sync Document. + tags: + - SyncV1DocumentPermission parameters: - name: ServiceSid in: path @@ -1164,34 +1386,63 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.document.document_permission' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + permissions: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + readFull: + value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDocumentPermission - x-maturity: - - GA /v1/Services/{Sid}: servers: - url: https://sync.twilio.com @@ -1201,14 +1452,28 @@ paths: - sid - unique_name - friendly_name - pathType: instance dependentProperties: - document: '{service_sid: sid}' - sync_list: '{service_sid: sid}' - sync_map: '{service_sid: sid}' - sync_stream: '{service_sid: sid}' + documents: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Documents + sync_lists: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Lists + sync_maps: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Maps + sync_streams: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Streams + pathType: instance get: description: '' + tags: + - SyncV1Service parameters: - name: Sid in: path @@ -1222,14 +1487,35 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + streams: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + webhooks_from_rest_enabled: false + reachability_webhooks_enabled: false + acl_enabled: false + reachability_debouncing_enabled: false + reachability_debouncing_window: 5000 description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: '' + tags: + - SyncV1Service parameters: - name: Sid in: path @@ -1243,10 +1529,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: '' + tags: + - SyncV1Service parameters: - name: Sid in: path @@ -1260,12 +1546,31 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + streams: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + webhooks_from_rest_enabled: false + reachability_webhooks_enabled: false + acl_enabled: true + reachability_debouncing_enabled: false + reachability_debouncing_window: 5000 description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1310,6 +1615,12 @@ paths: description: Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`. + examples: + update: + value: + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true /v1/Services: servers: - url: https://sync.twilio.com @@ -1319,26 +1630,59 @@ paths: - sid - unique_name - friendly_name - pathType: list dependentProperties: - document: '{service_sid: sid}' - sync_list: '{service_sid: sid}' - sync_map: '{service_sid: sid}' - sync_stream: '{service_sid: sid}' + documents: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Documents + sync_lists: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Lists + sync_maps: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Maps + sync_streams: + mapping: + service_sid: sid + resource_url: /v1/Services/{service_sid}/Streams + pathType: list post: description: '' + tags: + - SyncV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + streams: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + webhooks_from_rest_enabled: false + reachability_webhooks_enabled: false + acl_enabled: true + reachability_debouncing_enabled: false + reachability_debouncing_window: 5000 description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1383,8 +1727,17 @@ paths: description: Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`. + examples: + create: + value: + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true + ReachabilityDebouncingWindow: 5000 get: description: '' + tags: + - SyncV1Service parameters: - name: PageSize in: query @@ -1418,46 +1771,87 @@ paths: items: $ref: '#/components/schemas/sync.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://sync.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://sync.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + streams: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + webhooks_from_rest_enabled: false + reachability_webhooks_enabled: false + acl_enabled: false + reachability_debouncing_enabled: false + reachability_debouncing_window: 5000 description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages: servers: - url: https://sync.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /Services/{ServiceSid}/Streams/{Sid} mountName: stream_messages + pathType: list post: description: Create a new Stream Message. + tags: + - SyncV1StreamMessage parameters: - name: ServiceSid in: path @@ -1479,12 +1873,15 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream.stream_message' + examples: + create: + value: + sid: TZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: {} description: Created security: - accountSid_authToken: [] operationId: CreateStreamMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1498,6 +1895,10 @@ paths: in length. required: - Data + examples: + create: + value: + Data: '{}' /v1/Services/{ServiceSid}/Lists/{Sid}: servers: - url: https://sync.twilio.com @@ -1507,14 +1908,24 @@ paths: - sid - unique_name - revision - pathType: instance dependentProperties: - sync_list_item: '{service_sid: service_sid, list_sid: sid}' - sync_list_permission: '{service_sid: service_sid, list_sid: sid}' + sync_list_items: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /v1/Services/{service_sid}/Lists/{list_sid}/Items + sync_list_permissions: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /v1/Services/{service_sid}/Lists/{list_sid}/Permissions parent: /Services/{Sid} mountName: sync_lists + pathType: instance get: description: '' + tags: + - SyncV1SyncList parameters: - name: ServiceSid in: path @@ -1536,14 +1947,30 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSyncList - x-maturity: - - GA delete: description: '' + tags: + - SyncV1SyncList parameters: - name: ServiceSid in: path @@ -1565,10 +1992,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncList - x-maturity: - - GA post: description: '' + tags: + - SyncV1SyncList parameters: - name: ServiceSid in: path @@ -1590,12 +2017,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSyncList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1611,6 +2052,10 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted. + examples: + update: + value: + Ttl: 3600 /v1/Services/{ServiceSid}/Lists: servers: - url: https://sync.twilio.com @@ -1620,14 +2065,24 @@ paths: - sid - unique_name - revision - pathType: list dependentProperties: - sync_list_item: '{service_sid: service_sid, list_sid: sid}' - sync_list_permission: '{service_sid: service_sid, list_sid: sid}' + sync_list_items: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /v1/Services/{service_sid}/Lists/{list_sid}/Items + sync_list_permissions: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /v1/Services/{service_sid}/Lists/{list_sid}/Permissions parent: /Services/{Sid} mountName: sync_lists + pathType: list post: description: '' + tags: + - SyncV1SyncList parameters: - name: ServiceSid in: path @@ -1642,12 +2097,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSyncList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1670,8 +2139,15 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted. + examples: + create: + value: + UniqueName: unique_name + Ttl: 3600 get: description: '' + tags: + - SyncV1SyncList parameters: - name: ServiceSid in: path @@ -1712,34 +2188,68 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_list' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + lists: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + readFull: + value: + lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncList - x-maturity: - - GA /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: servers: - url: https://sync.twilio.com @@ -1749,11 +2259,13 @@ paths: - index - revision - created_by - pathType: instance parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_items + pathType: instance get: description: '' + tags: + - SyncV1SyncListItem parameters: - name: ServiceSid in: path @@ -1781,14 +2293,28 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 description: OK security: - accountSid_authToken: [] operationId: FetchSyncListItem - x-maturity: - - GA delete: description: '' + tags: + - SyncV1SyncListItem parameters: - name: ServiceSid in: path @@ -1824,10 +2350,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncListItem - x-maturity: - - GA post: description: '' + tags: + - SyncV1SyncListItem parameters: - name: ServiceSid in: path @@ -1863,12 +2389,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 description: OK security: - accountSid_authToken: [] operationId: UpdateSyncListItem - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1893,6 +2431,11 @@ paths: before the List Item's parent Sync List expires (time-to-live) and is deleted. This parameter can only be used when the List Item's `data` or `ttl` is updated in the same request. + examples: + update: + value: + Data: '{}' + Ttl: 3600 /v1/Services/{ServiceSid}/Lists/{ListSid}/Items: servers: - url: https://sync.twilio.com @@ -1902,11 +2445,13 @@ paths: - index - revision - created_by - pathType: list parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_items + pathType: list post: description: '' + tags: + - SyncV1SyncListItem parameters: - name: ServiceSid in: path @@ -1928,12 +2473,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 description: Created security: - accountSid_authToken: [] operationId: CreateSyncListItem - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1959,8 +2516,15 @@ paths: and is deleted. required: - Data + examples: + create: + value: + Data: '{}' + Ttl: 3600 get: description: '' + tags: + - SyncV1SyncListItem parameters: - name: ServiceSid in: path @@ -1983,12 +2547,22 @@ paths: schema: type: string $ref: '#/components/schemas/sync_list_item_enum_query_result_order' + examples: + readEmpty: + value: asc + readFull: + value: asc - name: From in: query description: The `index` of the first Sync List Item resource to read. See also `bounds`. schema: type: string + examples: + readEmpty: + value: from + readFull: + value: from - name: Bounds in: query description: 'Whether to include the List Item referenced by the `from` parameter. @@ -1997,6 +2571,11 @@ paths: schema: type: string $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' + examples: + readEmpty: + value: inclusive + readFull: + value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2029,34 +2608,66 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + items: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + readFull: + value: + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncListItem - x-maturity: - - GA /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: servers: - url: https://sync.twilio.com @@ -2067,11 +2678,13 @@ paths: - read - write - manage - pathType: instance parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_permissions + pathType: instance get: description: Fetch a specific Sync List Permission. + tags: + - SyncV1SyncListPermission parameters: - name: ServiceSid in: path @@ -2093,6 +2706,10 @@ paths: Sync List Permission resource to fetch. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -2100,14 +2717,25 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_permission' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: FetchSyncListPermission - x-maturity: - - GA delete: description: Delete a specific Sync List Permission. + tags: + - SyncV1SyncListPermission parameters: - name: ServiceSid in: path @@ -2129,6 +2757,10 @@ paths: Sync List Permission resource to delete. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '204': @@ -2136,10 +2768,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncListPermission - x-maturity: - - GA post: description: Update an identity's access to a specific Sync List. + tags: + - SyncV1SyncListPermission parameters: - name: ServiceSid in: path @@ -2161,6 +2793,10 @@ paths: Sync List Permission resource to update. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -2168,12 +2804,21 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_permission' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: UpdateSyncListPermission - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2197,6 +2842,12 @@ paths: - Read - Write - Manage + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions: servers: - url: https://sync.twilio.com @@ -2207,11 +2858,13 @@ paths: - read - write - manage - pathType: list parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_permissions + pathType: list get: description: Retrieve a list of all Permissions applying to a Sync List. + tags: + - SyncV1SyncListPermission parameters: - name: ServiceSid in: path @@ -2259,34 +2912,63 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_permission' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + permissions: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + readFull: + value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncListPermission - x-maturity: - - GA /v1/Services/{ServiceSid}/Maps/{Sid}: servers: - url: https://sync.twilio.com @@ -2296,14 +2978,24 @@ paths: - sid - unique_name - revision - pathType: instance dependentProperties: - sync_map_item: '{service_sid: service_sid, map_sid: sid}' - sync_map_permission: '{service_sid: service_sid, map_sid: sid}' + sync_map_items: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /v1/Services/{service_sid}/Maps/{map_sid}/Items + sync_map_permissions: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /v1/Services/{service_sid}/Maps/{map_sid}/Permissions parent: /Services/{Sid} mountName: sync_maps + pathType: instance get: description: '' + tags: + - SyncV1SyncMap parameters: - name: ServiceSid in: path @@ -2325,14 +3017,30 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSyncMap - x-maturity: - - GA delete: description: '' + tags: + - SyncV1SyncMap parameters: - name: ServiceSid in: path @@ -2354,10 +3062,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncMap - x-maturity: - - GA post: description: '' + tags: + - SyncV1SyncMap parameters: - name: ServiceSid in: path @@ -2379,12 +3087,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSyncMap - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2400,6 +3122,10 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted. + examples: + update: + value: + Ttl: 3600 /v1/Services/{ServiceSid}/Maps: servers: - url: https://sync.twilio.com @@ -2409,14 +3135,24 @@ paths: - sid - unique_name - revision - pathType: list dependentProperties: - sync_map_item: '{service_sid: service_sid, map_sid: sid}' - sync_map_permission: '{service_sid: service_sid, map_sid: sid}' + sync_map_items: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /v1/Services/{service_sid}/Maps/{map_sid}/Items + sync_map_permissions: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /v1/Services/{service_sid}/Maps/{map_sid}/Permissions parent: /Services/{Sid} mountName: sync_maps + pathType: list post: description: '' + tags: + - SyncV1SyncMap parameters: - name: ServiceSid in: path @@ -2431,12 +3167,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSyncMap - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2457,8 +3207,15 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted. + examples: + create: + value: + UniqueName: unique_name + Ttl: 3600 get: description: '' + tags: + - SyncV1SyncMap parameters: - name: ServiceSid in: path @@ -2499,34 +3256,68 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_map' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + maps: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + readFull: + value: + maps: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncMap - x-maturity: - - GA /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: servers: - url: https://sync.twilio.com @@ -2536,11 +3327,13 @@ paths: - key - revision - created_by - pathType: instance parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_items + pathType: instance get: description: '' + tags: + - SyncV1SyncMapItem parameters: - name: ServiceSid in: path @@ -2561,6 +3354,10 @@ paths: description: The `key` value of the Sync Map Item resource to fetch. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -2568,14 +3365,28 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: OK security: - accountSid_authToken: [] operationId: FetchSyncMapItem - x-maturity: - - GA delete: description: '' + tags: + - SyncV1SyncMapItem parameters: - name: ServiceSid in: path @@ -2596,6 +3407,10 @@ paths: description: The `key` value of the Sync Map Item resource to delete. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: If-Match in: header @@ -2611,10 +3426,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncMapItem - x-maturity: - - GA post: description: '' + tags: + - SyncV1SyncMapItem parameters: - name: ServiceSid in: path @@ -2635,6 +3450,10 @@ paths: description: 'The `key` value of the Sync Map Item resource to update. ' schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: If-Match in: header @@ -2650,12 +3469,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: OK security: - accountSid_authToken: [] operationId: UpdateSyncMapItem - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2680,6 +3511,11 @@ paths: before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request. + examples: + update: + value: + Data: '{}' + Ttl: 3600 /v1/Services/{ServiceSid}/Maps/{MapSid}/Items: servers: - url: https://sync.twilio.com @@ -2689,11 +3525,13 @@ paths: - key - revision - created_by - pathType: list parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_items + pathType: list post: description: '' + tags: + - SyncV1SyncMapItem parameters: - name: ServiceSid in: path @@ -2715,12 +3553,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: Created security: - accountSid_authToken: [] operationId: CreateSyncMapItem - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2751,8 +3601,16 @@ paths: required: - Key - Data + examples: + create: + value: + Data: '{}' + Key: key + Ttl: 3600 get: description: '' + tags: + - SyncV1SyncMapItem parameters: - name: ServiceSid in: path @@ -2777,12 +3635,22 @@ paths: schema: type: string $ref: '#/components/schemas/sync_map_item_enum_query_result_order' + examples: + readEmpty: + value: asc + readFull: + value: asc - name: From in: query description: The `key` of the first Sync Map Item resource to read. See also `bounds`. schema: type: string + examples: + readEmpty: + value: from + readFull: + value: from - name: Bounds in: query description: 'Whether to include the Map Item referenced by the `from` parameter. @@ -2791,6 +3659,11 @@ paths: schema: type: string $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' + examples: + readEmpty: + value: inclusive + readFull: + value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2823,49 +3696,83 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + items: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + readFull: + value: + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncMapItem - x-maturity: - - GA /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: servers: - url: https://sync.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - identity - read - write - manage - pathType: instance parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_permissions + pathType: instance get: description: Fetch a specific Sync Map Permission. + tags: + - SyncV1SyncMapPermission parameters: - name: ServiceSid in: path @@ -2888,6 +3795,10 @@ paths: Sync Map Permission resource to fetch. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -2895,14 +3806,25 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_permission' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: FetchSyncMapPermission - x-maturity: - - GA delete: description: Delete a specific Sync Map Permission. + tags: + - SyncV1SyncMapPermission parameters: - name: ServiceSid in: path @@ -2925,6 +3847,10 @@ paths: Sync Map Permission resource to delete. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '204': @@ -2932,10 +3858,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncMapPermission - x-maturity: - - GA post: description: Update an identity's access to a specific Sync Map. + tags: + - SyncV1SyncMapPermission parameters: - name: ServiceSid in: path @@ -2958,6 +3884,10 @@ paths: Sync Map Permission resource to update. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -2965,12 +3895,21 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_permission' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: UpdateSyncMapPermission - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2994,21 +3933,29 @@ paths: - Read - Write - Manage + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions: servers: - url: https://sync.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - identity - read - write - manage - pathType: list parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_permissions + pathType: list get: description: Retrieve a list of all Permissions applying to a Sync Map. + tags: + - SyncV1SyncMapPermission parameters: - name: ServiceSid in: path @@ -3057,50 +4004,85 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_permission' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + permissions: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + readFull: + value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncMapPermission - x-maturity: - - GA /v1/Services/{ServiceSid}/Streams/{Sid}: servers: - url: https://sync.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - created_by - pathType: instance dependentProperties: - stream_message: '{service_sid: service_sid, stream_sid: sid}' + stream_messages: + mapping: + service_sid: service_sid + stream_sid: sid + resource_url: /v1/Services/{service_sid}/Streams/{stream_sid}/Messages parent: /Services/{Sid} mountName: sync_streams + pathType: instance get: description: Fetch a specific Stream. + tags: + - SyncV1SyncStream parameters: - name: ServiceSid in: path @@ -3121,14 +4103,28 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + messages: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSyncStream - x-maturity: - - GA delete: description: Delete a specific Stream. + tags: + - SyncV1SyncStream parameters: - name: ServiceSid in: path @@ -3149,10 +4145,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncStream - x-maturity: - - GA post: description: Update a specific Stream. + tags: + - SyncV1SyncStream parameters: - name: ServiceSid in: path @@ -3173,12 +4169,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + messages: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSyncStream - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3190,22 +4198,32 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live). + examples: + update: + value: + Ttl: 3600 /v1/Services/{ServiceSid}/Streams: servers: - url: https://sync.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - created_by - pathType: list dependentProperties: - stream_message: '{service_sid: service_sid, stream_sid: sid}' + stream_messages: + mapping: + service_sid: service_sid + stream_sid: sid + resource_url: /v1/Services/{service_sid}/Streams/{stream_sid}/Messages parent: /Services/{Sid} mountName: sync_streams + pathType: list post: description: Create a new Stream. + tags: + - SyncV1SyncStream parameters: - name: ServiceSid in: path @@ -3220,12 +4238,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + messages: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSyncStream - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3244,8 +4274,15 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live). + examples: + create: + value: + UniqueName: unique_name + Ttl: 3600 get: description: Retrieve a list of all Streams in a Service Instance. + tags: + - SyncV1SyncStream parameters: - name: ServiceSid in: path @@ -3286,36 +4323,79 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_stream' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + streams: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0 + key: streams + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0 + readFull: + value: + streams: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + messages: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0 + key: streams + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncStream - x-maturity: - - GA servers: - url: https://sync.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: SyncV1Document +- name: SyncV1DocumentPermission +- name: SyncV1Service +- name: SyncV1StreamMessage +- name: SyncV1SyncList +- name: SyncV1SyncListItem +- name: SyncV1SyncListPermission +- name: SyncV1SyncMap +- name: SyncV1SyncMapItem +- name: SyncV1SyncMapPermission +- name: SyncV1SyncStream +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_taskrouter_v1.yaml b/spec/yaml/twilio_taskrouter_v1.yaml index ccf54947..b2657aa2 100644 --- a/spec/yaml/twilio_taskrouter_v1.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: taskrouter.v1.workspace.activity: type: object @@ -180,11 +184,15 @@ components: If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 addons: type: string nullable: true - description: An object that contains the [addon](https://www.twilio.com/docs/taskrouter/marketplace) - data for all installed addons. + description: An object that contains the [Add-on](https://www.twilio.com/docs/add-ons) + data for all installed Add-ons. date_created: type: string format: date-time @@ -275,6 +283,13 @@ components: format: uri-map nullable: true description: The URLs of related resources. + virtual_start_time: + type: string + format: date-time + nullable: true + description: The date and time in GMT indicating the ordering for routing + of the Task specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. task_enum_status: type: string enum: @@ -386,6 +401,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 max_reserved_workers: type: integer nullable: true @@ -452,6 +471,71 @@ components: enum: - FIFO - LIFO + taskrouter.v1.workspace.task_queue.task_queue_bulk_real_time_statistics: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the TaskQueue resource. + workspace_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WS[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Workspace that contains the TaskQueue. + task_queue_data: + type: array + items: {} + nullable: true + description: 'The real-time statistics for each requested TaskQueue SID. + `task_queue_data` returns the following attributes: + + + `task_queue_sid`: The SID of the TaskQueue from which these statistics + were calculated. + + + `total_available_workers`: The total number of Workers available for Tasks + in the TaskQueue. + + + `total_eligible_workers`: The total number of Workers eligible for Tasks + in the TaskQueue, regardless of their Activity state. + + + `total_tasks`: The total number of Tasks. + + + `longest_task_waiting_age`: The age of the longest waiting Task. + + + `longest_task_waiting_sid`: The SID of the longest waiting Task. + + + `tasks_by_status`: The number of Tasks grouped by their current status. + + + `tasks_by_priority`: The number of Tasks grouped by priority. + + + `activity_statistics`: The number of current Workers grouped by Activity. + + ' + task_queue_response_count: + type: integer + nullable: true + description: The number of TaskQueue statistics received in task_queue_data. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the TaskQueue statistics resource. taskrouter.v1.workspace.task_queue.task_queue_cumulative_statistics: type: object properties: @@ -853,6 +937,10 @@ components: actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker.' + x-twilio: + pii: + handling: sensitive + deleteSla: 30 available: type: boolean nullable: true @@ -881,6 +969,10 @@ components: nullable: true description: The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace. + x-twilio: + pii: + handling: standard + deleteSla: 30 sid: type: string minLength: 34 @@ -1299,6 +1391,10 @@ components: nullable: true description: The string that you assigned to describe the Workflow resource. For example, `Customer Support` or `2014 Election Campaign`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sid: type: string minLength: 34 @@ -1588,6 +1684,10 @@ components: nullable: true description: The string that you assigned to describe the Workspace resource. For example `Customer Support` or `2014 Election Campaign`. + x-twilio: + pii: + handling: standard + deleteSla: 30 multi_task_enabled: type: boolean nullable: true @@ -1826,10 +1926,6 @@ components: format: uri nullable: true description: The absolute URL of the Workspace statistics resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Taskrouter description: This is the public Twilio REST API. @@ -1841,22 +1937,24 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Workspaces/{WorkspaceSid}/Activities/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance parent: /Workspaces/{Sid} + pathType: instance get: description: '' + tags: + - TaskrouterV1Activity parameters: - name: WorkspaceSid in: path @@ -1882,14 +1980,27 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.activity' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available: true + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + friendly_name: New Activity + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchActivity - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Activity parameters: - name: WorkspaceSid in: path @@ -1915,12 +2026,23 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.activity' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available: true + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + friendly_name: New Activity + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateActivity - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1935,8 +2057,14 @@ paths: are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`.' + examples: + update: + value: + FriendlyName: friendly_name delete: description: '' + tags: + - TaskrouterV1Activity parameters: - name: WorkspaceSid in: path @@ -1962,21 +2090,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteActivity - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Activities: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list parent: /Workspaces/{Sid} + pathType: list get: description: '' + tags: + - TaskrouterV1Activity parameters: - name: WorkspaceSid in: path @@ -1992,6 +2120,11 @@ paths: description: The `friendly_name` of the Activity resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: Available in: query description: Whether return only Activity resources that are available or @@ -2000,6 +2133,11 @@ paths: and return activities that are unavailable. schema: type: string + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2032,36 +2170,69 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.activity' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + activities: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available: true + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + friendly_name: New Activity + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0 + key: activities + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0 + readEmpty: + value: + activities: [] + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0 + key: activities + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListActivity - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Activity parameters: - name: WorkspaceSid in: path @@ -2078,12 +2249,23 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.activity' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available: true + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + friendly_name: New Activity + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateActivity - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2107,19 +2289,26 @@ paths: is created. required: - FriendlyName + examples: + create: + value: + Available: 'true' + FriendlyName: friendly_name /v1/Workspaces/{WorkspaceSid}/Events/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - description - event_date - pathType: instance parent: /Workspaces/{Sid} + pathType: instance get: description: '' + tags: + - TaskrouterV1Event parameters: - name: WorkspaceSid in: path @@ -2145,25 +2334,54 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.event' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_type: workspace + actor_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Worker JustinWorker updated to Idle Activity + event_data: + worker_activity_name: Offline + worker_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_attributes: '{}' + worker_name: JustinWorker + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_time_in_previous_activity: '26' + worker_time_in_previous_activity_ms: '26123' + workspace_name: WorkspaceName + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_date: '2015-02-07T00:32:41Z' + event_date_ms: 987654321111 + event_type: worker.activity + resource_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_type: worker + resource_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: twilio + source_ip_address: 1.2.3.4 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEvent - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Events: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - description - event_date - pathType: list parent: /Workspaces/{Sid} + pathType: list get: description: '' + tags: + - TaskrouterV1Event parameters: - name: WorkspaceSid in: path @@ -2182,11 +2400,21 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-03T00:00:00Z' + readEmpty: + value: '2008-01-03T00:00:00Z' - name: EventType in: query description: The type of Events to read. Returns only Events of the type specified. schema: type: string + examples: + readFull: + value: reservation.created + readEmpty: + value: reservation.created - name: Minutes in: query description: The period of events to read in minutes. Returns only Events @@ -2203,6 +2431,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WR[0-9a-fA-F]{32}$ + examples: + readFull: + value: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: StartDate in: query description: Only include Events from on or after this date and time, specified @@ -2211,6 +2444,11 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02T00:00:00Z' + readEmpty: + value: '2008-01-02T00:00:00Z' - name: TaskQueueSid in: query description: The SID of the TaskQueue with the Events to read. Returns only @@ -2220,6 +2458,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ + examples: + readFull: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: TaskSid in: query description: The SID of the Task with the Events to read. Returns only the @@ -2229,6 +2472,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ + examples: + readFull: + value: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: WorkerSid in: query description: The SID of the Worker with the Events to read. Returns only the @@ -2238,6 +2486,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WK[0-9a-fA-F]{32}$ + examples: + readFull: + value: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: WorkflowSid in: query description: The SID of the Workflow with the Events to read. Returns only @@ -2247,6 +2500,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WW[0-9a-fA-F]{32}$ + examples: + readFull: + value: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: TaskChannel in: query description: The TaskChannel with the Events to read. Returns only the Events @@ -2293,38 +2551,85 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.event' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + events: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_type: workspace + actor_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Worker JustinWorker updated to Idle Activity + event_data: + worker_activity_name: Offline + worker_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_attributes: '{}' + worker_name: JustinWorker + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_time_in_previous_activity: '26' + worker_time_in_previous_activity_ms: '26123' + workspace_name: WorkspaceName + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_date: '2015-02-07T00:32:41Z' + event_date_ms: 987654321111 + event_type: worker.activity + resource_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_type: worker + resource_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: twilio + source_ip_address: 1.2.3.4 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: events + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readEmpty: + value: + events: [] + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: events + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListEvent - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2332,12 +2637,18 @@ paths: - assignment_status - priority - reason - pathType: instance dependentProperties: - reservation: '{workspace_sid: workspace_sid, task_sid: sid}' + reservations: + mapping: + workspace_sid: workspace_sid + task_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Tasks/{task_sid}/Reservations parent: /Workspaces/{Sid} + pathType: instance get: description: '' + tags: + - TaskrouterV1Task parameters: - name: WorkspaceSid in: path @@ -2363,14 +2674,43 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + age: 25200 + assignment_status: pending + attributes: '{"body": "hello"}' + date_created: '2014-05-14T18:50:02Z' + date_updated: '2014-05-15T07:26:06Z' + task_queue_entered_date: '2014-05-14T18:50:02Z' + 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 + addons: '{}' + links: + task_queue: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: OK security: - accountSid_authToken: [] operationId: FetchTask - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Task parameters: - name: WorkspaceSid in: path @@ -2403,12 +2743,39 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + age: 25200 + assignment_status: pending + attributes: '{"body": "hello"}' + date_created: '2014-05-14T18:50:02Z' + date_updated: '2014-05-15T07:26:06Z' + task_queue_entered_date: '2014-05-14T18:50:02Z' + 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: '{}' + links: + task_queue: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: OK security: - accountSid_authToken: [] operationId: UpdateTask - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2442,8 +2809,24 @@ paths: description: When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`. + VirtualStartTime: + type: string + format: date-time + 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' delete: description: '' + tags: + - TaskrouterV1Task parameters: - name: WorkspaceSid in: path @@ -2476,12 +2859,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTask - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Tasks: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2489,12 +2870,18 @@ paths: - assignment_status - priority - reason - pathType: list dependentProperties: - reservation: '{workspace_sid: workspace_sid, task_sid: sid}' + reservations: + mapping: + workspace_sid: workspace_sid + task_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Tasks/{task_sid}/Reservations parent: /Workspaces/{Sid} + pathType: list get: description: '' + tags: + - TaskrouterV1Task parameters: - name: WorkspaceSid in: path @@ -2511,6 +2898,13 @@ paths: all Tasks in the Workspace with the specified priority. schema: type: integer + examples: + readFull: + value: 1 + readEmpty: + value: 1 + readAssignmentStatusMultiple: + value: 1 - name: AssignmentStatus in: query description: 'The `assignment_status` of the Tasks you want to read. Can be: @@ -2520,6 +2914,15 @@ paths: type: array items: type: string + examples: + readFull: + value: pending,reserved + readEmpty: + value: pending + readAssignmentStatusMultiple: + value: + - pending + - reserved - name: WorkflowSid in: query description: The SID of the Workflow with the Tasks to read. Returns the Tasks @@ -2529,12 +2932,26 @@ paths: minLength: 34 maxLength: 34 pattern: ^WW[0-9a-fA-F]{32}$ + examples: + readFull: + value: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readAssignmentStatusMultiple: + value: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: WorkflowName in: query description: The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name. schema: type: string + examples: + readFull: + value: workflow_name + readEmpty: + value: workflow_name + readAssignmentStatusMultiple: + value: workflow_name - name: TaskQueueSid in: query description: The SID of the TaskQueue with the Tasks to read. Returns the @@ -2544,12 +2961,26 @@ paths: minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ + examples: + readFull: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readAssignmentStatusMultiple: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: TaskQueueName in: query description: The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name. schema: type: string + examples: + readFull: + value: task_queue_name + readEmpty: + value: task_queue_name + readAssignmentStatusMultiple: + value: task_queue_name - name: EvaluateTaskAttributes in: query description: The attributes of the Tasks to read. Returns the Tasks that match @@ -2558,20 +2989,20 @@ paths: type: string - name: Ordering in: query - description: 'How to order the returned Task resources. y default, Tasks are - sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, - where `Attribute` can be either `Priority` or `DateCreated` and `Order` - can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks - ordered in descending order of their Priority. Multiple sort orders can - be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, + description: 'How to order the returned Task resources. By default, Tasks + are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, + where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` + and `Order` can be either `asc` or `desc`. For example, `Priority:desc` + returns Tasks ordered in descending order of their Priority. Pairings of + sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated - Order.' + Order. The only ordering pairing not allowed is DateCreated and VirtualStartTime.' schema: type: string - name: HasAddons in: query - description: Whether to read Tasks with addons. If `true`, returns only Tasks - with addons. If `false`, returns only Tasks without addons. + description: Whether to read Tasks with Add-ons. If `true`, returns only Tasks + with Add-ons. If `false`, returns only Tasks without Add-ons. schema: type: boolean - name: PageSize @@ -2606,36 +3037,96 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.task' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending%2Creserved&PageSize=50&Page=0 + key: tasks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending%2Creserved&PageSize=50&Page=0 + tasks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + age: 25200 + assignment_status: pending + attributes: '{"body": "hello"}' + date_created: '2014-05-14T14:26:54Z' + date_updated: '2014-05-15T16:03:42Z' + task_queue_entered_date: '2014-05-14T14:26:54Z' + 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 + addons: '{}' + links: + task_queue: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0 + key: tasks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0 + tasks: [] + readAssignmentStatusMultiple: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0 + key: tasks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0 + tasks: [] description: OK security: - accountSid_authToken: [] operationId: ListTask - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Task parameters: - name: WorkspaceSid in: path @@ -2652,12 +3143,39 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + age: 25200 + assignment_status: pending + attributes: '{"body": "attributes"}' + date_created: '2014-05-14T18:50:02Z' + date_updated: '2014-05-15T07:26:06Z' + task_queue_entered_date: null + 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 + addons: '{}' + links: + task_queue: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: Created security: - accountSid_authToken: [] operationId: CreateTask - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2700,6 +3218,22 @@ paths: when the Task is assigned to a Worker. For example: `{ "task_type": "call", "twilio_call_sid": "CAxxx", "customer_ticket_number": "12345" }`.' + VirtualStartTime: + type: string + format: date-time + description: The virtual start time to assign the new task and override + the default. When supplied, the new task will have this virtual + start time. When not supplied, the new task will have the virtual + start time equal to `date_created`. Value can't be in the future. + examples: + create: + value: + Attributes: '{"body": "attributes"}' + Priority: 1 + Timeout: 1 + WorkflowSid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + TaskChannel: channel + VirtualStartTime: '2014-05-14T18:50:02Z' /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}: servers: - url: https://taskrouter.twilio.com @@ -2709,10 +3243,12 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Workspaces/{Sid} + pathType: instance get: description: '' + tags: + - TaskrouterV1TaskChannel parameters: - name: WorkspaceSid in: path @@ -2735,14 +3271,41 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_channel' + examples: + fetchSid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + friendly_name: Default + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_optimized_routing: true + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchUniqueName: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + friendly_name: Default + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_optimized_routing: false + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchTaskChannel - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1TaskChannel parameters: - name: WorkspaceSid in: path @@ -2765,12 +3328,37 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_channel' + examples: + updateSid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Default + unique_name: default + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_optimized_routing: true + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateUniqueName: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Default + unique_name: default + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_optimized_routing: true + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateTaskChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2787,8 +3375,19 @@ paths: description: Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized. + examples: + updateSid: + value: + FriendlyName: Outbound Voice + ChannelOptimizedRouting: true + updateUniqueName: + value: + FriendlyName: Outbound Voice + ChannelOptimizedRouting: true delete: description: '' + tags: + - TaskrouterV1TaskChannel parameters: - name: WorkspaceSid in: path @@ -2811,8 +3410,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTaskChannel - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/TaskChannels: servers: - url: https://taskrouter.twilio.com @@ -2822,10 +3419,12 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Workspaces/{Sid} + pathType: list get: description: '' + tags: + - TaskrouterV1TaskChannel parameters: - name: WorkspaceSid in: path @@ -2868,36 +3467,70 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.task_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + friendly_name: Default + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_optimized_routing: true + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0 + key: channels + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0 + readEmpty: + value: + channels: [] + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0 + key: channels + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListTaskChannel - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1TaskChannel parameters: - name: WorkspaceSid in: path @@ -2914,12 +3547,24 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_channel' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Outbound Voice + unique_name: ovoice + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + channel_optimized_routing: true + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateTaskChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2943,25 +3588,42 @@ paths: required: - FriendlyName - UniqueName + examples: + create: + value: + FriendlyName: Outbound Voice + UniqueName: ovoice /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - task_order - pathType: instance dependentProperties: - task_queue_statistics: '{workspace_sid: workspace_sid, task_queue_sid: sid}' - task_queue_real_time_statistics: '{workspace_sid: workspace_sid, task_queue_sid: - sid}' - task_queue_cumulative_statistics: '{workspace_sid: workspace_sid, task_queue_sid: - sid}' + statistics: + mapping: + workspace_sid: workspace_sid + task_queue_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/Statistics + real_time_statistics: + mapping: + workspace_sid: workspace_sid + task_queue_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/RealTimeStatistics + cumulative_statistics: + mapping: + workspace_sid: workspace_sid + task_queue_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/CumulativeStatistics parent: /Workspaces/{Sid} + pathType: instance get: description: '' + tags: + - TaskrouterV1TaskQueue parameters: - name: WorkspaceSid in: path @@ -2987,14 +3649,41 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_activity_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + assignment_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-08-04T01:31:41Z' + date_updated: '2015-08-04T01:31:41Z' + friendly_name: 81f96435-3a05-11e5-9f81-98e0d9a1eb73 + max_reserved_workers: 1 + links: + assignment_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + 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 description: OK security: - accountSid_authToken: [] operationId: FetchTaskQueue - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1TaskQueue parameters: - name: WorkspaceSid in: path @@ -3020,12 +3709,37 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_activity_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + assignment_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-08-04T01:31:41Z' + date_updated: '2015-08-04T01:31:41Z' + friendly_name: 81f96435-3a05-11e5-9f81-98e0d9a1eb73 + max_reserved_workers: 1 + links: + assignment_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + 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 description: OK security: - accountSid_authToken: [] operationId: UpdateTaskQueue - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3070,8 +3784,19 @@ paths: or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the oldest task first and `LIFO` to assign the most recent task first. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).' + examples: + update: + value: + AssignmentActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + MaxReservedWorkers: 1 + ReservationActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + TargetWorkers: target_workers + OperatingUnitSid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: '' + tags: + - TaskrouterV1TaskQueue parameters: - name: WorkspaceSid in: path @@ -3097,27 +3822,37 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTaskQueue - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/TaskQueues: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - task_order - pathType: list dependentProperties: - task_queue_statistics: '{workspace_sid: workspace_sid, task_queue_sid: sid}' - task_queue_real_time_statistics: '{workspace_sid: workspace_sid, task_queue_sid: - sid}' - task_queue_cumulative_statistics: '{workspace_sid: workspace_sid, task_queue_sid: - sid}' + statistics: + mapping: + workspace_sid: workspace_sid + task_queue_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/Statistics + real_time_statistics: + mapping: + workspace_sid: workspace_sid + task_queue_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/RealTimeStatistics + cumulative_statistics: + mapping: + workspace_sid: workspace_sid + task_queue_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/CumulativeStatistics parent: /Workspaces/{Sid} + pathType: list get: description: '' + tags: + - TaskrouterV1TaskQueue parameters: - name: WorkspaceSid in: path @@ -3133,12 +3868,26 @@ paths: description: The `friendly_name` of the TaskQueue resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: EvaluateWorkerAttributes in: query description: The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter. schema: type: string + examples: + readFull: + value: evaluate_worker_attributes + readEmpty: + value: evaluate_worker_attributes - name: WorkerSid in: query description: The SID of the Worker with the TaskQueue resources to read. @@ -3184,36 +3933,83 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues?EvaluateWorkerAttributes=evaluate_worker_attributes&FriendlyName=friendly_name&PageSize=50&Page=0 + key: task_queues + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues?EvaluateWorkerAttributes=evaluate_worker_attributes&FriendlyName=friendly_name&PageSize=50&Page=0 + task_queues: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_activity_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + assignment_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-08-04T01:31:41Z' + date_updated: '2015-08-04T01:31:41Z' + friendly_name: 81f96435-3a05-11e5-9f81-98e0d9a1eb73 + max_reserved_workers: 1 + links: + assignment_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + 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: [] description: OK security: - accountSid_authToken: [] operationId: ListTaskQueue - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1TaskQueue parameters: - name: WorkspaceSid in: path @@ -3230,12 +4026,37 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_activity_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + assignment_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-08-04T01:31:41Z' + date_updated: '2015-08-04T01:31:41Z' + friendly_name: 81f96435-3a05-11e5-9f81-98e0d9a1eb73 + max_reserved_workers: 1 + links: + assignment_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + 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 description: Created security: - accountSid_authToken: [] operationId: CreateTaskQueue - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3283,21 +4104,111 @@ paths: is assigned to them. required: - FriendlyName + examples: + create: + value: + AssignmentActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + MaxReservedWorkers: 1 + ReservationActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + TargetWorkers: target_workers + OperatingUnitSid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /v1/Workspaces/{WorkspaceSid}/TaskQueues/RealTimeStatistics: + servers: + - url: https://taskrouter.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - account_sid + - workspace_sid + - task_queue_data + - task_queue_response_count + parent: /Workspaces/{WorkspaceSid}/TaskQueues + mountName: bulk_real_time_statistics + className: task_queue_bulk_real_time_statistics + pathType: list + post: + description: Fetch a Task Queue Real Time Statistics in bulk for the array of + TaskQueue SIDs, support upto 50 in a request. + 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: + '201': + 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 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateTaskQueueBulkRealTimeStatistics + requestBody: + content: + application/json: + schema: + type: object + title: CreateTaskQueueBulkRealTimeStatisticsRequest + properties: {} /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - start_time - end_time - avg_task_acceptance_time - tasks_completed - pathType: instance parent: /Workspaces/{WorkspaceSid}/TaskQueues/{Sid} className: task_queue_cumulative_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1TaskQueueCumulativeStatistics parameters: - name: WorkspaceSid in: path @@ -3325,6 +4236,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. @@ -3338,6 +4252,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: TaskChannel in: query description: Only calculate cumulative statistics on this TaskChannel. Can @@ -3360,26 +4277,77 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_cumulative_statistics' + examples: + fetch: + value: + reservations_created: 100 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations_rejected: 100 + tasks_completed: 100 + end_time: '2015-07-30T20:00:00Z' + tasks_entered: 100 + tasks_canceled: 100 + reservations_accepted: 100 + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations_timed_out: 100 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + wait_duration_until_canceled: + avg: 0 + min: 0 + max: 0 + total: 0 + wait_duration_until_accepted: + avg: 0 + min: 0 + max: 0 + total: 0 + wait_duration_in_queue_until_accepted: + avg: 0 + min: 0 + max: 0 + total: 0 + split_by_wait_time: + '5': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + '10': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + start_time: '2015-07-30T20:00:00Z' + tasks_moved: 100 + reservations_canceled: 100 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_deleted: 100 + reservations_rescinded: 100 + avg_task_acceptance_time: 100 description: OK security: - accountSid_authToken: [] operationId: FetchTaskQueueCumulativeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/RealTimeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - longest_task_waiting_age - longest_task_waiting_sid - total_tasks - pathType: instance parent: /Workspaces/{WorkspaceSid}/TaskQueues/{Sid} className: task_queue_real_time_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1TaskQueueRealTimeStatistics parameters: - name: WorkspaceSid in: path @@ -3405,30 +4373,66 @@ paths: SID or its `unique_name`, such as `voice`, `sms`, or `default`. schema: type: string + examples: + fetch: + value: voice responses: '200': content: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_real_time_statistics' + examples: + fetch: + value: + longest_task_waiting_age: 100 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + longest_relative_task_age_in_queue: 100 + longest_relative_task_sid_in_queue: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + reserved: 0 + pending: 0 + assigned: 0 + wrapping: 0 + total_eligible_workers: 100 + activity_statistics: + - friendly_name: Idle + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Busy + workers: 9 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Offline + workers: 6 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Reserved + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_priority: {} + total_tasks: 100 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + total_available_workers: 100 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics description: OK security: - accountSid_authToken: [] operationId: FetchTaskQueueRealTimeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: instance parent: /Workspaces/{WorkspaceSid}/TaskQueues/{Sid} className: task_queue_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1TaskQueueStatistics parameters: - name: WorkspaceSid in: path @@ -3456,12 +4460,18 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. The default is 15 minutes. schema: type: integer + examples: + fetch: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -3469,6 +4479,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: TaskChannel in: query description: Only calculate real-time and cumulative statistics for the specified @@ -3490,24 +4503,75 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_statistics' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + cumulative: + avg_task_acceptance_time: 0.0 + end_time: '2015-08-18T08:42:34Z' + reservations_accepted: 0 + reservations_canceled: 0 + reservations_created: 0 + reservations_rejected: 0 + reservations_rescinded: 0 + reservations_timed_out: 0 + start_time: '2015-08-18T08:27:34Z' + tasks_canceled: 0 + tasks_deleted: 0 + tasks_entered: 0 + tasks_moved: 0 + realtime: + activity_statistics: + - friendly_name: Offline + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Idle + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Reserved + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Busy + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + longest_task_waiting_age: 0 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + assigned: 0 + pending: 0 + reserved: 0 + wrapping: 0 + total_available_workers: 0 + total_eligible_workers: 0 + total_tasks: 0 + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchTaskQueueStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: list parent: /Workspaces/{WorkspaceSid}/TaskQueues className: task_queues_statistics + pathType: list get: description: '' + tags: + - TaskrouterV1TaskQueuesStatistics parameters: - name: WorkspaceSid in: path @@ -3526,17 +4590,32 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02T00:00:00Z' + readEmpty: + value: '2008-01-02T00:00:00Z' - name: FriendlyName in: query description: The `friendly_name` of the TaskQueue statistics to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. The default is 15 minutes. schema: type: integer + examples: + readFull: + value: 1 + readEmpty: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -3544,6 +4623,11 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02T00:00:00Z' + readEmpty: + value: '2008-01-02T00:00:00Z' - name: TaskChannel in: query description: Only calculate statistics on this TaskChannel. Can be the TaskChannel's @@ -3590,34 +4674,102 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue.task_queues_statistics' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0 + key: task_queues_statistics + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0 + task_queues_statistics: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cumulative: + avg_task_acceptance_time: 0.0 + end_time: '2015-08-18T08:46:15Z' + reservations_accepted: 0 + reservations_canceled: 0 + reservations_created: 0 + reservations_rejected: 0 + reservations_rescinded: 0 + reservations_timed_out: 0 + start_time: '2015-08-18T08:31:15Z' + tasks_canceled: 0 + tasks_deleted: 0 + tasks_entered: 0 + tasks_moved: 0 + realtime: + activity_statistics: + - friendly_name: Offline + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Idle + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Reserved + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Busy + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + longest_task_waiting_age: 0 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + assigned: 0 + pending: 0 + reserved: 0 + wrapping: 0 + total_available_workers: 0 + total_eligible_workers: 0 + total_tasks: 0 + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0 + key: task_queues_statistics + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0 + task_queues_statistics: [] description: OK security: - accountSid_authToken: [] operationId: ListTaskQueuesStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations: servers: - url: https://taskrouter.twilio.com @@ -3628,10 +4780,12 @@ paths: - reservation_status - worker_name - worker_sid - pathType: list parent: /Workspaces/{WorkspaceSid}/Tasks/{Sid} + pathType: list get: description: '' + tags: + - TaskrouterV1Reservation parameters: - name: WorkspaceSid in: path @@ -3700,34 +4854,69 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.task.task_reservation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + key: reservations + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + reservations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + key: reservations + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + reservations: [] description: OK security: - accountSid_authToken: [] operationId: ListTaskReservation - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}: servers: - url: https://taskrouter.twilio.com @@ -3738,10 +4927,12 @@ paths: - reservation_status - worker_name - worker_sid - pathType: instance parent: /Workspaces/{WorkspaceSid}/Tasks/{Sid} + pathType: instance get: description: '' + tags: + - TaskrouterV1Reservation parameters: - name: WorkspaceSid in: path @@ -3778,14 +4969,31 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task.task_reservation' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchTaskReservation - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Reservation parameters: - name: WorkspaceSid in: path @@ -3827,12 +5035,43 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task.task_reservation' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateSuperviseInstruction: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateTaskReservation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4136,25 +5375,58 @@ paths: type: boolean description: Whether to play a notification beep when the customer joins. + JitterBufferSize: + type: string + 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 /v1/Workspaces/{WorkspaceSid}/Workers: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - available - pathType: list dependentProperties: - workers_real_time_statistics: '{workspace_sid: workspace_sid}' - workers_cumulative_statistics: '{workspace_sid: workspace_sid}' - worker_statistics: '{workspace_sid: workspace_sid, worker_sid: sid}' - reservation: '{workspace_sid: workspace_sid, worker_sid: sid}' - worker_channel: '{workspace_sid: workspace_sid, worker_sid: sid}' + real_time_statistics: + mapping: + workspace_sid: workspace_sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers/RealTimeStatistics + cumulative_statistics: + mapping: + workspace_sid: workspace_sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers/CumulativeStatistics + statistics: + mapping: + workspace_sid: workspace_sid + worker_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Statistics + reservations: + mapping: + workspace_sid: workspace_sid + worker_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Reservations + worker_channels: + mapping: + workspace_sid: workspace_sid + worker_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Channels parent: /Workspaces/{Sid} + pathType: list get: description: '' + tags: + - TaskrouterV1Worker parameters: - name: WorkspaceSid in: path @@ -4170,6 +5442,11 @@ paths: description: The `activity_name` of the Worker resources to read. schema: type: string + examples: + readFull: + value: activity_name + readEmpty: + value: activity_name - name: ActivitySid in: query description: The `activity_sid` of the Worker resources to read. @@ -4178,6 +5455,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WA[0-9a-fA-F]{32}$ + examples: + readFull: + value: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Available in: query description: Whether to return only Worker resources that are available or @@ -4186,23 +5468,48 @@ paths: are not available. schema: type: string + examples: + readFull: + value: available + readEmpty: + value: available - name: FriendlyName in: query description: The `friendly_name` of the Worker resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: TargetWorkersExpression in: query - description: Filter by Workers that would match an expression on a TaskQueue. - This is helpful for debugging which Workers would match a potential queue. + description: 'Filter by Workers that would match an expression. In addition + to fields in the workers'' attributes, the expression can include the following + worker fields: `sid`, `friendly_name`, `activity_sid`, or `activity_name`' schema: type: string + examples: + readFull: + value: target_workers_expression + readEmpty: + value: target_workers_expression - name: TaskQueueName in: query description: The `friendly_name` of the TaskQueue that the Workers to read are eligible for. schema: type: string + examples: + readFull: + value: task_queue_name + readEmpty: + value: task_queue_name - name: TaskQueueSid in: query description: The SID of the TaskQueue that the Workers to read are eligible @@ -4212,6 +5519,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ + examples: + readFull: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Ordering in: query description: Sorting parameter for Workers @@ -4249,36 +5561,82 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.worker' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0 + next_page_url: null + key: workers + workers: + - sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: testWorker + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_name: Offline + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + available: false + date_created: '2017-05-30T23:05:29Z' + date_updated: '2017-05-30T23:05:29Z' + date_status_changed: '2017-05-30T23:05:29Z' + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics + worker_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + worker_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0 + key: workers + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0 + workers: [] description: OK security: - accountSid_authToken: [] operationId: ListWorker - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Worker parameters: - name: WorkspaceSid in: path @@ -4295,12 +5653,36 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker' + examples: + create: + value: + sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: NewWorker + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_name: Offline + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + available: false + date_created: '2017-05-30T23:19:38Z' + date_updated: '2017-05-30T23:19:38Z' + date_status_changed: '2017-05-30T23:19:38Z' + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics + worker_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + worker_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: Created security: - accountSid_authToken: [] operationId: CreateWorker - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4329,25 +5711,52 @@ paths: TaskRouter assigns a Task to the Worker. Defaults to {}.' required: - FriendlyName + examples: + create: + value: + ActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: attributes + FriendlyName: friendly_name + OperatingUnitSid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Workspaces/{WorkspaceSid}/Workers/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - available - pathType: instance dependentProperties: - workers_real_time_statistics: '{workspace_sid: workspace_sid}' - workers_cumulative_statistics: '{workspace_sid: workspace_sid}' - worker_statistics: '{workspace_sid: workspace_sid, worker_sid: sid}' - reservation: '{workspace_sid: workspace_sid, worker_sid: sid}' - worker_channel: '{workspace_sid: workspace_sid, worker_sid: sid}' + real_time_statistics: + mapping: + workspace_sid: workspace_sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers/RealTimeStatistics + cumulative_statistics: + mapping: + workspace_sid: workspace_sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers/CumulativeStatistics + statistics: + mapping: + workspace_sid: workspace_sid + worker_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Statistics + reservations: + mapping: + workspace_sid: workspace_sid + worker_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Reservations + worker_channels: + mapping: + workspace_sid: workspace_sid + worker_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Channels parent: /Workspaces/{Sid} + pathType: instance get: description: '' + tags: + - TaskrouterV1Worker parameters: - name: WorkspaceSid in: path @@ -4373,14 +5782,40 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_name: available + activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + available: false + date_created: '2017-05-30T23:32:39Z' + date_status_changed: '2017-05-30T23:32:39Z' + date_updated: '2017-05-30T23:32:39Z' + friendly_name: NewWorker3 + sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics + worker_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + worker_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: OK security: - accountSid_authToken: [] operationId: FetchWorker - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Worker parameters: - name: WorkspaceSid in: path @@ -4411,12 +5846,36 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker' + examples: + update: + value: + sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: blah + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_name: Offline + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + available: false + date_created: '2017-05-30T23:32:22Z' + date_updated: '2017-05-31T00:05:57Z' + date_status_changed: '2017-05-30T23:32:22Z' + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics + worker_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + worker_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: OK security: - accountSid_authToken: [] operationId: UpdateWorker - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4447,8 +5906,17 @@ paths: description: Whether to reject the Worker's pending reservations. This option is only valid if the Worker's new [Activity](https://www.twilio.com/docs/taskrouter/api/activity) resource has its `availability` property set to `False`. + examples: + update: + value: + ActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: attributes + FriendlyName: friendly_name + OperatingUnitSid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: '' + tags: + - TaskrouterV1Worker parameters: - name: WorkspaceSid in: path @@ -4479,22 +5947,22 @@ paths: security: - accountSid_authToken: [] operationId: DeleteWorker - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - task_channel_sid - task_channel_unique_name - pathType: list parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} mountName: worker_channels + pathType: list get: description: '' + tags: + - TaskrouterV1WorkerChannel parameters: - name: WorkspaceSid in: path @@ -4546,48 +6014,84 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + key: channels + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assigned_tasks: 0 + available: true + available_capacity_percentage: 100 + configured_capacity: 1 + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + sid: WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + key: channels + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + channels: [] description: OK security: - accountSid_authToken: [] operationId: ListWorkerChannel - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - task_channel_sid - task_channel_unique_name - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} mountName: worker_channels + pathType: instance get: description: '' + tags: + - TaskrouterV1WorkerChannel parameters: - name: WorkspaceSid in: path @@ -4619,14 +6123,30 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_channel' + examples: + fetchSid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assigned_tasks: 0 + available: true + available_capacity_percentage: 100 + configured_capacity: 1 + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + sid: WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkerChannel - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1WorkerChannel parameters: - name: WorkspaceSid in: path @@ -4658,12 +6178,26 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_channel' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assigned_tasks: 0 + available: true + available_capacity_percentage: 100 + configured_capacity: 3 + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + sid: WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateWorkerChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4682,18 +6216,24 @@ paths: description: Whether the WorkerChannel is available. Set to `false` to prevent the Worker from receiving any new Tasks of this TaskChannel type. + examples: + update: + value: + Capacity: 3 /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} className: worker_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1WorkerStatistics parameters: - name: WorkspaceSid in: path @@ -4721,6 +6261,9 @@ paths: trends. schema: type: integer + examples: + fetch: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -4728,6 +6271,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: EndDate in: query description: Only include usage that occurred on or before this date, specified @@ -4735,6 +6281,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: TaskChannel in: query description: Only calculate statistics on this TaskChannel. Can be the TaskChannel's @@ -4747,12 +6296,51 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_instance_statistics' + examples: + fetch: + value: + cumulative: + reservations_created: 100 + reservations_accepted: 100 + reservations_rejected: 100 + reservations_timed_out: 100 + reservations_canceled: 100 + reservations_rescinded: 100 + activity_durations: + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Offline + avg: 1080 + total: 5400 + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Busy + avg: 1012 + total: 8100 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Idle + avg: 0 + total: 0 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Reserved + avg: 0 + total: 0 + start_time: '2008-01-02T00:00:00Z' + end_time: '2008-01-02T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics description: OK security: - accountSid_authToken: [] operationId: FetchWorkerInstanceStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations: servers: - url: https://taskrouter.twilio.com @@ -4762,10 +6350,12 @@ paths: - sid - reservation_status - date_created - pathType: list parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} + pathType: list get: description: '' + tags: + - TaskrouterV1Reservation parameters: - name: WorkspaceSid in: path @@ -4827,34 +6417,69 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + key: reservations + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + reservations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + key: reservations + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + reservations: [] description: OK security: - accountSid_authToken: [] operationId: ListWorkerReservation - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}: servers: - url: https://taskrouter.twilio.com @@ -4864,10 +6489,12 @@ paths: - sid - reservation_status - date_created - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} + pathType: instance get: description: '' + tags: + - TaskrouterV1Reservation parameters: - name: WorkspaceSid in: path @@ -4904,14 +6531,31 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkerReservation - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Reservation parameters: - name: WorkspaceSid in: path @@ -4953,12 +6597,27 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateWorkerReservation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5256,18 +6915,28 @@ paths: type: boolean description: Whether to play a notification beep when the customer joins. + JitterBufferSize: + type: string + description: 'The jitter buffer size for conference. Can be: `small`, + `medium`, `large`, `off`.' + examples: + update: + value: + ReservationStatus: accepted /v1/Workspaces/{WorkspaceSid}/Workers/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers className: workers_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1WorkersStatistics parameters: - name: WorkspaceSid in: path @@ -5286,6 +6955,9 @@ paths: trends. schema: type: integer + examples: + fetch: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -5293,6 +6965,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: EndDate in: query description: Only calculate statistics from this date and time and earlier, @@ -5301,6 +6976,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: TaskQueueSid in: query description: The SID of the TaskQueue for which to fetch Worker statistics. @@ -5333,16 +7011,69 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_statistics' + examples: + fetch: + value: + cumulative: + reservations_created: 0 + reservations_accepted: 0 + reservations_rejected: 0 + reservations_timed_out: 0 + reservations_canceled: 0 + reservations_rescinded: 0 + activity_durations: + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Offline + avg: 1080 + total: 5400 + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Busy + avg: 1012 + total: 8100 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Idle + avg: 0 + total: 0 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Reserved + avg: 0 + total: 0 + start_time: '2008-01-02T00:00:00Z' + end_time: '2008-01-02T00:00:00Z' + realtime: + total_workers: 15 + activity_statistics: + - friendly_name: Idle + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Busy + workers: 9 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Offline + workers: 6 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Reserved + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics description: OK security: - accountSid_authToken: [] operationId: FetchWorkerStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - reservations_created @@ -5351,11 +7082,13 @@ paths: - reservations_timed_out - reservations_canceled - reservations_rescinded - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} className: workers_cumulative_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1WorkersCumulativeStatistics parameters: - name: WorkspaceSid in: path @@ -5373,6 +7106,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. @@ -5388,6 +7124,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: TaskChannel in: query description: Only calculate cumulative statistics on this TaskChannel. Can @@ -5401,24 +7140,63 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.workers_cumulative_statistics' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics + reservations_created: 100 + reservations_accepted: 100 + reservations_rejected: 100 + reservations_timed_out: 100 + reservations_canceled: 100 + reservations_rescinded: 100 + activity_durations: + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Offline + avg: 1080 + total: 5400 + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Busy + avg: 1012 + total: 8100 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Idle + avg: 0 + total: 0 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Reserved + avg: 0 + total: 0 + start_time: '2015-07-30T20:00:00Z' + end_time: '2015-07-30T20:00:00Z' description: OK security: - accountSid_authToken: [] operationId: FetchWorkersCumulativeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - total_workers - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} className: workers_real_time_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1WorkersRealTimeStatistics parameters: - name: WorkspaceSid in: path @@ -5436,37 +7214,70 @@ paths: `default`. schema: type: string + examples: + fetch: + value: voice responses: '200': content: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.workers_real_time_statistics' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics + total_workers: 15 + activity_statistics: + - friendly_name: Idle + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Busy + workers: 9 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Offline + workers: 6 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Reserved + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkersRealTimeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - document_content_type - pathType: instance dependentProperties: - workflow_statistics: '{workspace_sid: workspace_sid, workflow_sid: sid}' - workflow_real_time_statistics: '{workspace_sid: workspace_sid, workflow_sid: - sid}' - workflow_cumulative_statistics: '{workspace_sid: workspace_sid, workflow_sid: - sid}' + statistics: + mapping: + workspace_sid: workspace_sid + workflow_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/Statistics + real_time_statistics: + mapping: + workspace_sid: workspace_sid + workflow_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/RealTimeStatistics + cumulative_statistics: + mapping: + workspace_sid: workspace_sid + workflow_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/CumulativeStatistics parent: /Workspaces/{Sid} + pathType: instance get: description: '' + tags: + - TaskrouterV1Workflow parameters: - name: WorkspaceSid in: path @@ -5492,14 +7303,35 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_callback_url: http://example.com + configuration: 'task-routing:\n - filter: \n - 1 == 1\n target:\n - + queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n set-priority: + 0\n' + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + document_content_type: application/json + fallback_assignment_callback_url: null + friendly_name: Default Fifo Workflow + sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_reservation_timeout: 120 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics description: OK security: - accountSid_authToken: [] operationId: FetchWorkflow - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Workflow parameters: - name: WorkspaceSid in: path @@ -5525,12 +7357,31 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_callback_url: http://example.com + configuration: 'task-routing:\n - filter: \n - 1 == 1\n target:\n - + queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n set-priority: + 0\n' + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + document_content_type: application/json + fallback_assignment_callback_url: null + friendly_name: Default Fifo Workflow + sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_reservation_timeout: 120 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateWorkflow - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5569,8 +7420,19 @@ paths: description: Whether or not to re-evaluate Tasks. The default is `false`, which means Tasks in the Workflow will not be processed through the assignment loop again. + examples: + update: + value: + AssignmentCallbackUrl: http://example.com + Configuration: configuration + FallbackAssignmentCallbackUrl: http://example.com + FriendlyName: friendly_name + TaskReservationTimeout: 1 + ReEvaluateTasks: 'false' delete: description: '' + tags: + - TaskrouterV1Workflow parameters: - name: WorkspaceSid in: path @@ -5596,27 +7458,37 @@ paths: security: - accountSid_authToken: [] operationId: DeleteWorkflow - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workflows: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - document_content_type - pathType: list dependentProperties: - workflow_statistics: '{workspace_sid: workspace_sid, workflow_sid: sid}' - workflow_real_time_statistics: '{workspace_sid: workspace_sid, workflow_sid: - sid}' - workflow_cumulative_statistics: '{workspace_sid: workspace_sid, workflow_sid: - sid}' + statistics: + mapping: + workspace_sid: workspace_sid + workflow_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/Statistics + real_time_statistics: + mapping: + workspace_sid: workspace_sid + workflow_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/RealTimeStatistics + cumulative_statistics: + mapping: + workspace_sid: workspace_sid + workflow_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/CumulativeStatistics parent: /Workspaces/{Sid} + pathType: list get: description: '' + tags: + - TaskrouterV1Workflow parameters: - name: WorkspaceSid in: path @@ -5632,6 +7504,15 @@ paths: description: The `friendly_name` of the Workflow resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5664,36 +7545,77 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0 + key: workflows + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0 + workflows: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_callback_url: http://example.com + configuration: 'task-routing:\n - filter: \n - 1 == 1\n target:\n - + queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n set-priority: + 0\n' + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:47:51Z' + document_content_type: application/json + fallback_assignment_callback_url: null + friendly_name: Default Fifo Workflow + sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_reservation_timeout: 120 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0 + key: workflows + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0 + workflows: [] description: OK security: - accountSid_authToken: [] operationId: ListWorkflow - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Workflow parameters: - name: WorkspaceSid in: path @@ -5711,12 +7633,31 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_callback_url: http://example.com + configuration: 'task-routing:\n - filter: \n - 1 == 1\n target:\n - + queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n set-priority: + 0\n' + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + document_content_type: application/json + fallback_assignment_callback_url: null + friendly_name: Default Fifo Workflow + sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_reservation_timeout: 120 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics description: Created security: - accountSid_authToken: [] operationId: CreateWorkflow - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5753,21 +7694,31 @@ paths: required: - FriendlyName - Configuration + examples: + create: + value: + AssignmentCallbackUrl: http://example.com + Configuration: configuration + FallbackAssignmentCallbackUrl: http://example.com + FriendlyName: friendly_name + TaskReservationTimeout: 1 /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/CumulativeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - start_time - end_time - avg_task_acceptance_time - tasks_completed - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workflows/{Sid} className: workflow_cumulative_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1WorkflowCumulativeStatistics parameters: - name: WorkspaceSid in: path @@ -5795,6 +7746,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. @@ -5810,6 +7764,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: TaskChannel in: query description: Only calculate cumulative statistics on this TaskChannel. Can @@ -5835,26 +7792,73 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow.workflow_cumulative_statistics' + examples: + fetch: + value: + avg_task_acceptance_time: 100 + tasks_canceled: 100 + start_time: '2015-07-30T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_moved: 100 + tasks_entered: 100 + wait_duration_until_canceled: + avg: 0 + min: 0 + max: 0 + total: 0 + wait_duration_until_accepted: + avg: 0 + min: 0 + max: 0 + total: 0 + split_by_wait_time: + '5': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + '10': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + reservations_canceled: 100 + end_time: '2015-07-30T20:00:00Z' + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations_created: 100 + reservations_accepted: 100 + reservations_rescinded: 100 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations_rejected: 100 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + tasks_deleted: 100 + tasks_timed_out_in_workflow: 100 + tasks_completed: 100 + reservations_timed_out: 100 description: OK security: - accountSid_authToken: [] operationId: FetchWorkflowCumulativeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - longest_task_waiting_age - longest_task_waiting_sid - total_tasks - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workflows/{Sid} className: workflow_real_time_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1WorkflowRealTimeStatistics parameters: - name: WorkspaceSid in: path @@ -5882,30 +7886,49 @@ paths: `default`. schema: type: string + examples: + fetch: + value: voice responses: '200': content: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow.workflow_real_time_statistics' + examples: + fetch: + value: + longest_task_waiting_age: 100 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + tasks_by_priority: {} + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + reserved: 0 + pending: 0 + assigned: 0 + wrapping: 0 + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + total_tasks: 100 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkflowRealTimeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workflows/{Sid} className: workflow_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1WorkflowStatistics parameters: - name: WorkspaceSid in: path @@ -5934,6 +7957,9 @@ paths: trends. schema: type: integer + examples: + fetch: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -5941,6 +7967,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: EndDate in: query description: Only calculate statistics from this date and time and earlier, @@ -5949,6 +7978,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: TaskChannel in: query description: Only calculate real-time statistics on this TaskChannel. Can @@ -5973,35 +8005,92 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow.workflow_statistics' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + cumulative: + avg_task_acceptance_time: 0.0 + end_time: '2008-01-02T00:00:00Z' + reservations_accepted: 0 + reservations_rejected: 0 + reservations_timed_out: 0 + start_time: '2008-01-02T00:00:00Z' + tasks_canceled: 0 + tasks_entered: 0 + tasks_moved: 0 + tasks_timed_out_in_workflow: 0 + realtime: + longest_task_waiting_age: 0 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + assigned: 1 + pending: 0 + reserved: 0 + wrapping: 0 + total_tasks: 1 + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkflowStatistics - x-maturity: - - GA /v1/Workspaces/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - prioritize_queue_order - pathType: instance dependentProperties: - activity: '{workspace_sid: sid}' - event: '{workspace_sid: sid}' - task: '{workspace_sid: sid}' - task_queue: '{workspace_sid: sid}' - worker: '{workspace_sid: sid}' - workflow: '{workspace_sid: sid}' - workspace_statistics: '{workspace_sid: sid}' - workspace_real_time_statistics: '{workspace_sid: sid}' - workspace_cumulative_statistics: '{workspace_sid: sid}' - task_channel: '{workspace_sid: sid}' + activities: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Activities + events: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Events + tasks: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Tasks + task_queues: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues + workers: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers + workflows: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workflows + statistics: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Statistics + real_time_statistics: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/RealTimeStatistics + cumulative_statistics: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/CumulativeStatistics + task_channels: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/TaskChannels + pathType: instance get: description: '' + tags: + - TaskrouterV1Workspace parameters: - name: Sid in: path @@ -6018,14 +8107,43 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + default_activity_name: Offline + default_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_callback_url: '' + events_filter: null + friendly_name: new + links: + activities: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + task_queues: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues + tasks: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + workers: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers + workflows: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows + task_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels + events: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events + multi_task_enabled: false + prioritize_queue_order: FIFO + sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + timeout_activity_name: Offline + timeout_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkspace - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Workspace parameters: - name: Sid in: path @@ -6042,12 +8160,39 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + default_activity_name: Offline + default_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_callback_url: '' + events_filter: null + friendly_name: new + links: + activities: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + task_queues: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues + tasks: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + workers: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers + workflows: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows + task_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels + events: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events + multi_task_enabled: false + prioritize_queue_order: FIFO + sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + timeout_activity_name: Offline + timeout_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateWorkspace - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6106,8 +8251,17 @@ paths: description: 'The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO`. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).' + examples: + update: + value: + DefaultActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + EventCallbackUrl: /example + FriendlyName: friendly_name + TimeoutActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: '' + tags: + - TaskrouterV1Workspace parameters: - name: Sid in: path @@ -6124,31 +8278,61 @@ paths: security: - accountSid_authToken: [] operationId: DeleteWorkspace - x-maturity: - - GA /v1/Workspaces: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - prioritize_queue_order - pathType: list dependentProperties: - activity: '{workspace_sid: sid}' - event: '{workspace_sid: sid}' - task: '{workspace_sid: sid}' - task_queue: '{workspace_sid: sid}' - worker: '{workspace_sid: sid}' - workflow: '{workspace_sid: sid}' - workspace_statistics: '{workspace_sid: sid}' - workspace_real_time_statistics: '{workspace_sid: sid}' - workspace_cumulative_statistics: '{workspace_sid: sid}' - task_channel: '{workspace_sid: sid}' + activities: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Activities + events: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Events + tasks: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Tasks + task_queues: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues + workers: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workers + workflows: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Workflows + statistics: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/Statistics + real_time_statistics: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/RealTimeStatistics + cumulative_statistics: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/CumulativeStatistics + task_channels: + mapping: + workspace_sid: sid + resource_url: /v1/Workspaces/{workspace_sid}/TaskChannels + pathType: list get: description: '' + tags: + - TaskrouterV1Workspace parameters: - name: FriendlyName in: query @@ -6156,6 +8340,15 @@ paths: `Customer Support` or `2014 Election Campaign`. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6188,48 +8381,124 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0 + key: workspaces + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0 + workspaces: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + default_activity_name: Offline + default_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_callback_url: '' + events_filter: null + friendly_name: new + links: + activities: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + task_queues: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues + tasks: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + workers: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers + workflows: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows + task_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels + events: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events + multi_task_enabled: false + prioritize_queue_order: FIFO + sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + timeout_activity_name: Offline + timeout_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0 + key: workspaces + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0 + workspaces: [] description: OK security: - accountSid_authToken: [] operationId: ListWorkspace - x-maturity: - - GA post: description: '' + tags: + - TaskrouterV1Workspace responses: '201': content: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + default_activity_name: Offline + default_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_callback_url: '' + events_filter: null + friendly_name: new + links: + activities: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + task_queues: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues + tasks: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + workers: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers + workflows: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows + task_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels + events: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events + multi_task_enabled: false + prioritize_queue_order: FIFO + sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + timeout_activity_name: Offline + timeout_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateWorkspace - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6284,21 +8553,29 @@ paths: [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).' required: - FriendlyName + examples: + create: + value: + EventCallbackUrl: /example + FriendlyName: friendly_name + Template: template /v1/Workspaces/{WorkspaceSid}/CumulativeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - start_time - end_time - avg_task_acceptance_time - tasks_completed - pathType: instance parent: /Workspaces/{Sid} className: workspace_cumulative_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1WorkspaceCumulativeStatistics parameters: - name: WorkspaceSid in: path @@ -6316,6 +8593,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. @@ -6331,6 +8611,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: TaskChannel in: query description: Only calculate cumulative statistics on this TaskChannel. Can @@ -6356,26 +8639,72 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workspace_cumulative_statistics' + examples: + fetch: + value: + reservations_accepted: 100 + tasks_completed: 100 + start_time: '2015-07-30T20:00:00Z' + reservations_rescinded: 100 + tasks_timed_out_in_workflow: 100 + end_time: '2015-07-30T20:00:00Z' + avg_task_acceptance_time: 100 + tasks_canceled: 100 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + tasks_moved: 100 + tasks_deleted: 100 + tasks_created: 100 + reservations_canceled: 100 + reservations_timed_out: 100 + wait_duration_until_canceled: + avg: 0 + min: 0 + max: 0 + total: 0 + wait_duration_until_accepted: + avg: 0 + min: 0 + max: 0 + total: 0 + split_by_wait_time: + '5': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + '10': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + reservations_created: 100 + reservations_rejected: 100 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkspaceCumulativeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/RealTimeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - longest_task_waiting_age - longest_task_waiting_sid - total_tasks - pathType: instance parent: /Workspaces/{Sid} className: workspace_real_time_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1WorkspaceRealTimeStatistics parameters: - name: WorkspaceSid in: path @@ -6393,30 +8722,58 @@ paths: `default`. schema: type: string + examples: + fetch: + value: voice responses: '200': content: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workspace_real_time_statistics' + examples: + fetch: + value: + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + tasks_by_priority: {} + activity_statistics: + - friendly_name: Idle + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Busy + workers: 9 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Offline + workers: 6 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Reserved + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + longest_task_waiting_age: 100 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + total_workers: 100 + total_tasks: 100 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: {} description: OK security: - accountSid_authToken: [] operationId: FetchWorkspaceRealTimeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: instance parent: /Workspaces/{Sid} className: workspace_statistics + pathType: instance get: description: '' + tags: + - TaskrouterV1WorkspaceStatistics parameters: - name: WorkspaceSid in: path @@ -6435,6 +8792,9 @@ paths: trends. schema: type: integer + examples: + fetch: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -6442,6 +8802,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: EndDate in: query description: Only calculate statistics from this date and time and earlier, @@ -6450,6 +8813,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: TaskChannel in: query description: Only calculate statistics on this TaskChannel. Can be the TaskChannel's @@ -6473,14 +8839,88 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workspace_statistics' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + cumulative: + avg_task_acceptance_time: 0.0 + start_time: '2008-01-02T00:00:00Z' + reservations_accepted: 0 + reservations_canceled: 0 + reservations_created: 0 + reservations_rejected: 0 + reservations_rescinded: 0 + reservations_timed_out: 0 + end_time: '2008-01-02T00:00:00Z' + tasks_canceled: 0 + tasks_created: 0 + tasks_deleted: 0 + tasks_moved: 0 + tasks_timed_out_in_workflow: 0 + realtime: + activity_statistics: + - friendly_name: Offline + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 1 + - friendly_name: Idle + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Reserved + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Busy + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + longest_task_waiting_age: 0 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + assigned: 0 + pending: 0 + reserved: 0 + wrapping: 0 + total_tasks: 0 + total_workers: 1 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkspaceStatistics - x-maturity: - - GA servers: - url: https://taskrouter.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: TaskrouterV1Activity +- name: TaskrouterV1Event +- name: TaskrouterV1OperatingUnit +- name: TaskrouterV1Reservation +- name: TaskrouterV1Task +- name: TaskrouterV1TaskChannel +- name: TaskrouterV1TaskQueue +- name: TaskrouterV1TaskQueueBulkRealTimeStatistics +- name: TaskrouterV1TaskQueueCumulativeStatistics +- name: TaskrouterV1TaskQueueRealTimeStatistics +- name: TaskrouterV1TaskQueueStatistics +- name: TaskrouterV1TaskQueuesStatistics +- name: TaskrouterV1Worker +- name: TaskrouterV1WorkerChannel +- name: TaskrouterV1WorkerStatistics +- name: TaskrouterV1WorkersCumulativeStatistics +- name: TaskrouterV1WorkersRealTimeStatistics +- name: TaskrouterV1WorkersStatistics +- name: TaskrouterV1Workflow +- name: TaskrouterV1WorkflowCumulativeStatistics +- name: TaskrouterV1WorkflowRealTimeStatistics +- name: TaskrouterV1WorkflowStatistics +- name: TaskrouterV1Workspace +- name: TaskrouterV1WorkspaceCumulativeStatistics +- name: TaskrouterV1WorkspaceRealTimeStatistics +- name: TaskrouterV1WorkspaceStatistics +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index 27534bba..25f15dd6 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: trunking.v1.trunk.credential_list: type: object @@ -138,6 +142,10 @@ components: nullable: true description: The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true @@ -215,6 +223,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 links: type: object format: uri-map @@ -446,6 +458,10 @@ components: URL. We retrieve TwiML from this URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true @@ -540,10 +556,6 @@ components: enum: - from-transferee - from-transferor - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Trunking description: This is the public Twilio REST API. @@ -555,7 +567,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Trunks/{TrunkSid}/CredentialLists/{Sid}: @@ -567,12 +579,14 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Trunks/{Sid} mountName: credentials_lists className: credential_list + pathType: instance get: description: '' + tags: + - TrunkingV1CredentialList parameters: - name: TrunkSid in: path @@ -599,14 +613,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.credential_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-04-28T00:10:23Z' + date_updated: '2018-04-28T00:10:23Z' + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredentialList - x-maturity: - - GA delete: description: '' + tags: + - TrunkingV1CredentialList parameters: - name: TrunkSid in: path @@ -633,8 +657,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredentialList - x-maturity: - - GA /v1/Trunks/{TrunkSid}/CredentialLists: servers: - url: https://trunking.twilio.com @@ -644,12 +666,14 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Trunks/{Sid} mountName: credentials_lists className: credential_list + pathType: list post: description: '' + tags: + - TrunkingV1CredentialList parameters: - name: TrunkSid in: path @@ -666,12 +690,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.credential_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-02T17:29:30Z' + date_updated: '2018-05-02T17:29:30Z' + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredentialList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -689,8 +721,14 @@ paths: will authenticate access to the trunk against this list. required: - CredentialListSid + examples: + create: + value: + CredentialListSid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - TrunkingV1CredentialList parameters: - name: TrunkSid in: path @@ -733,34 +771,62 @@ paths: items: $ref: '#/components/schemas/trunking.v1.trunk.credential_list' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credential_lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-04-27T22:02:11Z' + date_updated: '2018-04-27T22:02:11Z' + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0 + next_page_url: null + key: credential_lists + readEmpty: + value: + credential_lists: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0 + next_page_url: null + key: credential_lists description: OK security: - accountSid_authToken: [] operationId: ListCredentialList - x-maturity: - - GA /v1/Trunks/{TrunkSid}/IpAccessControlLists/{Sid}: servers: - url: https://trunking.twilio.com @@ -770,10 +836,12 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Trunks/{Sid} + pathType: instance get: description: '' + tags: + - TrunkingV1IpAccessControlList parameters: - name: TrunkSid in: path @@ -801,14 +869,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.ip_access_control_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-02T17:29:34Z' + date_updated: '2018-05-02T17:29:34Z' + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchIpAccessControlList - x-maturity: - - GA delete: description: Remove an associated IP Access Control List from a Trunk + tags: + - TrunkingV1IpAccessControlList parameters: - name: TrunkSid in: path @@ -836,8 +914,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteIpAccessControlList - x-maturity: - - GA /v1/Trunks/{TrunkSid}/IpAccessControlLists: servers: - url: https://trunking.twilio.com @@ -847,10 +923,12 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Trunks/{Sid} + pathType: list post: description: Associate an IP Access Control List with a Trunk + tags: + - TrunkingV1IpAccessControlList parameters: - name: TrunkSid in: path @@ -868,12 +946,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.ip_access_control_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-04-30T20:59:06Z' + date_updated: '2018-04-30T20:59:06Z' + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateIpAccessControlList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -890,8 +976,14 @@ paths: that you want to associate with the trunk. required: - IpAccessControlListSid + examples: + create: + value: + IpAccessControlListSid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: List all IP Access Control Lists for a Trunk + tags: + - TrunkingV1IpAccessControlList parameters: - name: TrunkSid in: path @@ -935,34 +1027,62 @@ paths: items: $ref: '#/components/schemas/trunking.v1.trunk.ip_access_control_list' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + ip_access_control_lists: [] + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0 + key: ip_access_control_lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0 + readFull: + value: + ip_access_control_lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-02T17:29:34Z' + date_updated: '2018-05-02T17:29:34Z' + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0 + key: ip_access_control_lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIpAccessControlList - x-maturity: - - GA /v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}: servers: - url: https://trunking.twilio.com @@ -974,10 +1094,12 @@ paths: - sip_url - priority - weight - pathType: instance parent: /Trunks/{Sid} + pathType: instance get: description: '' + tags: + - TrunkingV1OriginationUrl parameters: - name: TrunkSid in: path @@ -1004,14 +1126,28 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.origination_url' + examples: + fetch: + value: + weight: 1 + date_updated: '2018-05-07T20:20:46Z' + enabled: false + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + priority: 1 + sip_url: sip://sip-box.com:1234 + sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-07T20:20:46Z' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchOriginationUrl - x-maturity: - - GA delete: description: '' + tags: + - TrunkingV1OriginationUrl parameters: - name: TrunkSid in: path @@ -1038,10 +1174,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteOriginationUrl - x-maturity: - - GA post: description: '' + tags: + - TrunkingV1OriginationUrl parameters: - name: TrunkSid in: path @@ -1068,12 +1204,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.origination_url' + examples: + update: + value: + weight: 2 + date_updated: '2018-05-07T20:50:58Z' + enabled: false + friendly_name: updated_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + priority: 2 + sip_url: sip://sip-updated.com:4321 + sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-07T20:50:58Z' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateOriginationUrl - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1105,6 +1253,14 @@ paths: format: uri description: The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. `sips` is NOT supported. + examples: + update: + value: + FriendlyName: updated_name + Weight: 2 + Priority: 2 + SipUrl: sip://sip-updated.com:4321 + Enabled: false /v1/Trunks/{TrunkSid}/OriginationUrls: servers: - url: https://trunking.twilio.com @@ -1116,10 +1272,12 @@ paths: - sip_url - priority - weight - pathType: list parent: /Trunks/{Sid} + pathType: list post: description: '' + tags: + - TrunkingV1OriginationUrl parameters: - name: TrunkSid in: path @@ -1136,12 +1294,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.origination_url' + examples: + create: + value: + weight: 1 + date_updated: '2018-05-07T20:50:58Z' + enabled: true + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + priority: 1 + sip_url: sip://sip-box.com:1234 + sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-07T20:50:58Z' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateOriginationUrl - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1179,8 +1349,18 @@ paths: - Enabled - FriendlyName - SipUrl + examples: + create: + value: + Enabled: true + FriendlyName: friendly_name + Priority: 1 + Weight: 1 + SipUrl: sip://sip-box.com:1234 get: description: '' + tags: + - TrunkingV1OriginationUrl parameters: - name: TrunkSid in: path @@ -1223,34 +1403,66 @@ paths: items: $ref: '#/components/schemas/trunking.v1.trunk.origination_url' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0 + key: origination_urls + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0 + origination_urls: + - weight: 1 + date_updated: '2018-05-09T20:47:35Z' + enabled: true + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + priority: 1 + sip_url: sip://sip-box.com:1234 + sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-09T20:47:35Z' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0 + key: origination_urls + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0 + origination_urls: [] description: OK security: - accountSid_authToken: [] operationId: ListOriginationUrl - x-maturity: - - GA /v1/Trunks/{TrunkSid}/PhoneNumbers/{Sid}: servers: - url: https://trunking.twilio.com @@ -1260,10 +1472,12 @@ paths: - sid - friendly_name - phone_number - pathType: instance parent: /Trunks/{Sid} + pathType: instance get: description: '' + tags: + - TrunkingV1PhoneNumber parameters: - name: TrunkSid in: path @@ -1290,14 +1504,47 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.phone_number' + examples: + fetch: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-12-10T17:27:34Z' + date_updated: '2015-10-09T11:36:32Z' + friendly_name: (415) 867-5309 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+14158675309' + api_version: '2010-04-01' + voice_caller_id_lookup: null + voice_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call + voice_method: POST + voice_fallback_url: null + voice_fallback_method: null + status_callback: '' + status_callback_method: POST + voice_application_sid: '' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message + sms_method: POST + sms_fallback_url: '' + sms_fallback_method: POST + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + beta: false + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + capabilities: + voice: true + sms: true + mms: true + links: + phone_number: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - GA delete: description: '' + tags: + - TrunkingV1PhoneNumber parameters: - name: TrunkSid in: path @@ -1324,8 +1571,6 @@ paths: security: - accountSid_authToken: [] operationId: DeletePhoneNumber - x-maturity: - - GA /v1/Trunks/{TrunkSid}/PhoneNumbers: servers: - url: https://trunking.twilio.com @@ -1335,10 +1580,12 @@ paths: - sid - friendly_name - phone_number - pathType: list parent: /Trunks/{Sid} + pathType: list post: description: '' + tags: + - TrunkingV1PhoneNumber parameters: - name: TrunkSid in: path @@ -1355,12 +1602,43 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.phone_number' + examples: + create: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-12-10T17:27:34Z' + date_updated: '2015-10-09T11:36:32Z' + friendly_name: (415) 867-5309 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+14158675309' + api_version: '2010-04-01' + voice_caller_id_lookup: null + voice_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call + voice_method: POST + voice_fallback_url: null + voice_fallback_method: null + status_callback: '' + status_callback_method: POST + voice_application_sid: '' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message + sms_method: POST + sms_fallback_url: '' + sms_fallback_method: POST + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + beta: false + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + capabilities: + voice: true + sms: true + mms: true + links: + phone_number: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreatePhoneNumber - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1377,8 +1655,14 @@ paths: that you want to associate with the trunk. required: - PhoneNumberSid + examples: + create: + value: + PhoneNumberSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - TrunkingV1PhoneNumber parameters: - name: TrunkSid in: path @@ -1421,34 +1705,85 @@ paths: items: $ref: '#/components/schemas/trunking.v1.trunk.phone_number' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0 + key: phone_numbers + next_page_url: null + page: 0 + page_size: 1 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0 + phone_numbers: + - sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-12-10T17:27:34Z' + date_updated: '2015-10-09T11:36:32Z' + friendly_name: (415) 867-5309 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+14158675309' + api_version: '2010-04-01' + voice_caller_id_lookup: null + voice_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call + voice_method: POST + voice_fallback_url: null + voice_fallback_method: null + status_callback: '' + status_callback_method: POST + voice_application_sid: '' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message + sms_method: POST + sms_fallback_url: '' + sms_fallback_method: POST + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + beta: false + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + capabilities: + voice: true + sms: true + mms: true + links: + phone_number: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + readEmpty: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0 + key: phone_numbers + next_page_url: null + page: 0 + page_size: 1 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0 + phone_numbers: [] description: OK security: - accountSid_authToken: [] operationId: ListPhoneNumber - x-maturity: - - GA /v1/Trunks/{TrunkSid}/Recording: servers: - url: https://trunking.twilio.com @@ -1457,11 +1792,13 @@ paths: defaultOutputProperties: - mode - trim - pathType: instance parent: /Trunks/{Sid} mountName: recordings + pathType: instance get: description: '' + tags: + - TrunkingV1Recording parameters: - name: TrunkSid in: path @@ -1478,14 +1815,19 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.recording' + examples: + fetch: + value: + mode: do-not-record + trim: do-not-trim description: OK security: - accountSid_authToken: [] operationId: FetchRecording - x-maturity: - - GA post: description: '' + tags: + - TrunkingV1Recording parameters: - name: TrunkSid in: path @@ -1502,12 +1844,15 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.recording' + examples: + update: + value: + mode: do-not-record + trim: do-not-trim description: Accepted security: - accountSid_authToken: [] operationId: UpdateRecording - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1526,6 +1871,11 @@ paths: $ref: '#/components/schemas/recording_enum_recording_trim' description: The recording trim setting for the trunk. Can be do-not-trim (default) or trim-silence. + examples: + update: + value: + Mode: do-not-record + Trim: do-not-trim /v1/Trunks/{Sid}: servers: - url: https://trunking.twilio.com @@ -1535,15 +1885,32 @@ paths: - sid - friendly_name - domain_name - pathType: instance dependentProperties: - origination_url: '{trunk_sid: sid}' - credential_list: '{trunk_sid: sid}' - ip_access_control_list: '{trunk_sid: sid}' - phone_number: '{trunk_sid: sid}' - recording: '{trunk_sid: sid}' + origination_urls: + mapping: + trunk_sid: sid + resource_url: /v1/Trunks/{trunk_sid}/OriginationUrls + credentials_lists: + mapping: + trunk_sid: sid + resource_url: /v1/Trunks/{trunk_sid}/CredentialLists + ip_access_control_lists: + mapping: + trunk_sid: sid + resource_url: /v1/Trunks/{trunk_sid}/IpAccessControlLists + phone_numbers: + mapping: + trunk_sid: sid + resource_url: /v1/Trunks/{trunk_sid}/PhoneNumbers + recordings: + mapping: + trunk_sid: sid + resource_url: /v1/Trunks/{trunk_sid}/Recording + pathType: instance get: description: '' + tags: + - TrunkingV1Trunk parameters: - name: Sid in: path @@ -1561,14 +1928,40 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk' + examples: + fetch: + value: + sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: test.pstn.twilio.com + disaster_recovery_method: POST + disaster_recovery_url: http://disaster-recovery.com + friendly_name: friendly_name + secure: false + cnam_lookup_enabled: false + recording: + mode: do-not-record + trim: do-not-trim + transfer_mode: disable-all + transfer_caller_id: from-transferor + auth_type: '' + auth_type_set: [] + date_created: '2015-01-02T11:23:45Z' + date_updated: '2015-01-02T11:23:45Z' + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + origination_urls: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls + credential_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists + ip_access_control_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists + phone_numbers: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers description: OK security: - accountSid_authToken: [] operationId: FetchTrunk - x-maturity: - - GA delete: description: '' + tags: + - TrunkingV1Trunk parameters: - name: Sid in: path @@ -1586,10 +1979,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTrunk - x-maturity: - - GA post: description: '' + tags: + - TrunkingV1Trunk parameters: - name: Sid in: path @@ -1607,12 +2000,36 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk' + examples: + update: + value: + sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: test.pstn.twilio.com + disaster_recovery_method: GET + disaster_recovery_url: http://updated-recovery.com + friendly_name: updated_name + secure: true + cnam_lookup_enabled: true + recording: + mode: do-not-record + trim: do-not-trim + transfer_mode: disable-all + transfer_caller_id: from-transferor + auth_type: '' + auth_type_set: [] + date_created: '2015-01-02T11:23:45Z' + date_updated: '2015-01-02T11:23:45Z' + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + origination_urls: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls + credential_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists + ip_access_control_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists + phone_numbers: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers description: OK security: - accountSid_authToken: [] operationId: UpdateTrunk - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1676,6 +2093,16 @@ paths: $ref: '#/components/schemas/trunk_enum_transfer_caller_id' description: 'Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`.' + examples: + update: + value: + FriendlyName: updated_name + DisasterRecoveryMethod: GET + DisasterRecoveryUrl: http://updated-recovery.com + Secure: true + TransferMode: disable-all + TransferCallerId: from-transferor + CnamLookupEnabled: true /v1/Trunks: servers: - url: https://trunking.twilio.com @@ -1685,27 +2112,68 @@ paths: - sid - friendly_name - domain_name - pathType: list dependentProperties: - origination_url: '{trunk_sid: sid}' - credential_list: '{trunk_sid: sid}' - ip_access_control_list: '{trunk_sid: sid}' - phone_number: '{trunk_sid: sid}' - recording: '{trunk_sid: sid}' + origination_urls: + mapping: + trunk_sid: sid + resource_url: /v1/Trunks/{trunk_sid}/OriginationUrls + credentials_lists: + mapping: + trunk_sid: sid + resource_url: /v1/Trunks/{trunk_sid}/CredentialLists + ip_access_control_lists: + mapping: + trunk_sid: sid + resource_url: /v1/Trunks/{trunk_sid}/IpAccessControlLists + phone_numbers: + mapping: + trunk_sid: sid + resource_url: /v1/Trunks/{trunk_sid}/PhoneNumbers + recordings: + mapping: + trunk_sid: sid + resource_url: /v1/Trunks/{trunk_sid}/Recording + pathType: list post: description: '' + tags: + - TrunkingV1Trunk responses: '201': content: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk' + examples: + create: + value: + sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: test.pstn.twilio.com + disaster_recovery_method: POST + disaster_recovery_url: http://disaster-recovery.com + friendly_name: friendly_name + secure: false + cnam_lookup_enabled: false + recording: + mode: do-not-record + trim: do-not-trim + transfer_mode: disable-all + transfer_caller_id: from-transferee + auth_type: '' + auth_type_set: [] + date_created: '2015-01-02T11:23:45Z' + date_updated: '2015-01-02T11:23:45Z' + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + origination_urls: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls + credential_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists + ip_access_control_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists + phone_numbers: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers description: Created security: - accountSid_authToken: [] operationId: CreateTrunk - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1769,8 +2237,21 @@ paths: $ref: '#/components/schemas/trunk_enum_transfer_caller_id' description: 'Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`.' + examples: + create: + value: + DomainName: test.pstn.twilio.com + FriendlyName: friendly_name + DisasterRecoveryMethod: GET + DisasterRecoveryUrl: http://disaster-recovery.com + TransferMode: disable-all + TransferCallerId: from-transferee + Secure: false + CnamLookupEnabled: false get: description: '' + tags: + - TrunkingV1Trunk parameters: - name: PageSize in: query @@ -1804,36 +2285,86 @@ paths: items: $ref: '#/components/schemas/trunking.v1.trunk' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0 + url: https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0 + page_size: 50 + key: trunks + next_page_url: null + page: 0 + previous_page_url: null + trunks: + - sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: test.pstn.twilio.com + disaster_recovery_method: POST + disaster_recovery_url: http://disaster-recovery.com + friendly_name: friendly_name + secure: false + cnam_lookup_enabled: false + recording: + mode: do-not-record + trim: do-not-trim + transfer_mode: disable-all + transfer_caller_id: from-transferee + auth_type: '' + auth_type_set: [] + date_created: '2015-01-02T11:23:45Z' + date_updated: '2015-01-02T11:23:45Z' + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + origination_urls: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls + credential_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists + ip_access_control_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists + phone_numbers: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + readEmpty: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0 + url: https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0 + page_size: 50 + key: trunks + next_page_url: null + page: 0 + previous_page_url: null + trunks: [] description: OK security: - accountSid_authToken: [] operationId: ListTrunk - x-maturity: - - GA servers: - url: https://trunking.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: TrunkingV1CredentialList +- name: TrunkingV1IpAccessControlList +- name: TrunkingV1OriginationUrl +- name: TrunkingV1PhoneNumber +- name: TrunkingV1Recording +- name: TrunkingV1Trunk +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_trusthub_v1.yaml b/spec/yaml/twilio_trusthub_v1.yaml index ea16ee84..ef22747e 100644 --- a/spec/yaml/twilio_trusthub_v1.yaml +++ b/spec/yaml/twilio_trusthub_v1.yaml @@ -1,5 +1,119 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: + trusthub.v1.compliance_inquiry: + type: object + properties: + inquiry_id: + type: string + nullable: true + description: The unique ID used to start an embedded compliance registration + session. + inquiry_session_token: + type: string + nullable: true + description: The session token used to start an embedded compliance registration + session. + customer_id: + type: string + nullable: true + description: The CustomerID matching the Customer Profile that should be + resumed or resubmitted for editing. + url: + type: string + format: uri + nullable: true + description: The URL of this resource. + trusthub.v1.compliance_registration: + type: object + properties: + inquiry_id: + type: string + nullable: true + description: The unique ID used to start an embedded compliance registration + session. + inquiry_session_token: + type: string + nullable: true + description: The session token used to start an embedded compliance registration + session. + registration_id: + type: string + nullable: true + description: The RegistrationId matching the Registration Profile that should + be resumed or resubmitted for editing. + url: + type: string + format: uri + nullable: true + description: The URL of this resource. + compliance_registration_enum_end_user_type: + type: string + enum: + - Individual + - Business + compliance_registration_enum_phone_number_type: + type: string + enum: + - local + - national + - mobile + - toll-free + compliance_registration_enum_business_identity_type: + type: string + enum: + - direct_customer + - isv_reseller_or_partner + - unknown + compliance_registration_enum_business_registration_authority: + type: string + enum: + - UK:CRN + - US:EIN + - CA:CBN + - AU:ACN + - Other + trusthub.v1.compliance_tollfree_inquiry: + type: object + properties: + inquiry_id: + type: string + nullable: true + description: The unique ID used to start an embedded compliance registration + session. + inquiry_session_token: + type: string + nullable: true + description: The session token used to start an embedded compliance registration + session. + registration_id: + type: string + nullable: true + description: The TolfreeId matching the Tollfree Profile that should be + resumed or resubmitted for editing. + url: + type: string + format: uri + nullable: true + description: The URL of this resource. + compliance_tollfree_inquiry_enum_status: + type: string + enum: + - PENDING_REVIEW + - IN_REVIEW + - TWILIO_APPROVED + - TWILIO_REJECTED + compliance_tollfree_inquiry_enum_opt_in_type: + type: string + enum: + - VERBAL + - WEB_FORM + - PAPER_FORM + - VIA_TEXT + - MOBILE_QR_CODE trusthub.v1.customer_profile: type: object properties: @@ -272,6 +386,10 @@ components: nullable: true description: The set of parameters that are the attributes of the End Users resource which are listed in the End User Types. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -390,6 +508,10 @@ components: nullable: true description: The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -689,10 +811,6 @@ components: enum: - compliant - noncompliant - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Trusthub description: This is the public Twilio REST API. @@ -704,38 +822,579 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: + /v1/ComplianceInquiries/Customers/Initialize: + servers: + - url: https://trusthub.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - inquiry_id + - session_token + - customer_id + mountName: 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. + tags: + - TrusthubV1ComplianceInquiries + responses: + '201': + content: + 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 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateComplianceInquiry + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateComplianceInquiryRequest + properties: + PrimaryProfileSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BU[0-9a-fA-F]{32}$ + description: The unique SID identifier of the Primary Customer Profile + that should be used as a parent. Only necessary when creating + a secondary Customer Profile. + NotificationEmail: + type: string + description: The email address that approval status updates will + be sent to. If not specified, the email address associated with + your primary customer profile will be used. + required: + - PrimaryProfileSid + examples: + create: + value: + PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithNotificationEmail: + value: + PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + NotificationEmail: pfarnsworth@twilio.com + /v1/ComplianceInquiries/Customers/{CustomerId}/Initialize: + servers: + - url: https://trusthub.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - inquiry_id + - session_token + - customer_id + mountName: 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. + tags: + - TrusthubV1ComplianceInquiries + parameters: + - name: CustomerId + in: path + description: The unique CustomerId matching the Customer Profile/Compliance + Inquiry that should be resumed or resubmitted. This value will have been + returned by the initial Compliance Inquiry creation call. + schema: + type: string + required: true + responses: + '200': + content: + 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 + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateComplianceInquiry + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateComplianceInquiryRequest + properties: + PrimaryProfileSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BU[0-9a-fA-F]{32}$ + description: The unique SID identifier of the Primary Customer Profile + that should be used as a parent. Only necessary when creating + a secondary Customer Profile. + required: + - PrimaryProfileSid + examples: + update: + value: + PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize: + servers: + - url: https://trusthub.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - inquiry_id + - session_token + - registration_id + mountName: 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. + tags: + - TrusthubV1ComplianceRegistrationInquiries + responses: + '201': + content: + 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.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registartion.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize + description: Created + security: + - accountSid_authToken: [] + operationId: CreateComplianceRegistration + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateComplianceRegistrationRequest + properties: + EndUserType: + type: string + $ref: '#/components/schemas/compliance_registration_enum_end_user_type' + description: The type of End User the regulation requires - can + be `Individual` or `Business`. + PhoneNumberType: + type: string + $ref: '#/components/schemas/compliance_registration_enum_phone_number_type' + description: The type of phone number of the Bundle's ownership + request. Can be `local`, `mobile`, `national`, or `toll-free`. + BusinessIdentityType: + type: string + $ref: '#/components/schemas/compliance_registration_enum_business_identity_type' + description: The type of business identity. Can be `direct customer` + or `ISV`. + BusinessRegistrationAuthority: + type: string + $ref: '#/components/schemas/compliance_registration_enum_business_registration_authority' + description: The authority that registered the business + BusinessLegalName: + type: string + description: he name of the business or organization using the Tollfree + number. + NotificationEmail: + type: string + description: he email address to receive the notification about + the verification result. + AcceptedNotificationReceipt: + type: boolean + description: The email address to receive the notification about + the verification result. + BusinessRegistrationNumber: + type: string + description: Business registration number of the business + BusinessWebsiteUrl: + type: string + description: The URL of the business website + FriendlyName: + type: string + description: Friendly name for your business information + AuthorizedRepresentative1FirstName: + type: string + description: First name of the authorized representative + AuthorizedRepresentative1LastName: + type: string + description: Last name of the authorized representative + AuthorizedRepresentative1Phone: + type: string + description: Phone number of the authorized representative + AuthorizedRepresentative1Email: + type: string + description: Email address of the authorized representative + AuthorizedRepresentative1DateOfBirth: + type: string + description: Birthdate of the authorized representative + AddressStreet: + type: string + description: Street address of the business + AddressStreetSecondary: + type: string + description: Street address of the business + AddressCity: + type: string + description: City of the business + AddressSubdivision: + type: string + description: State or province of the business + AddressPostalCode: + type: string + description: Postal code of the business + AddressCountryCode: + type: string + description: Country code of the business + EmergencyAddressStreet: + type: string + description: Street address of the business + EmergencyAddressStreetSecondary: + type: string + description: Street address of the business + EmergencyAddressCity: + type: string + description: City of the business + EmergencyAddressSubdivision: + type: string + description: State or province of the business + EmergencyAddressPostalCode: + type: string + description: Postal code of the business + EmergencyAddressCountryCode: + type: string + description: Country code of the business + UseAddressAsEmergencyAddress: + type: boolean + description: Use the business address as the emergency address + FileName: + type: string + description: The name of the verification document to upload + File: + type: string + description: The verification document to upload + FirstName: + type: string + description: The first name of the Individual User. + LastName: + type: string + description: The last name of the Individual User. + DateOfBirth: + type: string + description: The date of birth of the Individual User. + IndividualEmail: + type: string + description: The email address of the Individual User. + IndividualPhone: + type: string + description: The phone number of the Individual User. + IsIsvEmbed: + type: boolean + description: Indicates if the inquiry is being started from an ISV + embedded component. + IsvRegisteringForSelfOrTenant: + type: string + description: Indicates if the isv registering for self or tenant. + StatusCallbackUrl: + type: string + description: The url we call to inform you of bundle changes. + required: + - 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 + /v1/ComplianceInquiries/Tollfree/Initialize: + servers: + - url: https://trusthub.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - inquiry_id + - session_token + - registration_id + mountName: 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. + tags: + - TrusthubV1ComplianceTollfreeInquiries + responses: + '201': + content: + 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 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateComplianceTollfreeInquiry + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateComplianceTollfreeInquiryRequest + properties: + TollfreePhoneNumber: + type: string + format: phone-number + description: The Tollfree phone number to be verified + NotificationEmail: + type: string + description: The email address to receive the notification about + the verification result. + BusinessName: + type: string + description: The name of the business or organization using the + Tollfree number. + BusinessWebsite: + type: string + description: The website of the business or organization using the + Tollfree number. + UseCaseCategories: + type: array + items: + type: string + description: The category of the use case for the Tollfree Number. + List as many are applicable.. + UseCaseSummary: + type: string + description: Use this to further explain how messaging is used by + the business or organization. + ProductionMessageSample: + type: string + description: An example of message content, i.e. a sample message. + OptInImageUrls: + type: array + items: + type: string + description: Link to an image that shows the opt-in workflow. Multiple + images allowed and must be a publicly hosted URL. + OptInType: + type: string + $ref: '#/components/schemas/compliance_tollfree_inquiry_enum_opt_in_type' + description: Describe how a user opts-in to text messages. + MessageVolume: + type: string + description: Estimate monthly volume of messages from the Tollfree + Number. + BusinessStreetAddress: + type: string + description: The address of the business or organization using the + Tollfree number. + BusinessStreetAddress2: + type: string + description: The address of the business or organization using the + Tollfree number. + BusinessCity: + type: string + description: The city of the business or organization using the + Tollfree number. + BusinessStateProvinceRegion: + type: string + description: The state/province/region of the business or organization + using the Tollfree number. + BusinessPostalCode: + type: string + description: The postal code of the business or organization using + the Tollfree number. + BusinessCountry: + type: string + description: The country of the business or organization using the + Tollfree number. + AdditionalInformation: + type: string + description: Additional information to be provided for verification. + BusinessContactFirstName: + type: string + description: The first name of the contact for the business or organization + using the Tollfree number. + BusinessContactLastName: + type: string + description: The last name of the contact for the business or organization + using the Tollfree number. + BusinessContactEmail: + type: string + description: The email address of the contact for the business or + organization using the Tollfree number. + BusinessContactPhone: + type: string + format: phone-number + description: The phone number of the contact for the business or + organization using the Tollfree number. + 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 /v1/CustomerProfiles: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name - pathType: list dependentProperties: - customer_profiles_entity_assignments: '{customer_profile_sid: sid}' - customer_profiles_evaluations: '{customer_profile_sid: sid}' - customer_profiles_channel_endpoint_assignment: '{customer_profile_sid: sid}' + customer_profiles_entity_assignments: + mapping: + customer_profile_sid: sid + resource_url: /v1/CustomerProfiles/{customer_profile_sid}/EntityAssignments + customer_profiles_evaluations: + mapping: + customer_profile_sid: sid + resource_url: /v1/CustomerProfiles/{customer_profile_sid}/Evaluations + customer_profiles_channel_endpoint_assignment: + mapping: + customer_profile_sid: sid + resource_url: /v1/CustomerProfiles/{customer_profile_sid}/ChannelEndpointAssignments className: customer_profiles + pathType: list post: description: Create a new Customer-Profile. + tags: + - TrusthubV1CustomerProfiles responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile' + examples: + create: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfile - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -766,8 +1425,17 @@ paths: - FriendlyName - Email - PolicySid + examples: + create: + value: + FriendlyName: friendly_name + Email: email + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + StatusCallback: http://www.example.com get: description: Retrieve a list of all Customer-Profiles for an account. + tags: + - TrusthubV1CustomerProfiles parameters: - name: Status in: query @@ -775,11 +1443,17 @@ paths: schema: type: string $ref: '#/components/schemas/customer_profile_enum_status' + examples: + readFull: + value: draft - name: FriendlyName in: query description: The string that you assigned to describe the resource. schema: type: string + examples: + readFull: + value: friendly_name - name: PolicySid in: query description: The unique string of a policy that is associated to the Customer-Profile @@ -789,6 +1463,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ + examples: + readFull: + value: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -821,51 +1498,98 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.customer_profile' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: 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 + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfile - x-maturity: - - GA /v1/CustomerProfiles/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name - pathType: instance dependentProperties: - customer_profiles_entity_assignments: '{customer_profile_sid: sid}' - customer_profiles_evaluations: '{customer_profile_sid: sid}' - customer_profiles_channel_endpoint_assignment: '{customer_profile_sid: sid}' + customer_profiles_entity_assignments: + mapping: + customer_profile_sid: sid + resource_url: /v1/CustomerProfiles/{customer_profile_sid}/EntityAssignments + customer_profiles_evaluations: + mapping: + customer_profile_sid: sid + resource_url: /v1/CustomerProfiles/{customer_profile_sid}/Evaluations + customer_profiles_channel_endpoint_assignment: + mapping: + customer_profile_sid: sid + resource_url: /v1/CustomerProfiles/{customer_profile_sid}/ChannelEndpointAssignments className: customer_profiles + pathType: instance get: description: Fetch a specific Customer-Profile instance. + tags: + - TrusthubV1CustomerProfiles parameters: - name: Sid in: path @@ -883,14 +1607,32 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile' + examples: + fetch: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + valid_until: null + email: email + status_callback: http://www.example.com + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfile - x-maturity: - - GA post: description: Updates a Customer-Profile in an account. + tags: + - TrusthubV1CustomerProfiles parameters: - name: Sid in: path @@ -908,12 +1650,45 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile' + examples: + update: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments + updateToInReview: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: in-review + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: OK security: - accountSid_authToken: [] operationId: UpdateCustomerProfile - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -937,8 +1712,20 @@ paths: type: string description: The email address that will receive updates when the Customer-Profile resource changes status. + examples: + update: + value: + Status: draft + StatusCallback: http://www.example.com + FriendlyName: friendly_name + Email: email + updateToInReview: + value: + Status: pending-review delete: description: Delete a specific Customer-Profile. + tags: + - TrusthubV1CustomerProfiles parameters: - name: Sid in: path @@ -956,20 +1743,20 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCustomerProfile - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /CustomerProfiles/{Sid} mountName: customer_profiles_channel_endpoint_assignment + pathType: list post: description: Create a new Assigned Item. + tags: + - TrusthubV1CustomerProfilesChannelEndpointAssignment parameters: - name: CustomerProfileSid in: path @@ -987,12 +1774,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment' + examples: + create: + value: + sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfileChannelEndpointAssignment - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1012,8 +1807,15 @@ paths: required: - ChannelEndpointType - ChannelEndpointSid + examples: + create: + value: + ChannelEndpointSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ChannelEndpointType: phone-number get: description: Retrieve a list of all Assigned Items for an account. + tags: + - TrusthubV1CustomerProfilesChannelEndpointAssignment parameters: - name: CustomerProfileSid in: path @@ -1033,6 +1835,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readFull: + value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: ChannelEndpointSids in: query description: comma separated list of channel endpoint sids @@ -1070,46 +1875,76 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfileChannelEndpointAssignment - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /CustomerProfiles/{Sid} mountName: customer_profiles_channel_endpoint_assignment + pathType: instance get: description: Fetch specific Assigned Item Instance. + tags: + - TrusthubV1CustomerProfilesChannelEndpointAssignment parameters: - name: CustomerProfileSid in: path @@ -1136,14 +1971,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment' + examples: + fetch: + value: + sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfileChannelEndpointAssignment - x-maturity: - - GA delete: description: Remove an Assignment Item Instance. + tags: + - TrusthubV1CustomerProfilesChannelEndpointAssignment parameters: - name: CustomerProfileSid in: path @@ -1170,21 +2015,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCustomerProfileChannelEndpointAssignment - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /CustomerProfiles/{Sid} mountName: customer_profiles_entity_assignments className: customer_profiles_entity_assignments + pathType: list post: description: Create a new Assigned Item. + tags: + - TrusthubV1CustomerProfilesEntityAssignments parameters: - name: CustomerProfileSid in: path @@ -1202,12 +2047,19 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment' + examples: + create: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfileEntityAssignment - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1224,8 +2076,14 @@ paths: the different items. required: - ObjectSid + examples: + create: + value: + ObjectSid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Assigned Items for an account. + tags: + - TrusthubV1CustomerProfilesEntityAssignments parameters: - name: CustomerProfileSid in: path @@ -1237,6 +2095,13 @@ paths: maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true + - name: ObjectType + in: query + description: A string to filter the results by (EndUserType or SupportingDocumentType) + machine-name. This is useful when you want to retrieve the entity-assignment + of a specific end-user or supporting document. + schema: + type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1269,47 +2134,76 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfileEntityAssignment - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /CustomerProfiles/{Sid} mountName: customer_profiles_entity_assignments className: customer_profiles_entity_assignments + pathType: instance get: description: Fetch specific Assigned Item Instance. + tags: + - TrusthubV1CustomerProfilesEntityAssignments parameters: - name: CustomerProfileSid in: path @@ -1336,14 +2230,23 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment' + examples: + fetch: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfileEntityAssignment - x-maturity: - - GA delete: description: Remove an Assignment Item Instance. + tags: + - TrusthubV1CustomerProfilesEntityAssignments parameters: - name: CustomerProfileSid in: path @@ -1370,21 +2273,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCustomerProfileEntityAssignment - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /CustomerProfiles/{Sid} mountName: customer_profiles_evaluations className: customer_profiles_evaluations + pathType: list post: description: Create a new Evaluation + tags: + - TrusthubV1CustomerProfilesEvaluations parameters: - name: CustomerProfileSid in: path @@ -1402,12 +2305,280 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation' + examples: + create: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info + createCompliantStarterCustomerProfile: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: compliant + date_created: '2023-03-15T13:51:57Z' + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - valid: + - object_field: first_name + error_code: null + friendly_name: First Name + passed: true + failure_reason: null + - object_field: last_name + error_code: null + friendly_name: Last Name + passed: true + failure_reason: null + - object_field: email + error_code: null + friendly_name: Email Address + passed: true + failure_reason: null + - object_field: phone_number + error_code: null + friendly_name: Phone Number + passed: true + failure_reason: null + invalid: [] + object_type: starter_customer_profile_information + friendly_name: Information + failure_reason: null + passed: true + requirement_friendly_name: Starter Customer Profile Information + error_code: null + requirement_name: starter_customer_profile_information + - valid: + - object_field: address_sids + error_code: null + friendly_name: address sids + passed: true + failure_reason: null + invalid: [] + object_type: customer_profile_address + friendly_name: Legal Company Address + failure_reason: null + passed: true + requirement_friendly_name: Customer Profile Address + error_code: null + requirement_name: customer_profile_address + - valid: + - object_field: bundle_sid + error_code: null + friendly_name: Supporting Bundle Status + passed: true + failure_reason: null + invalid: [] + object_type: primary_customer_profile_type_business + friendly_name: Primary Customer Profile Bundle + failure_reason: null + passed: true + requirement_friendly_name: Primary Customer Profile + error_code: null + requirement_name: primary_customer_profile + createCompliantSoleProprietorA2PProfile: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: compliant + date_created: '2023-03-15T13:51:57Z' + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - valid: + - object_field: brand_name + error_code: null + friendly_name: Brand Name + passed: true + failure_reason: null + - object_field: mobile_phone_number + error_code: null + friendly_name: Mobile Phone Number + passed: true + failure_reason: null + - object_field: vertical + error_code: null + friendly_name: Vertical + passed: true + failure_reason: null + invalid: [] + object_type: sole_proprietor_information + friendly_name: Sole Proprietor Information + failure_reason: null + passed: true + requirement_friendly_name: Sole Proprietor Information + error_code: null + requirement_name: sole_proprietor_information + - valid: + - object_field: bundle_status + error_code: null + friendly_name: Supporting Bundle Status + passed: true + failure_reason: null + invalid: [] + object_type: starter_customer_profile_type_business + friendly_name: Starter Customer Profile(isv customers) Proof + failure_reason: null + passed: true + requirement_friendly_name: Customer Profile + error_code: null + requirement_name: customer_profile description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfileEvaluation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1424,9 +2595,21 @@ paths: the customer_profile resource. required: - PolicySid + examples: + create: + value: + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createCompliantStarterCustomerProfile: + value: + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createCompliantSoleProprietorA2PProfile: + value: + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of Evaluations associated to the customer_profile resource. + tags: + - TrusthubV1CustomerProfilesEvaluations parameters: - name: CustomerProfileSid in: path @@ -1470,47 +2653,222 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add + one to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the + Business information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter + in a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure + both Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in + the address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfileEvaluation - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /CustomerProfiles/{Sid} mountName: customer_profiles_evaluations className: customer_profiles_evaluations + pathType: instance get: description: Fetch specific Evaluation Instance. + tags: + - TrusthubV1CustomerProfilesEvaluations parameters: - name: CustomerProfileSid in: path @@ -1537,16 +2895,169 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation' + examples: + fetch: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfileEvaluation - x-maturity: - - GA /v1/EndUsers: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1554,18 +3065,35 @@ paths: pathType: list post: description: Create a new End User. + tags: + - TrusthubV1EndUser responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user' + examples: + create: + value: + date_updated: '2021-02-16T20:40:57Z' + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: auth_rep_1 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-16T20:40:57Z' + attributes: + phone_number: '+11234567890' + job_position: CEO + first_name: rep1 + last_name: test + business_title: ceo + email: foobar@test.com + type: authorized_representative_1 description: Created security: - accountSid_authToken: [] operationId: CreateEndUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1586,8 +3114,16 @@ paths: required: - FriendlyName - Type + examples: + create: + value: + FriendlyName: auth_rep_1 + Type: authorized_representative_1 + Attributes: '{}' get: description: Retrieve a list of all End User for an account. + tags: + - TrusthubV1EndUser parameters: - name: PageSize in: query @@ -1621,38 +3157,73 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.end_user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - date_updated: '2021-02-16T20:40:57Z' + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: auth_rep_1 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-16T20:40:57Z' + attributes: + phone_number: '+11234567890' + job_position: CEO + first_name: rep1 + last_name: test + business_title: ceo + email: foobar@test.com + type: authorized_representative_1 + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListEndUser - x-maturity: - - GA /v1/EndUsers/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1660,6 +3231,8 @@ paths: pathType: instance get: description: Fetch specific End User Instance. + tags: + - TrusthubV1EndUser parameters: - name: Sid in: path @@ -1677,14 +3250,31 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user' + examples: + fetch: + value: + date_updated: '2021-02-16T20:40:57Z' + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: auth_rep_1 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-16T20:40:57Z' + attributes: + phone_number: '+11234567890' + job_position: CEO + first_name: rep1 + last_name: test + business_title: ceo + email: foobar@test.com + type: authorized_representative_1 description: OK security: - accountSid_authToken: [] operationId: FetchEndUser - x-maturity: - - GA post: description: Update an existing End User. + tags: + - TrusthubV1EndUser parameters: - name: Sid in: path @@ -1702,12 +3292,27 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user' + examples: + update: + value: + date_updated: '2021-02-16T20:40:57Z' + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-16T20:40:57Z' + attributes: + phone_number: '+11234567890' + job_position: CEO + first_name: rep1 + last_name: test + business_title: ceo + email: foobar@test.com + type: authorized_representative_1 description: OK security: - accountSid_authToken: [] operationId: UpdateEndUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1721,8 +3326,15 @@ paths: Attributes: description: The set of parameters that are the attributes of the End User resource which are derived End User Types. + examples: + update: + value: + FriendlyName: friendly_name + Attributes: '{}' delete: description: Delete a specific End User. + tags: + - TrusthubV1EndUser parameters: - name: Sid in: path @@ -1740,12 +3352,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteEndUser - x-maturity: - - GA /v1/EndUserTypes: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1753,6 +3363,8 @@ paths: pathType: list get: description: Retrieve a list of all End-User Types. + tags: + - TrusthubV1EndUserType parameters: - name: PageSize in: query @@ -1786,38 +3398,82 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.end_user_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + end_user_types: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 + next_page_url: null + key: end_user_types + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 + next_page_url: null + key: end_user_types + end_user_types: + - url: https://trusthub.twilio.com/v1/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fields: + - machine_name: last_name + friendly_name: Last Name + constraint: String + - machine_name: email + friendly_name: Email + constraint: String + - machine_name: first_name + friendly_name: First Name + constraint: String + - machine_name: business_title + friendly_name: Business Title + constraint: String + - machine_name: phone_number + friendly_name: Phone Number + constraint: String + - machine_name: job_position + friendly_name: Job Position + constraint: String + machine_name: authorized_representative_1 + friendly_name: Authorized Representative one + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListEndUserType - x-maturity: - - GA /v1/EndUserTypes/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1825,6 +3481,8 @@ paths: pathType: instance get: description: Fetch a specific End-User Type Instance. + tags: + - TrusthubV1EndUserType parameters: - name: Sid in: path @@ -1838,24 +3496,50 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user_type' + examples: + fetch: + value: + url: https://trusthub.twilio.com/v1/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fields: + - machine_name: last_name + friendly_name: Last Name + constraint: String + - machine_name: email + friendly_name: Email + constraint: String + - machine_name: first_name + friendly_name: First Name + constraint: String + - machine_name: business_title + friendly_name: Business Title + constraint: String + - machine_name: phone_number + friendly_name: Phone Number + constraint: String + - machine_name: job_position + friendly_name: Job Position + constraint: String + machine_name: authorized_representative_1 + friendly_name: Authorized Representative one + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEndUserType - x-maturity: - - GA /v1/Policies: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list className: policies + pathType: list get: description: Retrieve a list of all Policys. + tags: + - TrusthubV1Policies parameters: - name: PageSize in: query @@ -1889,46 +3573,123 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.policies' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 + next_page_url: null + key: results + results: + - url: https://trusthub.twilio.com/v1/Policies/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + requirements: + end_user: + - url: /EndUserTypes/customer_profile_business_information + fields: + - business_type + - business_registration_number + - business_name + - business_registration_identifier + - business_identity + - business_industry + - website_url + - business_regions_of_operation + - social_media_profile_urls + type: customer_profile_business_information + name: Business Information + requirement_name: customer_profile_business_information + - url: /EndUserTypes/authorized_representative_1 + fields: + - first_name + - last_name + - email + - phone_number + - business_title + - job_position + type: authorized_representative_1 + name: Authorized Representative 1 + requirement_name: authorized_representative_1 + - url: /EndUserTypes/authorized_representative_2 + fields: + - first_name + - last_name + - email + - phone_number + - business_title + - job_position + type: authorized_representative_2 + name: Authorized Representative 2 + requirement_name: authorized_representative_2 + supporting_trust_products: [] + supporting_document: + - - description: Customer Profile HQ Physical Address + type: document + name: Physical Business Address + accepted_documents: + - url: /SupportingDocumentTypes/customer_profile_address + fields: + - address_sids + type: customer_profile_address + name: Physical Business Address + requirement_name: customer_profile_address + supporting_customer_profiles: [] + friendly_name: Primary Customer Profile of type Business + sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListPolicies - x-maturity: - - GA /v1/Policies/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance className: policies + pathType: instance get: description: Fetch specific Policy Instance. + tags: + - TrusthubV1Policies parameters: - name: Sid in: path @@ -1945,16 +3706,133 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.policies' + examples: + fetch: + value: + url: https://trusthub.twilio.com/v1/Policies/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + requirements: + end_user: + - url: /EndUserTypes/customer_profile_business_information + fields: + - business_type + - business_registration_number + - business_name + - business_registration_identifier + - business_identity + - business_industry + - website_url + - business_regions_of_operation + - social_media_profile_urls + type: customer_profile_business_information + name: Business Information + requirement_name: customer_profile_business_information + - url: /EndUserTypes/authorized_representative_1 + fields: + - first_name + - last_name + - email + - phone_number + - business_title + - job_position + type: authorized_representative_1 + name: Authorized Representative 1 + requirement_name: authorized_representative_1 + - url: /EndUserTypes/authorized_representative_2 + fields: + - first_name + - last_name + - email + - phone_number + - business_title + - job_position + type: authorized_representative_2 + name: Authorized Representative 2 + requirement_name: authorized_representative_2 + supporting_trust_products: [] + supporting_document: + - - description: Customer Profile HQ Physical Address + type: document + name: Physical Business Address + accepted_documents: + - url: /SupportingDocumentTypes/customer_profile_address + fields: + - address_sids + type: customer_profile_address + name: Physical Business Address + requirement_name: customer_profile_address + supporting_customer_profiles: [] + friendly_name: Primary Customer Profile of type Business + sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchStarterCustomerProfilePolicy: + value: + url: https://trusthub.twilio.com/v1/Policies/RN806dd6cd175f314e1f96a9727ee271f4 + requirements: + end_user: + - url: /EndUserTypes/starter_customer_profile_information + fields: + - first_name + - last_name + - email + - phone_number + type: starter_customer_profile_information + name: Information + requirement_name: starter_customer_profile_information + supporting_trust_products: [] + supporting_document: + - - description: Customer Profile Address + type: document + name: Customer Profile Address + accepted_documents: + - url: /SupportingDocumentTypes/customer_profile_address + fields: + - address_sids + type: customer_profile_address + name: Legal Company Address + - url: /SupportingDocumentTypes/starter_customer_profile_address + fields: + - address_sids + type: starter_customer_profile_address + name: Legal Company Address + requirement_name: customer_profile_address + supporting_customer_profiles: + - type: primary_customer_profile_type_business + name: Primary Customer Profile Bundle + requirement_name: primary_customer_profile + friendly_name: Starter Customer Profile of type Business + sid: RN806dd6cd175f314e1f96a9727ee271f4 + fetchSoleProprietorTrustBundlePolicy: + value: + url: https://trusthub.twilio.com/v1/Policies/RN670d5d2e282a6130ae063b234b6019c8 + requirements: + end_user: + - url: /EndUserTypes/sole_proprietor_information + fields: + - brand_name + - mobile_phone_number + - vertical + type: sole_proprietor_information + name: Sole Proprietor Information + requirement_name: sole_proprietor_information + supporting_trust_products: [] + supporting_document: + - [] + supporting_customer_profiles: + - type: starter_customer_profile_type_business + name: Starter Customer Profile(isv customers) Proof + requirement_name: customer_profile + - type: starter_customer_profile_type_direct_long_tail + name: Starter Customer Profile(direct customers) Proof + requirement_name: customer_profile + friendly_name: Sole Proprietor TrustProduct + sid: RN670d5d2e282a6130ae063b234b6019c8 description: OK security: - accountSid_authToken: [] operationId: FetchPolicies - x-maturity: - - GA /v1/SupportingDocuments: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1962,18 +3840,32 @@ paths: pathType: list post: description: Create a new Supporting Document. + tags: + - TrusthubV1SupportingDocument responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document' + examples: + create: + value: + status: draft + date_updated: '2021-02-11T17:23:00Z' + friendly_name: Business-profile-physical-address + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-11T17:23:00Z' + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: + address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: customer_profile_address + mime_type: null description: Created security: - accountSid_authToken: [] operationId: CreateSupportingDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1994,8 +3886,16 @@ paths: required: - FriendlyName - Type + examples: + create: + value: + FriendlyName: Business-profile-physical-address + Type: customer_profile_address + Attributes: '{}' get: description: Retrieve a list of all Supporting Document for an account. + tags: + - TrusthubV1SupportingDocument parameters: - name: PageSize in: query @@ -2029,38 +3929,70 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.supporting_document' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - status: draft + date_updated: '2021-02-11T17:23:00Z' + friendly_name: Business-profile-physical-address + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-11T17:23:00Z' + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: + address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: customer_profile_address + mime_type: null + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocument - x-maturity: - - GA /v1/SupportingDocuments/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2068,6 +4000,8 @@ paths: pathType: instance get: description: Fetch specific Supporting Document Instance. + tags: + - TrusthubV1SupportingDocument parameters: - name: Sid in: path @@ -2085,14 +4019,28 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document' + examples: + fetch: + value: + status: draft + date_updated: '2021-02-11T17:23:00Z' + friendly_name: Business-profile-physical-address + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-11T17:23:00Z' + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: + address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: customer_profile_address + mime_type: null description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocument - x-maturity: - - GA post: description: Update an existing Supporting Document. + tags: + - TrusthubV1SupportingDocument parameters: - name: Sid in: path @@ -2110,12 +4058,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document' + examples: + update: + value: + status: draft + date_updated: '2021-02-11T17:23:00Z' + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-11T17:23:00Z' + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: + address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: customer_profile_address + mime_type: null description: OK security: - accountSid_authToken: [] operationId: UpdateSupportingDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2130,8 +4090,15 @@ paths: description: The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types. + examples: + update: + value: + FriendlyName: friendly_name + Attributes: '{}' delete: description: Delete a specific Supporting Document. + tags: + - TrusthubV1SupportingDocument parameters: - name: Sid in: path @@ -2149,12 +4116,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSupportingDocument - x-maturity: - - GA /v1/SupportingDocumentTypes: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2162,6 +4127,8 @@ paths: pathType: list get: description: Retrieve a list of all Supporting Document Types. + tags: + - TrusthubV1SupportingDocumentType parameters: - name: PageSize in: query @@ -2195,38 +4162,82 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.supporting_document_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + supporting_document_types: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 + next_page_url: null + key: supporting_document_types + readFull: + value: + supporting_document_types: + - url: https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fields: + - machine_name: address_sids + friendly_name: Address Sids + constraint: List + machine_name: customer_profile_address + friendly_name: Customer profile address + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - url: https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fields: + - machine_name: first_name + friendly_name: First Name + constraint: String + - machine_name: last_name + friendly_name: Last Name + constraint: String + - machine_name: business_name + friendly_name: Business Name + constraint: String + machine_name: government_issued_proof_of_authorized_representative + friendly_name: Government Issued Identity certifying proof of + being an authorized representative of a company + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 + next_page_url: null + key: supporting_document_types description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocumentType - x-maturity: - - GA /v1/SupportingDocumentTypes/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2234,6 +4245,8 @@ paths: pathType: instance get: description: Fetch a specific Supporting Document Type Instance. + tags: + - TrusthubV1SupportingDocumentType parameters: - name: Sid in: path @@ -2248,41 +4261,84 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document_type' + examples: + fetch: + value: + url: https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fields: + - machine_name: first_name + friendly_name: First Name + constraint: String + - machine_name: last_name + friendly_name: Last Name + constraint: String + - machine_name: business_name + friendly_name: Business Name + constraint: String + machine_name: government_issued_proof_of_authorized_representative + friendly_name: Government Issued Identity certifying proof of + being an authorized representative of a company + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocumentType - x-maturity: - - GA /v1/TrustProducts: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name - pathType: list dependentProperties: - trust_products_entity_assignments: '{trust_product_sid: sid}' - trust_products_evaluations: '{trust_product_sid: sid}' - trust_products_channel_endpoint_assignment: '{trust_product_sid: sid}' + trust_products_entity_assignments: + mapping: + trust_product_sid: sid + resource_url: /v1/TrustProducts/{trust_product_sid}/EntityAssignments + trust_products_evaluations: + mapping: + trust_product_sid: sid + resource_url: /v1/TrustProducts/{trust_product_sid}/Evaluations + trust_products_channel_endpoint_assignment: + mapping: + trust_product_sid: sid + resource_url: /v1/TrustProducts/{trust_product_sid}/ChannelEndpointAssignments className: trust_products + pathType: list post: description: Create a new Customer-Profile. + tags: + - TrusthubV1TrustProducts responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product' + examples: + create: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: Created security: - accountSid_authToken: [] operationId: CreateTrustProduct - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2313,8 +4369,17 @@ paths: - FriendlyName - Email - PolicySid + examples: + create: + value: + FriendlyName: friendly_name + Email: email + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + StatusCallback: http://www.example.com get: description: Retrieve a list of all Customer-Profiles for an account. + tags: + - TrusthubV1TrustProducts parameters: - name: Status in: query @@ -2322,11 +4387,17 @@ paths: schema: type: string $ref: '#/components/schemas/trust_product_enum_status' + examples: + readFull: + value: draft - name: FriendlyName in: query description: The string that you assigned to describe the resource. schema: type: string + examples: + readFull: + value: friendly_name - name: PolicySid in: query description: The unique string of a policy that is associated to the Customer-Profile @@ -2336,6 +4407,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ + examples: + readFull: + value: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2368,51 +4442,98 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.trust_product' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: 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 + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListTrustProduct - x-maturity: - - GA /v1/TrustProducts/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name - pathType: instance dependentProperties: - trust_products_entity_assignments: '{trust_product_sid: sid}' - trust_products_evaluations: '{trust_product_sid: sid}' - trust_products_channel_endpoint_assignment: '{trust_product_sid: sid}' + trust_products_entity_assignments: + mapping: + trust_product_sid: sid + resource_url: /v1/TrustProducts/{trust_product_sid}/EntityAssignments + trust_products_evaluations: + mapping: + trust_product_sid: sid + resource_url: /v1/TrustProducts/{trust_product_sid}/Evaluations + trust_products_channel_endpoint_assignment: + mapping: + trust_product_sid: sid + resource_url: /v1/TrustProducts/{trust_product_sid}/ChannelEndpointAssignments className: trust_products + pathType: instance get: description: Fetch a specific Customer-Profile instance. + tags: + - TrusthubV1TrustProducts parameters: - name: Sid in: path @@ -2430,14 +4551,32 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product' + examples: + fetch: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + valid_until: null + email: email + status_callback: http://www.example.com + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: OK security: - accountSid_authToken: [] operationId: FetchTrustProduct - x-maturity: - - GA post: description: Updates a Customer-Profile in an account. + tags: + - TrusthubV1TrustProducts parameters: - name: Sid in: path @@ -2455,12 +4594,45 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product' + examples: + update: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments + updateToInReview: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: in-review + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: OK security: - accountSid_authToken: [] operationId: UpdateTrustProduct - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2484,8 +4656,20 @@ paths: type: string description: The email address that will receive updates when the Customer-Profile resource changes status. + examples: + update: + value: + Status: draft + StatusCallback: http://www.example.com + FriendlyName: friendly_name + Email: email + updateToInReview: + value: + Status: pending-review delete: description: Delete a specific Customer-Profile. + tags: + - TrusthubV1TrustProducts parameters: - name: Sid in: path @@ -2503,20 +4687,20 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTrustProduct - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /TrustProducts/{Sid} mountName: trust_products_channel_endpoint_assignment + pathType: list post: description: Create a new Assigned Item. + tags: + - TrusthubV1TrustProductsChannelEndpointAssignment parameters: - name: TrustProductSid in: path @@ -2534,12 +4718,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment' + examples: + create: + value: + sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateTrustProductChannelEndpointAssignment - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2559,8 +4751,15 @@ paths: required: - ChannelEndpointType - ChannelEndpointSid + examples: + create: + value: + ChannelEndpointSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ChannelEndpointType: phone-number get: description: Retrieve a list of all Assigned Items for an account. + tags: + - TrusthubV1TrustProductsChannelEndpointAssignment parameters: - name: TrustProductSid in: path @@ -2580,6 +4779,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readFull: + value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: ChannelEndpointSids in: query description: comma separated list of channel endpoint sids @@ -2617,46 +4819,76 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListTrustProductChannelEndpointAssignment - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /TrustProducts/{Sid} mountName: trust_products_channel_endpoint_assignment + pathType: instance get: description: Fetch specific Assigned Item Instance. + tags: + - TrusthubV1TrustProductsChannelEndpointAssignment parameters: - name: TrustProductSid in: path @@ -2683,14 +4915,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment' + examples: + fetch: + value: + sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchTrustProductChannelEndpointAssignment - x-maturity: - - GA delete: description: Remove an Assignment Item Instance. + tags: + - TrusthubV1TrustProductsChannelEndpointAssignment parameters: - name: TrustProductSid in: path @@ -2717,21 +4959,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTrustProductChannelEndpointAssignment - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/EntityAssignments: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /TrustProducts/{Sid} mountName: trust_products_entity_assignments className: trust_products_entity_assignments + pathType: list post: description: Create a new Assigned Item. + tags: + - TrusthubV1TrustProductsEntityAssignments parameters: - name: TrustProductSid in: path @@ -2749,12 +4991,19 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment' + examples: + create: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateTrustProductEntityAssignment - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2771,8 +5020,14 @@ paths: the different items. required: - ObjectSid + examples: + create: + value: + ObjectSid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Assigned Items for an account. + tags: + - TrusthubV1TrustProductsEntityAssignments parameters: - name: TrustProductSid in: path @@ -2784,6 +5039,13 @@ paths: maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true + - name: ObjectType + in: query + description: A string to filter the results by (EndUserType or SupportingDocumentType) + machine-name. This is useful when you want to retrieve the entity-assignment + of a specific end-user or supporting document. + schema: + type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2816,47 +5078,76 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListTrustProductEntityAssignment - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/EntityAssignments/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /TrustProducts/{Sid} mountName: trust_products_entity_assignments className: trust_products_entity_assignments + pathType: instance get: description: Fetch specific Assigned Item Instance. + tags: + - TrusthubV1TrustProductsEntityAssignments parameters: - name: TrustProductSid in: path @@ -2883,14 +5174,23 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment' + examples: + fetch: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchTrustProductEntityAssignment - x-maturity: - - GA delete: description: Remove an Assignment Item Instance. + tags: + - TrusthubV1TrustProductsEntityAssignments parameters: - name: TrustProductSid in: path @@ -2917,21 +5217,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTrustProductEntityAssignment - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/Evaluations: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /TrustProducts/{Sid} mountName: trust_products_evaluations className: trust_products_evaluations + pathType: list post: description: Create a new Evaluation + tags: + - TrusthubV1TrustProductsEvaluations parameters: - name: TrustProductSid in: path @@ -2949,12 +5249,213 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation' + examples: + create: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info + createCompliantSoleProprietorA2PProfile: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: compliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - valid: + - object_field: brand_name + error_code: null + friendly_name: Brand Name + passed: true + failure_reason: null + - object_field: mobile_phone_number + error_code: null + friendly_name: Mobile Phone Number + passed: true + failure_reason: null + - object_field: vertical + error_code: null + friendly_name: Vertical + passed: true + failure_reason: null + invalid: [] + object_type: sole_proprietor_information + friendly_name: Sole Proprietor Information + failure_reason: null + passed: true + requirement_friendly_name: Sole Proprietor Information + error_code: null + requirement_name: sole_proprietor_information + - valid: + - object_field: bundle_status + error_code: null + friendly_name: Supporting Bundle Status + passed: true + failure_reason: null + invalid: [] + object_type: starter_customer_profile_type_business + friendly_name: Starter Customer Profile(isv customers) Proof + failure_reason: null + passed: true + requirement_friendly_name: Customer Profile + error_code: null + requirement_name: customer_profile description: Created security: - accountSid_authToken: [] operationId: CreateTrustProductEvaluation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2971,9 +5472,18 @@ paths: the customer_profile resource. required: - PolicySid + examples: + create: + value: + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createCompliantSoleProprietorA2PProfile: + value: + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of Evaluations associated to the trust_product resource. + tags: + - TrusthubV1TrustProductsEvaluations parameters: - name: TrustProductSid in: path @@ -3017,47 +5527,222 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add + one to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the + Business information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter + in a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure + both Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in + the address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListTrustProductEvaluation - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/Evaluations/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /TrustProducts/{Sid} mountName: trust_products_evaluations className: trust_products_evaluations + pathType: instance get: description: Fetch specific Evaluation Instance. + tags: + - TrusthubV1TrustProductsEvaluations parameters: - name: TrustProductSid in: path @@ -3084,14 +5769,185 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation' + examples: + fetch: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info description: OK security: - accountSid_authToken: [] operationId: FetchTrustProductEvaluation - x-maturity: - - GA servers: - url: https://trusthub.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: TrusthubV1ComplianceInquiries +- name: TrusthubV1ComplianceRegistrationInquiries +- name: TrusthubV1ComplianceTollfreeInquiries +- name: TrusthubV1CustomerProfiles +- name: TrusthubV1CustomerProfilesChannelEndpointAssignment +- name: TrusthubV1CustomerProfilesEntityAssignments +- name: TrusthubV1CustomerProfilesEvaluations +- name: TrusthubV1CustomerProfilesProvisionalCopy +- name: TrusthubV1EndUser +- name: TrusthubV1EndUserType +- name: TrusthubV1Policies +- name: TrusthubV1SupportingDocument +- name: TrusthubV1SupportingDocumentType +- name: TrusthubV1TrustProducts +- name: TrusthubV1TrustProductsChannelEndpointAssignment +- name: TrusthubV1TrustProductsEntityAssignments +- name: TrusthubV1TrustProductsEvaluations +- name: TrusthubV1TrustProductsProvisionalCopy +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_verify_v2.yaml b/spec/yaml/twilio_verify_v2.yaml index 1fdac2a7..41550900 100644 --- a/spec/yaml/twilio_verify_v2.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: verify.v2.service.access_token: type: object @@ -39,6 +43,10 @@ components: nullable: true description: A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name. + x-twilio: + pii: + handling: standard + deleteSla: 30 token: type: string nullable: true @@ -161,6 +169,10 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 factor_sid: type: string minLength: 34 @@ -209,17 +221,29 @@ components: nullable: true description: Details provided to give context about the Challenge. Intended to be shown to the end user. + x-twilio: + pii: + handling: standard + deleteSla: 30 hidden_details: nullable: true description: 'Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. `{"ip": "172.168.1.234"}`' + x-twilio: + pii: + handling: standard + deleteSla: 30 metadata: nullable: true 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.' + x-twilio: + pii: + handling: standard + deleteSla: 30 factor_type: type: string $ref: '#/components/schemas/challenge_enum_factor_types' @@ -278,6 +302,10 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -354,6 +382,10 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -390,6 +422,10 @@ components: 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.' + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -474,7 +510,7 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration. date_created: type: string @@ -532,6 +568,10 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 binding: nullable: true description: "Contains the `factor_type` specific secret and metadata.\n\ @@ -582,6 +622,10 @@ components: 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.' + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -648,6 +692,10 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 challenge_sid: type: string minLength: 34 @@ -744,6 +792,10 @@ components: type: string nullable: true description: The phone number in SafeList. + x-twilio: + pii: + handling: standard + deleteSla: 0 url: type: string format: uri @@ -827,6 +879,11 @@ components: maxLength: 34 pattern: ^HJ[0-9a-fA-F]{32}$ nullable: true + verify_event_subscription_enabled: + type: boolean + nullable: true + description: Whether to allow verifications from the service to reach the + stream-events sinks if configured date_created: type: string format: date-time @@ -881,12 +938,16 @@ components: nullable: true description: The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + x-twilio: + pii: + handling: standard + deleteSla: 30 channel: type: string $ref: '#/components/schemas/verification_enum_channel' nullable: true description: 'The verification method used. One of: [`email`](https://www.twilio.com/docs/verify/email), - `sms`, `whatsapp`, `call`, or `sna`.' + `sms`, `whatsapp`, `call`, `sna`, or `rcs`.' status: type: string nullable: true @@ -905,11 +966,19 @@ components: nullable: true description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. + x-twilio: + pii: + handling: sensitive + deleteSla: 1 payee: type: string nullable: true description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. + x-twilio: + pii: + handling: sensitive + deleteSla: 1 send_code_attempts: type: array items: {} @@ -951,6 +1020,11 @@ components: enum: - canceled - approved + verification_enum_risk_check: + type: string + enum: + - enable + - disable verify.v2.verification_attempt: type: object properties: @@ -1015,7 +1089,7 @@ components: description: An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately - available. More information on pricing is available [here](https://www.twilio.com/verify/pricing). + available. More information on pricing is available [here](https://www.twilio.com/en-us/verify/pricing). channel_data: nullable: true description: An object containing the channel specific information for an @@ -1134,6 +1208,10 @@ components: nullable: true description: The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + x-twilio: + pii: + handling: standard + deleteSla: 30 channel: type: string $ref: '#/components/schemas/verification_check_enum_channel' @@ -1155,11 +1233,19 @@ components: nullable: true description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. + x-twilio: + pii: + handling: sensitive + deleteSla: 1 payee: type: string nullable: true description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. + x-twilio: + pii: + handling: sensitive + deleteSla: 1 date_created: type: string format: date-time @@ -1316,10 +1402,6 @@ components: enum: - GET - POST - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Verify description: This is the public Twilio REST API. @@ -1331,13 +1413,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/AccessTokens: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1349,10 +1431,12 @@ paths: - token - ttl - date_created - pathType: list parent: /Services/{Sid} + pathType: list post: description: Create a new enrollment Access Token for the Entity + tags: + - VerifyV2AccessToken parameters: - name: ServiceSid in: path @@ -1369,12 +1453,35 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.access_token' + examples: + createWithTtl: + value: + sid: YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_identity: ff483d1ff591898a9942916050d2ca3f + factor_type: push + factor_friendly_name: John Doe iPhone + ttl: 300 + date_created: '2015-07-30T20:00:00Z' + token: eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithoutTtl: + value: + sid: YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_identity: ff483d1ff591898a9942916050d2ca3f + factor_type: push + factor_friendly_name: John Doe iPhone + ttl: 60 + date_created: '2015-07-30T20:00:00Z' + token: eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateAccessToken - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1402,10 +1509,22 @@ paths: required: - Identity - FactorType + examples: + createWithTtl: + value: + FactorType: push + FactorFriendlyName: John Doe iPhone + Identity: ff483d1ff591898a9942916050d2ca3f + Ttl: 300 + createWithoutTtl: + value: + FactorType: push + FactorFriendlyName: John Doe iPhone + Identity: ff483d1ff591898a9942916050d2ca3f /v2/Services/{ServiceSid}/AccessTokens/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1417,10 +1536,12 @@ paths: - token - ttl - date_created - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: Fetch an Access Token for the Entity + tags: + - VerifyV2AccessToken parameters: - name: ServiceSid in: path @@ -1446,16 +1567,27 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.access_token' + examples: + fetch: + value: + sid: YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_identity: ff483d1ff591898a9942916050d2ca3f + factor_type: push + factor_friendly_name: John Doe iPhone + ttl: 60 + date_created: '2015-07-30T20:00:00Z' + token: eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchAccessToken - x-maturity: - - GA /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1466,10 +1598,12 @@ paths: - interval - date_created - date_updated - pathType: list parent: /Services/{ServiceSid}/RateLimits/{Sid} + pathType: list post: description: Create a new Bucket for a Rate Limit + tags: + - VerifyV2Bucket parameters: - name: ServiceSid in: path @@ -1497,12 +1631,22 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' + examples: + createBucket: + value: + sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + max: 5 + interval: 60 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateBucket - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1521,8 +1665,15 @@ paths: required: - Max - Interval + examples: + createBucket: + value: + Max: 5 + Interval: 60 get: description: Retrieve a list of all Buckets for a Rate Limit. + tags: + - VerifyV2Bucket parameters: - name: ServiceSid in: path @@ -1576,38 +1727,68 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + buckets: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 + next_page_url: null + key: buckets + readFull: + value: + buckets: + - sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + max: 5 + interval: 60 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 + next_page_url: null + key: buckets description: OK security: - accountSid_authToken: [] operationId: ListBucket - x-maturity: - - GA /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1618,10 +1799,12 @@ paths: - interval - date_created - date_updated - pathType: instance parent: /Services/{ServiceSid}/RateLimits/{Sid} + pathType: instance post: description: Update a specific Bucket. + tags: + - VerifyV2Bucket parameters: - name: ServiceSid in: path @@ -1658,12 +1841,22 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' + examples: + updateBucket: + value: + sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + max: 5 + interval: 60 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateBucket - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1679,8 +1872,15 @@ paths: type: integer description: Number of seconds that the rate limit will be enforced over. + examples: + updateBucket: + value: + Max: 5 + Interval: 60 get: description: Fetch a specific Bucket. + tags: + - VerifyV2Bucket parameters: - name: ServiceSid in: path @@ -1717,14 +1917,26 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' + examples: + fetchBucket: + value: + sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + max: 5 + interval: 60 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchBucket - x-maturity: - - GA delete: description: Delete a specific Bucket. + tags: + - VerifyV2Bucket parameters: - name: ServiceSid in: path @@ -1761,25 +1973,29 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBucket - x-maturity: - - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - factor_type - status - responded_reason - date_created - pathType: list dependentProperties: - notification: '{service_sid: service_sid, identity: identity, challenge_sid: - sid}' + notifications: + mapping: + service_sid: service_sid + identity: identity + challenge_sid: sid + resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges/{challenge_sid}/Notifications parent: /Services/{ServiceSid}/Entities/{Identity} + pathType: list post: description: Create a new Challenge for the Factor + tags: + - VerifyV2Challenge parameters: - name: ServiceSid in: path @@ -1798,6 +2014,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '201': @@ -1805,12 +2025,92 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' + examples: + createPush: + value: + sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: pending + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: push + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + createTotpWithoutAuthPayload: + value: + sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: pending + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: totp + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + createTotpWithAuthPayload: + value: + sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: approved + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: totp + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications description: Created security: - accountSid_authToken: [] operationId: CreateChallenge - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1857,8 +2157,36 @@ paths: be between 3 and 8 characters long. required: - FactorSid + examples: + createPush: + value: + FactorSid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ExpirationDate: '2015-07-30T20:00:00Z' + Details.Message: Hi! Mr. John Doe, would you like to sign up? + Details.Fields: + - '{"label": "Action", "value": "Sign up in portal"}' + HiddenDetails: '{"ip": "172.168.1.234"}' + createTotpWithoutAuthPayload: + value: + FactorSid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ExpirationDate: '2015-07-30T20:00:00Z' + Details.Message: Hi! Mr. John Doe, would you like to sign up? + Details.Fields: + - '{"label": "Action", "value": "Sign up in portal"}' + HiddenDetails: '{"ip": "172.168.1.234"}' + createTotpWithAuthPayload: + value: + FactorSid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ExpirationDate: '2015-07-30T20:00:00Z' + Details.Message: Hi! Mr. John Doe, would you like to sign up? + Details.Fields: + - '{"label": "Action", "value": "Sign up in portal"}' + HiddenDetails: '{"ip": "172.168.1.234"}' + AuthPayload: '12345678' get: description: Retrieve a list of all Challenges for a Factor. + tags: + - VerifyV2Challenge parameters: - name: ServiceSid in: path @@ -1877,6 +2205,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: FactorSid in: query @@ -1932,51 +2264,128 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.entity.challenge' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + challenges: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 + next_page_url: null + key: challenges + readFull: + value: + challenges: + - sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: pending + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: push + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + - sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: pending + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: totp + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 + next_page_url: null + key: challenges description: OK security: - accountSid_authToken: [] operationId: ListChallenge - x-maturity: - - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - factor_type - status - responded_reason - date_created - pathType: instance dependentProperties: - notification: '{service_sid: service_sid, identity: identity, challenge_sid: - sid}' + notifications: + mapping: + service_sid: service_sid + identity: identity + challenge_sid: sid + resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges/{challenge_sid}/Notifications parent: /Services/{ServiceSid}/Entities/{Identity} + pathType: instance get: description: Fetch a specific Challenge. + tags: + - VerifyV2Challenge parameters: - name: ServiceSid in: path @@ -1995,6 +2404,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Sid in: path @@ -2011,14 +2424,43 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' + examples: + fetchSid: + value: + sid: YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: approved + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: + os: Android + factor_type: push + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications description: OK security: - accountSid_authToken: [] operationId: FetchChallenge - x-maturity: - - GA post: description: Verify a specific Challenge. + tags: + - VerifyV2Challenge parameters: - name: ServiceSid in: path @@ -2037,6 +2479,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Sid in: path @@ -2053,12 +2499,66 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' + examples: + verifyPush: + value: + sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: approved + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: + os: Android + factor_type: push + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + verifyTotp: + value: + sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: approved + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: totp + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications description: OK security: - accountSid_authToken: [] operationId: UpdateChallenge - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2078,23 +2578,45 @@ paths: of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' + examples: + verifyPush: + value: + AuthPayload: '123456' + Metadata: '{"os": "Android"}' + verifyTotp: + value: + AuthPayload: '123456' /v2/Services/{ServiceSid}/Entities: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: list dependentProperties: - factor: '{service_sid: service_sid, identity: identity}' - new_factor: '{service_sid: service_sid, identity: identity}' - challenge: '{service_sid: service_sid, identity: identity}' + factors: + mapping: + service_sid: service_sid + identity: identity + resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors + new_factors: + mapping: + service_sid: service_sid + identity: identity + resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors + challenges: + mapping: + service_sid: service_sid + identity: identity + resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges parent: /Services/{Sid} + pathType: list post: description: Create a new Entity for the Service + tags: + - VerifyV2Entity parameters: - name: ServiceSid in: path @@ -2111,12 +2633,24 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity' + examples: + create: + value: + sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f + links: + factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + new_factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + challenges: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges description: Created security: - accountSid_authToken: [] operationId: CreateEntity - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2133,8 +2667,14 @@ paths: (-) separated alphanumeric characters. required: - Identity + examples: + create: + value: + Identity: ff483d1ff591898a9942916050d2ca3f get: description: Retrieve a list of all Entities for a Service. + tags: + - VerifyV2Entity parameters: - name: ServiceSid in: path @@ -2177,51 +2717,97 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.entity' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + entities: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 + next_page_url: null + key: entities + readFull: + value: + entities: + - sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f + links: + factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + new_factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + challenges: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 + next_page_url: null + key: entities description: OK security: - accountSid_authToken: [] operationId: ListEntity - x-maturity: - - GA /v2/Services/{ServiceSid}/Entities/{Identity}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: instance dependentProperties: - factor: '{service_sid: service_sid, identity: identity}' - new_factor: '{service_sid: service_sid, identity: identity}' - challenge: '{service_sid: service_sid, identity: identity}' + factors: + mapping: + service_sid: service_sid + identity: identity + resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors + new_factors: + mapping: + service_sid: service_sid + identity: identity + resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors + challenges: + mapping: + service_sid: service_sid + identity: identity + resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges parent: /Services/{Sid} + pathType: instance delete: description: Delete a specific Entity. + tags: + - VerifyV2Entity parameters: - name: ServiceSid in: path @@ -2240,6 +2826,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '204': @@ -2247,10 +2837,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteEntity - x-maturity: - - GA get: description: Fetch a specific Entity. + tags: + - VerifyV2Entity parameters: - name: ServiceSid in: path @@ -2269,6 +2859,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -2276,26 +2870,40 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity' + examples: + fetch: + value: + sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f + links: + factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + new_factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + challenges: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges description: OK security: - accountSid_authToken: [] operationId: FetchEntity - x-maturity: - - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - status - factor_type - pathType: instance parent: /Services/{ServiceSid}/Entities/{Identity} + pathType: instance delete: description: Delete a specific Factor. + tags: + - VerifyV2Factor parameters: - name: ServiceSid in: path @@ -2314,6 +2922,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Sid in: path @@ -2330,10 +2942,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteFactor - x-maturity: - - GA get: description: Fetch a specific Factor. + tags: + - VerifyV2Factor parameters: - name: ServiceSid in: path @@ -2352,6 +2964,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Sid in: path @@ -2368,15 +2984,55 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.factor' + examples: + fetchPush: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: push + config: + sdk_version: '1.0' + app_id: com.example.myapp + notification_platform: fcm + notification_token: test_token + metadata: + os: Android + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchTotp: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: totp + config: + alg: sha1 + skew: 1 + code_length: 6 + time_step: 30 + metadata: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchFactor - x-maturity: - - GA post: description: Update a specific Factor. This endpoint can be used to Verify a Factor if passed an `AuthPayload` param. + tags: + - VerifyV2Factor parameters: - name: ServiceSid in: path @@ -2395,6 +3051,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Sid in: path @@ -2411,12 +3071,50 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.factor' + examples: + verifyPush: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: verified + factor_type: push + config: + sdk_version: '1.0' + app_id: com.example.myapp + notification_platform: fcm + notification_token: test_token + metadata: + os: Android + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verifyTotp: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: verified + factor_type: totp + config: + alg: sha1 + skew: 1 + code_length: 6 + time_step: 30 + metadata: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateFactor - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2466,20 +3164,33 @@ paths: Required when `factor_type` is `push`.' + examples: + verifyPush: + value: + AuthPayload: '123456' + FriendlyName: FriendlyName + Config.SdkVersion: '1.0' + Config.NotificationToken: test_token + verifyTotp: + value: + FriendlyName: My Friendly Name + AuthPayload: '123456' /v2/Services/{ServiceSid}/Entities/{Identity}/Factors: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - status - factor_type - pathType: list parent: /Services/{ServiceSid}/Entities/{Identity} + pathType: list get: description: Retrieve a list of all Factors for an Entity. + tags: + - VerifyV2Factor parameters: - name: ServiceSid in: path @@ -2498,6 +3209,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: PageSize in: query @@ -2531,36 +3246,105 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.entity.factor' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + factors: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + next_page_url: null + key: factors + readFullPush: + value: + factors: + - sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: push + config: + sdk_version: '1.0' + app_id: com.example.myapp + notification_platform: fcm + notification_token: test_token + metadata: + os: Android + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + next_page_url: null + key: factors + readFullTotp: + value: + factors: + - sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: totp + config: + alg: sha1 + skew: 1 + code_length: 6 + time_step: 30 + metadata: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + next_page_url: null + key: factors description: OK security: - accountSid_authToken: [] operationId: ListFactor - x-maturity: - - GA post: description: Create a new Factor for the Entity + tags: + - VerifyV2NewFactor parameters: - name: ServiceSid in: path @@ -2579,6 +3363,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '201': @@ -2586,12 +3374,56 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.new_factor' + examples: + createPush: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + binding: + alg: ES256 + public_key: MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8GdwtibWe0kpgsFl6xPQBwhtwUEyeJkeozFmi2jiJDzxFSMwVy3kVR1h/dPVYOfgkC0EkfBRJ0J/6xW47FD5vA== + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: push + config: + sdk_version: '1.0' + app_id: com.example.myapp + notification_platform: fcm + notification_token: test_token + metadata: + os: Android + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createTotp: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + binding: + secret: GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ + uri: otpauth://totp/test-issuer:John%E2%80%99s%20Account%20Name?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=test-issuer&algorithm=SHA1&digits=6&period=30 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: totp + config: + alg: sha1 + skew: 1 + code_length: 6 + time_step: 30 + metadata: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateNewFactor - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2708,18 +3540,41 @@ paths: required: - FriendlyName - FactorType + examples: + createPush: + value: + FactorType: push + FriendlyName: FriendlyName + Binding.Alg: ES256 + Binding.PublicKey: dGVzdF9rZXk= + Config.SdkVersion: '1.0' + Config.AppId: com.example.myapp + Config.NotificationPlatform: fcm + Config.NotificationToken: test_token + Metadata: '{"os": "Android"}' + createTotp: + value: + FactorType: totp + FriendlyName: FriendlyName + Binding.Secret: GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ + Config.Alg: sha1 + Config.TimeStep: 30 + Config.CodeLength: 6 + Config.Skew: 1 x-twilio: mountName: new_factors /v2/Forms/{FormType}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - form_type pathType: instance get: description: Fetch the forms for a specific Form Type. + tags: + - VerifyV2Form parameters: - name: FormType in: path @@ -2734,16 +3589,24 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.form' + examples: + fetch: + value: + form_type: form-push + forms: + create_factor: {} + verify_factor: {} + create_challenge: {} + form_meta: {} + url: https://verify.twilio.com/v2/Forms/form-push description: OK security: - accountSid_authToken: [] operationId: FetchForm - x-maturity: - - Beta /v2/Services/{ServiceSid}/MessagingConfigurations: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid @@ -2752,10 +3615,12 @@ paths: - messaging_service_sid - date_created - date_updated - pathType: list parent: /Services/{Sid} + pathType: list post: description: Create a new MessagingConfiguration for a service. + tags: + - VerifyV2MessagingConfiguration parameters: - name: ServiceSid in: path @@ -2773,12 +3638,20 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + country: CA + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA description: Created security: - accountSid_authToken: [] operationId: CreateMessagingConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2797,13 +3670,20 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration. required: - Country - MessagingServiceSid + examples: + create: + value: + Country: CA + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Messaging Configurations for a Service. + tags: + - VerifyV2MessagingConfiguration parameters: - name: ServiceSid in: path @@ -2847,38 +3727,66 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + messaging_configurations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 + next_page_url: null + key: messaging_configurations + readFull: + value: + messaging_configurations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + country: CA + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 + next_page_url: null + key: messaging_configurations description: OK security: - accountSid_authToken: [] operationId: ListMessagingConfiguration - x-maturity: - - GA /v2/Services/{ServiceSid}/MessagingConfigurations/{Country}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid @@ -2887,10 +3795,12 @@ paths: - messaging_service_sid - date_created - date_updated - pathType: instance parent: /Services/{Sid} + pathType: instance post: description: Update a specific MessagingConfiguration + tags: + - VerifyV2MessagingConfiguration parameters: - name: ServiceSid in: path @@ -2916,12 +3826,20 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + country: CA + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA description: OK security: - accountSid_authToken: [] operationId: UpdateMessagingConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2934,12 +3852,18 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration. required: - MessagingServiceSid + examples: + update: + value: + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Fetch a specific MessagingConfiguration. + tags: + - VerifyV2MessagingConfiguration parameters: - name: ServiceSid in: path @@ -2965,14 +3889,24 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + country: CA + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA description: OK security: - accountSid_authToken: [] operationId: FetchMessagingConfiguration - x-maturity: - - GA delete: description: Delete a specific MessagingConfiguration. + tags: + - VerifyV2MessagingConfiguration parameters: - name: ServiceSid in: path @@ -2998,22 +3932,22 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessagingConfiguration - x-maturity: - - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - challenge_sid - date_created - pathType: list parent: /Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid} + pathType: list post: description: Create a new Notification for the corresponding Challenge + tags: + - VerifyV2Notification parameters: - name: ServiceSid in: path @@ -3032,6 +3966,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: ChallengeSid in: path @@ -3048,12 +3986,33 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge.notification' + examples: + createWithTtl: + value: + sid: NTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + challenge_sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + priority: high + ttl: 150 + createWithoutTtl: + value: + sid: NTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + challenge_sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + priority: high + ttl: 300 description: Created security: - accountSid_authToken: [] operationId: CreateNotification - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3068,10 +4027,16 @@ paths: until the TTL elapses, even if the device is offline. 0 means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. + examples: + createWithTtl: + value: + Ttl: 150 + createWithoutTtl: + value: {} /v2/Services/{ServiceSid}/RateLimits: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -3081,12 +4046,18 @@ paths: - description - date_created - date_updated - pathType: list dependentProperties: - bucket: '{service_sid: service_sid, rate_limit_sid: sid}' + buckets: + mapping: + service_sid: service_sid + rate_limit_sid: sid + resource_url: /v2/Services/{service_sid}/RateLimits/{rate_limit_sid}/Buckets parent: /Services/{Sid} + pathType: list post: description: Create a new Rate Limit for a Service + tags: + - VerifyV2RateLimit parameters: - name: ServiceSid in: path @@ -3104,12 +4075,23 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' + examples: + createRateLimit: + value: + sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique.name + description: Description + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets description: Created security: - accountSid_authToken: [] operationId: CreateRateLimit - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3127,8 +4109,15 @@ paths: description: Description of this Rate Limit required: - UniqueName + examples: + createRateLimit: + value: + UniqueName: unique.name + Description: Description get: description: Retrieve a list of all Rate Limits for a service. + tags: + - VerifyV2RateLimit parameters: - name: ServiceSid in: path @@ -3172,38 +4161,58 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.rate_limit' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readAll: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: rate_limits + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits?PageSize=50&Page=0 + rate_limits: + - sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique.name + description: Description + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets description: OK security: - accountSid_authToken: [] operationId: ListRateLimit - x-maturity: - - GA /v2/Services/{ServiceSid}/RateLimits/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -3213,12 +4222,18 @@ paths: - description - date_created - date_updated - pathType: instance dependentProperties: - bucket: '{service_sid: service_sid, rate_limit_sid: sid}' + buckets: + mapping: + service_sid: service_sid + rate_limit_sid: sid + resource_url: /v2/Services/{service_sid}/RateLimits/{rate_limit_sid}/Buckets parent: /Services/{Sid} + pathType: instance post: description: Update a specific Rate Limit. + tags: + - VerifyV2RateLimit parameters: - name: ServiceSid in: path @@ -3246,12 +4261,23 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' + examples: + updateRateLimit: + value: + sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique.name + description: Description + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets description: OK security: - accountSid_authToken: [] operationId: UpdateRateLimit - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3262,8 +4288,14 @@ paths: Description: type: string description: Description of this Rate Limit + examples: + updateRateLimit: + value: + Description: Description get: description: Fetch a specific Rate Limit. + tags: + - VerifyV2RateLimit parameters: - name: ServiceSid in: path @@ -3291,14 +4323,27 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' + examples: + fetchRateLimit: + value: + sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique.name + description: Description + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets description: OK security: - accountSid_authToken: [] operationId: FetchRateLimit - x-maturity: - - GA delete: description: Delete a specific Rate Limit. + tags: + - VerifyV2RateLimit parameters: - name: ServiceSid in: path @@ -3326,32 +4371,36 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRateLimit - x-maturity: - - GA /v2/SafeList/Numbers: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - phone_number - pathType: list mountName: safelist + pathType: list post: description: Add a new phone number to SafeList. + tags: + - VerifyV2Safelist responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.safelist' + examples: + create: + value: + sid: GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+18001234567' + url: https://verify.twilio.com/v2/SafeList/Numbers/+18001234567 description: Created security: - accountSid_authToken: [] operationId: CreateSafelist - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -3365,18 +4414,24 @@ paths: must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). required: - PhoneNumber + examples: + create: + value: + PhoneNumber: '+18001234567' /v2/SafeList/Numbers/{PhoneNumber}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - phone_number - pathType: instance mountName: safelist + pathType: instance get: description: Check if a phone number exists in SafeList. + tags: + - VerifyV2Safelist parameters: - name: PhoneNumber in: path @@ -3384,6 +4439,10 @@ paths: be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 0 required: true responses: '200': @@ -3391,14 +4450,20 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.safelist' + examples: + fetch: + value: + sid: GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+18001234567' + url: https://verify.twilio.com/v2/SafeList/Numbers/+18001234567 description: OK security: - accountSid_authToken: [] operationId: FetchSafelist - x-maturity: - - Beta delete: description: Remove a phone number from SafeList. + tags: + - VerifyV2Safelist parameters: - name: PhoneNumber in: path @@ -3406,6 +4471,10 @@ paths: be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 0 required: true responses: '204': @@ -3413,40 +4482,96 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSafelist - x-maturity: - - Beta /v2/Services: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list dependentProperties: - verification: '{service_sid: sid}' - verification_check: '{service_sid: sid}' - rate_limit: '{service_sid: sid}' - messaging_configuration: '{service_sid: sid}' - entity: '{service_sid: sid}' - webhook: '{service_sid: sid}' - access_token: '{service_sid: sid}' + verifications: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Verifications + verification_checks: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/VerificationCheck + rate_limits: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/RateLimits + messaging_configurations: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/MessagingConfigurations + entities: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Entities + webhooks: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Webhooks + access_tokens: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/AccessTokens + pathType: list post: description: Create a new Verification Service. + tags: + - VerifyV2Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service' + examples: + createRecord: + value: + sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + code_length: 4 + lookup_enabled: false + psd2_enabled: false + skip_sms_to_landlines: false + dtmf_input_required: false + tts_name: name + mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + do_not_share_warning_enabled: false + custom_code_enabled: true + push: + include_date: false + apn_credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fcm_credential_sid: null + totp: + issuer: test-issuer + time_step: 30 + code_length: 3 + skew: 2 + default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + 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 description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3551,10 +4676,36 @@ paths: description: The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only. + VerifyEventSubscriptionEnabled: + type: boolean + description: Whether to allow verifications from the service to + reach the stream-events sinks if configured 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 get: description: Retrieve a list of all Verification Services for an account. + tags: + - VerifyV2Service parameters: - name: PageSize in: query @@ -3588,54 +4739,121 @@ paths: items: $ref: '#/components/schemas/verify.v2.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readAll: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: services + url: https://verify.twilio.com/v2/Services?PageSize=50&Page=0 + services: + - sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + code_length: 4 + lookup_enabled: false + psd2_enabled: false + skip_sms_to_landlines: false + dtmf_input_required: false + tts_name: name + mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + do_not_share_warning_enabled: false + custom_code_enabled: true + push: + include_date: false + apn_credential_sid: null + fcm_credential_sid: null + totp: + issuer: null + time_step: null + code_length: null + skew: null + default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + 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 description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v2/Services/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance dependentProperties: - verification: '{service_sid: sid}' - verification_check: '{service_sid: sid}' - rate_limit: '{service_sid: sid}' - messaging_configuration: '{service_sid: sid}' - entity: '{service_sid: sid}' - webhook: '{service_sid: sid}' - access_token: '{service_sid: sid}' + verifications: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Verifications + verification_checks: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/VerificationCheck + rate_limits: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/RateLimits + messaging_configurations: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/MessagingConfigurations + entities: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Entities + webhooks: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/Webhooks + access_tokens: + mapping: + service_sid: sid + resource_url: /v2/Services/{service_sid}/AccessTokens + pathType: instance get: description: Fetch specific Verification Service Instance. + tags: + - VerifyV2Service parameters: - name: Sid in: path @@ -3653,14 +4871,51 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service' + examples: + fetchRecord: + value: + sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + code_length: 4 + lookup_enabled: false + psd2_enabled: false + skip_sms_to_landlines: false + dtmf_input_required: false + tts_name: name + mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + do_not_share_warning_enabled: false + custom_code_enabled: true + push: + include_date: false + apn_credential_sid: null + fcm_credential_sid: null + totp: + issuer: null + time_step: null + code_length: null + skew: null + default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + 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 description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: Delete a specific Verification Service Instance. + tags: + - VerifyV2Service parameters: - name: Sid in: path @@ -3678,10 +4933,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: Update a specific Verification Service. + tags: + - VerifyV2Service parameters: - name: Sid in: path @@ -3699,12 +4954,47 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service' + examples: + updateRecord: + value: + sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + code_length: 4 + lookup_enabled: false + psd2_enabled: false + skip_sms_to_landlines: false + dtmf_input_required: false + tts_name: name + mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + do_not_share_warning_enabled: false + custom_code_enabled: true + push: + include_date: false + apn_credential_sid: null + fcm_credential_sid: CRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + totp: + issuer: test-issuer + time_step: 30 + code_length: 3 + skew: 2 + default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + 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 description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3803,10 +5093,35 @@ paths: description: The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only. + VerifyEventSubscriptionEnabled: + type: boolean + 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 /v2/Services/{ServiceSid}/Verifications: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -3815,10 +5130,12 @@ paths: - status - valid - date_created - pathType: list parent: /Services/{Sid} + pathType: list post: description: Create a new Verification using a Service + tags: + - VerifyV2Verification parameters: - name: ServiceSid in: path @@ -3836,12 +5153,145 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' + examples: + createVerification: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: SMS + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createVerificationWhatsapp: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: whatsapp + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: whatsapp + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createVerificationEmail: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: mail@email.com + channel: email + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: EMAIL + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createVerificationWithRateLimits: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: SMS + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createVerificationSna: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sna + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: + carrier: + mobile_country_code: '311' + type: mobile + error_code: null + mobile_network_code: '180' + name: T-Mobile USA, Inc. + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: sna + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: + url: https://mi.dnlsrv.com/m/id/ANBByzx7?data=AAAglRRdNn02iTFWfDWwdTjOzM8o%2F6JB86fH%2Bt%2FFftUPj0pFA0u8%2FibWuYwzmMeMOtdTwYlsO8V%2FXF%2BJmngMhbeGKYhHeTOF2H9VrGEYKcEEklPxHgb5GgL3XtYa33j3lIU%2By6InvoV%2FowWHBzA0QeFPBh6vmJ8LoUPJqGE7q0PRz618Z4ym1AGq%2BaomSq9PlP4rCduv9Cmtxu%2FrvPSBwocs0GCWDE8seK8t9epmPQW7gwODxkAiKr9UxhJd9KvmBVuAQPf%2BoFQVo86USXkhXqTvUzB2bNUYY9FCy3CWgZFTOa1D3H1CVxf1eHzYIswNA7SmOzP%2FBX8g6%2B0hkzwMRkcit3gBNs4evAVJiqAgYvUlrtGwwv9bFx4X7jWSHY4%3D&cipherSalt=yANeDq09bwM38SJs + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createVerificationAuto: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sna + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: + carrier: + mobile_country_code: '311' + type: mobile + error_code: null + mobile_network_code: '180' + name: T-Mobile USA, Inc. + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: sna + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: + url: https://mi.dnlsrv.com/m/id/ANBByzx7?data=AAAglRRdNn02iTFWfDWwdTjOzM8o%2F6JB86fH%2Bt%2FFftUPj0pFA0u8%2FibWuYwzmMeMOtdTwYlsO8V%2FXF%2BJmngMhbeGKYhHeTOF2H9VrGEYKcEEklPxHgb5GgL3XtYa33j3lIU%2By6InvoV%2FowWHBzA0QeFPBh6vmJ8LoUPJqGE7q0PRz618Z4ym1AGq%2BaomSq9PlP4rCduv9Cmtxu%2FrvPSBwocs0GCWDE8seK8t9epmPQW7gwODxkAiKr9UxhJd9KvmBVuAQPf%2BoFQVo86USXkhXqTvUzB2bNUYY9FCy3CWgZFTOa1D3H1CVxf1eHzYIswNA7SmOzP%2FBX8g6%2B0hkzwMRkcit3gBNs4evAVJiqAgYvUlrtGwwv9bFx4X7jWSHY4%3D&cipherSalt=yANeDq09bwM38SJs + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateVerification - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3925,13 +5375,81 @@ paths: description: Strongly encouraged if using the auto channel. The IP address of the client's device. If provided, it has to be a valid IPv4 or IPv6 address. + RiskCheck: + type: string + $ref: '#/components/schemas/verification_enum_risk_check' + description: 'Risk_check overrides Fraud Prevention measures like + Fraud Guard, Geo Permissions etc per verification attempt basis, + allowing Verify to block traffic considered fraudulent if enabled + or bypass active protections if disabled. Can be: `enable`(default) + or `disable`. For SMS channel only.' + Tags: + type: string + description: A string containing a JSON map of key value pairs of + tags to be recorded as metadata for the message. The object may + contain up to 10 tags. Keys and values can each be up to 128 characters + in length. required: - To - Channel + examples: + createVerification: + value: + To: '+15017122661' + Channel: sms + CustomCode: custom_code + CustomFriendlyName: custom_friendly_name + CustomMessage: custom_message + SendDigits: ww1 + Locale: en + Amount: "\u20AC39.99" + Payee: Acme Inc. + AppHash: AAAAAAAAAAA + TemplateSid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + TemplateCustomSubstitutions: '{"AppName": "MyApp", "Contact":"12345689"}' + 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 /v2/Services/{ServiceSid}/Verifications/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -3940,10 +5458,12 @@ paths: - status - valid - date_created - pathType: instance parent: /Services/{Sid} + pathType: instance post: description: Update a Verification status + tags: + - VerifyV2Verification parameters: - name: ServiceSid in: path @@ -3968,12 +5488,51 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' + examples: + updateVerification: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: canceled + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: SMS + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + approveVerificationWithPn: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: approved + valid: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: SMS + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateVerification - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3988,8 +5547,17 @@ paths: or `approved`.' required: - Status + examples: + updateVerification: + value: + Status: canceled + approveVerificationWithPn: + value: + Status: approved get: description: Fetch a specific Verification + tags: + - VerifyV2Verification parameters: - name: ServiceSid in: path @@ -4014,16 +5582,35 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' + examples: + fetchVerification: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: SMS + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchVerification - x-maturity: - - GA /v2/Attempts: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4031,22 +5618,26 @@ paths: - date_updated - conversion_status - channel - pathType: list mountName: verification_attempts + pathType: list get: description: List all the verification attempts for a given Account. + tags: + - VerifyV2VerificationAttempt parameters: - name: DateCreatedAfter in: query - description: Datetime filter used to query Verification Attempts created after - this datetime. Given as GMT in RFC 2822 format. + description: 'Datetime filter used to consider only Verification Attempts + created after this datetime on the summary aggregation. Given as GMT in + ISO 8601 formatted datetime string: yyyy-MM-dd''T''HH:mm:ss''Z.' schema: type: string format: date-time - name: DateCreatedBefore in: query - description: Datetime filter used to query Verification Attempts created before - this datetime. Given as GMT in RFC 2822 format. + description: 'Datetime filter used to consider only Verification Attempts + created before this datetime on the summary aggregation. Given as GMT in + ISO 8601 formatted datetime string: yyyy-MM-dd''T''HH:mm:ss''Z.' schema: type: string format: date-time @@ -4055,6 +5646,10 @@ paths: description: Destination of a verification. It is phone number in E.164 format. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: Country in: query description: Filter used to query Verification Attempts sent to the specified @@ -4127,38 +5722,83 @@ paths: items: $ref: '#/components/schemas/verify.v2.verification_attempt' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + listVerificationAttemptsEmpty: + value: + attempts: [] + meta: + key: attempts + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 + next_page_url: null + listVerificationAttempts: + value: + attempts: + - sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-08-11T18:36:59Z' + date_updated: '2020-08-11T18:37:00Z' + conversion_status: unconverted + channel: sms + price: + value: '0.005' + currency: usd + channel_data: + verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+573003003030' + status: unconfirmed + message_status: undelivered + error_code: '30008' + country: CO + code_length: 6 + locale: es + mcc: '732' + mnc: '103' + carrier: Colombia Movil (Tigo) + url: https://verify.twilio.com/v2/Attempts/VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + key: attempts + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 + next_page_url: null description: OK security: - accountSid_authToken: [] operationId: ListVerificationAttempt - x-maturity: - - GA /v2/Attempts/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4166,10 +5806,12 @@ paths: - date_updated - conversion_status - channel - pathType: instance mountName: verification_attempts + pathType: instance get: description: Fetch a specific verification attempt. + tags: + - VerifyV2VerificationAttempt parameters: - name: Sid in: path @@ -4186,27 +5828,54 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.verification_attempt' + examples: + fetchVerificationAttempt: + value: + sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-08-11T18:36:59Z' + date_updated: '2020-08-11T18:37:00Z' + conversion_status: unconverted + channel: sms + price: + value: '0.005' + currency: usd + channel_data: + verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+573003003030' + status: unconfirmed + message_status: undelivered + error_code: '30008' + country: CO + code_length: 6 + locale: es + mcc: '732' + mnc: '103' + carrier: Colombia Movil (Tigo) + url: https://verify.twilio.com/v2/Attempts/VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchVerificationAttempt - x-maturity: - - GA /v2/Attempts/Summary: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - total_attempts - total_converted - total_unconverted - conversion_rate_percentage - pathType: instance mountName: verification_attempts_summary + pathType: instance get: description: Get a summary of how many attempts were made and how many were converted. + tags: + - VerifyV2VerificationAttemptsSummary parameters: - name: VerifyServiceSid in: query @@ -4217,22 +5886,31 @@ paths: minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ + examples: + getAttemptsSummary: + value: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: DateCreatedAfter in: query - description: Datetime filter used to consider only Verification Attempts created - after this datetime on the summary aggregation. Given as GMT in RFC 2822 - format. + description: 'Datetime filter used to consider only Verification Attempts + created after this datetime on the summary aggregation. Given as GMT in + ISO 8601 formatted datetime string: yyyy-MM-dd''T''HH:mm:ss''Z.' schema: type: string format: date-time + examples: + getAttemptsSummary: + value: '2022-03-02T21:02:33Z' - name: DateCreatedBefore in: query - description: Datetime filter used to consider only Verification Attempts created - before this datetime on the summary aggregation. Given as GMT in RFC 2822 - format. + description: 'Datetime filter used to consider only Verification Attempts + created before this datetime on the summary aggregation. Given as GMT in + ISO 8601 formatted datetime string: yyyy-MM-dd''T''HH:mm:ss''Z.' schema: type: string format: date-time + examples: + getAttemptsSummary: + value: '2022-03-02T21:02:33Z' - name: Country in: query description: Filter used to consider only Verification Attempts sent to the @@ -4240,35 +5918,50 @@ paths: schema: type: string format: iso-country-code + examples: + getAttemptsSummary: + value: CO - name: Channel in: query description: Filter Verification Attempts considered on the summary aggregation - by communication channel. Valid values are `SMS` and `CALL` + by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP` schema: type: string $ref: '#/components/schemas/verification_attempts_summary_enum_channels' + examples: + getAttemptsSummary: + value: sms - name: DestinationPrefix in: query description: Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format. schema: type: string + examples: + getAttemptsSummary: + value: '+57305' responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.verification_attempts_summary' + examples: + getAttemptsSummary: + value: + total_attempts: 11 + total_converted: 9 + total_unconverted: 2 + conversion_rate_percentage: '81.818181818' + url: https://verify.twilio.com/v2/Attempts/Summary description: OK security: - accountSid_authToken: [] operationId: FetchVerificationAttemptsSummary - x-maturity: - - GA /v2/Services/{ServiceSid}/VerificationCheck: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4277,11 +5970,13 @@ paths: - status - valid - date_created - pathType: list parent: /Services/{Sid} mountName: verification_checks + pathType: list post: description: challenge a specific Verification Check. + tags: + - VerifyV2VerificationCheck parameters: - name: ServiceSid in: path @@ -4299,12 +5994,55 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification_check' + examples: + verificationChecks: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: approved + valid: true + amount: null + payee: null + sna_attempts_error_codes: [] + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + emailVerificationChecks: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: recipient@foo.com + channel: email + status: approved + valid: true + amount: null + payee: null + sna_attempts_error_codes: [] + date_created: '2020-01-30T20:00:00Z' + date_updated: '2020-01-30T20:00:00Z' + snaVerificationChecks: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sna + status: approved + valid: true + amount: null + payee: null + sna_attempts_error_codes: + - attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + code: 60001 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: Created security: - accountSid_authToken: [] operationId: CreateVerificationCheck - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4336,10 +6074,26 @@ paths: type: string description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. + examples: + verificationChecks: + value: + To: '+15017122661' + VerificationSid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Code: '1234' + Amount: "\u20AC39.99" + Payee: Acme Inc. + emailVerificationChecks: + value: + To: recipient@foo.com + VerificationSid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Code: '123456' + snaVerificationChecks: + value: + To: '+15017122661' /v2/Templates: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4347,6 +6101,8 @@ paths: pathType: list get: description: List all the available templates for a given Account. + tags: + - VerifyV2Template parameters: - name: FriendlyName in: query @@ -4385,38 +6141,77 @@ paths: items: $ref: '#/components/schemas/verify.v2.verification_template' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + listVerificationTemplates: + value: + templates: + - sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Base Verification Template 2 with do not share + channels: + - sms + translations: + en: + is_default_translation: true + status: approved + locale: en + text: 'Your {{friendly_name}} verification code is: {{code}}. + Do not share this code with anyone.' + date_updated: '2021-07-29T20:38:28.759979905Z' + date_created: '2021-07-29T20:38:28.165602325Z' + - sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Base Verification Template 3 + channels: + - sms + - voice + translations: + en: + is_default_translation: true + status: approved + locale: en + text: 'Your verification code is: {{code}}. Do not share + it.' + date_updated: '2021-07-29T20:38:28.759979905Z' + date_created: '2021-07-29T20:38:28.165602325Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Templates?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Templates?PageSize=50&Page=0 + next_page_url: null + key: templates description: OK security: - accountSid_authToken: [] operationId: ListVerificationTemplate - x-maturity: - - GA /v2/Services/{ServiceSid}/Webhooks: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4427,10 +6222,12 @@ paths: - webhook_method - status - date_created - pathType: list parent: /Services/{Sid} + pathType: list post: description: Create a new Webhook for the Service + tags: + - VerifyV2Webhook parameters: - name: ServiceSid in: path @@ -4447,12 +6244,27 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' + examples: + create: + value: + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + event_types: + - factor.deleted + - factor.verified + webhook_method: POST + webhook_url: https://owlbank.twilio.com + status: enabled + version: v2 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: Created security: - accountSid_authToken: [] operationId: CreateWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4489,8 +6301,19 @@ paths: - FriendlyName - EventTypes - WebhookUrl + examples: + create: + value: + FriendlyName: name + EventTypes: + - factor.deleted + - factor.verified + WebhookUrl: https://owlbank.twilio.com + Version: v2 get: description: Retrieve a list of all Webhooks for a Service. + tags: + - VerifyV2Webhook parameters: - name: ServiceSid in: path @@ -4533,38 +6356,73 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.webhook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + webhooks: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + next_page_url: null + key: webhooks + readFull: + value: + webhooks: + - url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + event_types: + - factor.deleted + - factor.verified + webhook_method: POST + webhook_url: https://owlbank.twilio.com + status: enabled + version: v2 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + next_page_url: null + key: webhooks description: OK security: - accountSid_authToken: [] operationId: ListWebhook - x-maturity: - - GA /v2/Services/{ServiceSid}/Webhooks/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4575,10 +6433,12 @@ paths: - webhook_method - status - date_created - pathType: instance parent: /Services/{Sid} + pathType: instance post: description: '' + tags: + - VerifyV2Webhook parameters: - name: ServiceSid in: path @@ -4605,12 +6465,27 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' + examples: + update: + value: + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + event_types: + - factor.deleted + - factor.verified + webhook_method: POST + webhook_url: https://owlbank.twilio.com + status: disabled + version: v2 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: OK security: - accountSid_authToken: [] operationId: UpdateWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4643,8 +6518,20 @@ paths: description: The webhook version. Default value is `v2` which includes all the latest fields. Version `v1` is legacy and may be removed in the future. + examples: + update: + value: + FriendlyName: name + EventTypes: + - factor.deleted + - factor.verified + WebhookUrl: https://owlbank.twilio.com + Status: disabled + Version: v2 delete: description: Delete a specific Webhook. + tags: + - VerifyV2Webhook parameters: - name: ServiceSid in: path @@ -4671,10 +6558,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteWebhook - x-maturity: - - GA get: description: Fetch a specific Webhook. + tags: + - VerifyV2Webhook parameters: - name: ServiceSid in: path @@ -4701,17 +6588,47 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' + examples: + fetch: + value: + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + event_types: + - factor.deleted + - factor.verified + webhook_method: POST + webhook_url: https://owlbank.twilio.com + status: enabled + version: v2 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: OK security: - accountSid_authToken: [] operationId: FetchWebhook - x-maturity: - - GA servers: - url: https://verify.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. +tags: +- name: VerifyV2AccessToken +- name: VerifyV2Bucket +- name: VerifyV2Challenge +- name: VerifyV2Entity +- name: VerifyV2Factor +- name: VerifyV2Form +- name: VerifyV2MessagingConfiguration +- name: VerifyV2NewFactor +- name: VerifyV2Notification +- name: VerifyV2RateLimit +- name: VerifyV2Safelist +- name: VerifyV2Service +- name: VerifyV2Template +- name: VerifyV2Verification +- name: VerifyV2VerificationAttempt +- name: VerifyV2VerificationAttemptsSummary +- name: VerifyV2VerificationCheck +- name: VerifyV2Webhook +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_video_v1.yaml b/spec/yaml/twilio_video_v1.yaml index d19af828..8db0b146 100644 --- a/spec/yaml/twilio_video_v1.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: video.v1.composition: type: object @@ -71,6 +75,10 @@ components: can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. + x-twilio: + pii: + handling: standard + deleteSla: 30 audio_sources_excluded: type: array items: @@ -82,11 +90,19 @@ components: property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty. + x-twilio: + pii: + handling: standard + deleteSla: 30 video_layout: nullable: true description: An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 resolution: type: string nullable: true @@ -226,6 +242,10 @@ components: in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request + x-twilio: + pii: + handling: standard + deleteSla: 30 audio_sources_excluded: type: array items: @@ -238,6 +258,10 @@ components: can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty. + x-twilio: + pii: + handling: standard + deleteSla: 30 video_layout: nullable: true description: A JSON object that describes the video layout of the composition @@ -245,6 +269,10 @@ components: the CompositionHook resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request + x-twilio: + pii: + handling: standard + deleteSla: 30 resolution: type: string nullable: true @@ -329,7 +357,7 @@ components: We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in - the RFC 3986. + the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2). aws_storage_enabled: type: boolean nullable: true @@ -436,6 +464,10 @@ components: nullable: true description: The name that was given to the source track of the recording. If no name is given, the `source_sid` is used. + x-twilio: + pii: + handling: standard + deleteSla: 30 offset: type: integer format: int64 @@ -531,7 +563,7 @@ components: We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the - RFC 3986. + [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2). aws_storage_enabled: type: boolean nullable: true @@ -678,7 +710,7 @@ components: type: string nullable: true description: 'The region for the media server in Group Rooms. Can be: one - of the [available Media Regions](https://www.twilio.com/docs/video/ip-address-whitelisting#media-servers). + of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#media-servers). ***This feature is not available in `peer-to-peer` rooms.***' audio_only: type: boolean @@ -1248,10 +1280,6 @@ components: nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Video description: This is the public Twilio REST API. @@ -1263,7 +1291,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Compositions/{Sid}: @@ -1276,12 +1304,17 @@ paths: - status - resolution - format - pathType: instance dependentProperties: - video/v1/composition_media: '{composition_sid: sid}' + media: + mapping: + composition_sid: sid + resource_url: /v1/Compositions/{composition_sid}/Media + pathType: instance get: description: Returns a single Composition resource identified by a Composition SID. + tags: + - VideoV1Composition parameters: - name: Sid in: path @@ -1298,15 +1331,71 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.composition' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + date_created: '2015-07-30T20:00:00Z' + date_completed: '2015-07-30T20:01:33Z' + date_deleted: null + sid: CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - user* + audio_sources_excluded: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + video_layout: + grid: + video_sources: + - '*' + video_sources_excluded: + - MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + pip: + video_sources: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + video_sources_excluded: [] + reuse: none + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + resolution: 1280x720 + format: webm + bitrate: 64 + size: 4 + duration: 6 + trim: true + media_external_location: null + encryption_key: null + url: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status_callback: https://mycallbackurl.com + status_callback_method: POST + links: + media: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media description: OK security: - accountSid_authToken: [] operationId: FetchComposition - x-maturity: - - GA delete: description: Delete a Recording Composition resource identified by a Composition SID. + tags: + - VideoV1Composition parameters: - name: Sid in: path @@ -1323,8 +1412,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteComposition - x-maturity: - - GA /v1/Compositions: servers: - url: https://video.twilio.com @@ -1335,11 +1422,16 @@ paths: - status - resolution - format - pathType: list dependentProperties: - video/v1/composition_media: '{composition_sid: sid}' + media: + mapping: + composition_sid: sid + resource_url: /v1/Compositions/{composition_sid}/Media + pathType: list get: description: List of all Recording compositions. + tags: + - VideoV1Composition parameters: - name: Status in: query @@ -1348,6 +1440,13 @@ paths: schema: type: string $ref: '#/components/schemas/composition_enum_status' + examples: + readEnqueued: + value: enqueued + readEmpty: + value: completed + readResults: + value: completed - name: DateCreatedAfter in: query description: Read only Composition resources created on or after this [ISO @@ -1355,6 +1454,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-01-01T00:00:01Z' - name: DateCreatedBefore in: query description: Read only Composition resources created before this ISO 8601 @@ -1362,6 +1464,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-12-31T23:59:59Z' - name: RoomSid in: query description: Read only Composition resources with this Room SID. @@ -1370,6 +1475,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^RM[0-9a-fA-F]{32}$ + examples: + readResults: + value: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1402,48 +1510,176 @@ paths: items: $ref: '#/components/schemas/video.v1.composition' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEnqueued: + value: + compositions: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://video.twilio.com/v1/Compositions?Status=enqueued&PageSize=10&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Compositions?Status=enqueued&PageSize=10&Page=0 + next_page_url: null + key: compositions + readEmpty: + value: + compositions: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Compositions?Status=completed&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Compositions?Status=completed&PageSize=50&Page=0 + next_page_url: null + key: compositions + readResults: + value: + compositions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + date_created: '2015-07-30T20:00:00Z' + date_completed: '2015-07-30T20:01:33Z' + date_deleted: null + sid: CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - user* + audio_sources_excluded: [] + video_layout: + grid: + video_sources: + - user* + video_sources_excluded: [] + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + pip: + video_sources: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + video_sources_excluded: [] + reuse: none + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + resolution: 1280x720 + format: webm + bitrate: 64 + size: 4 + duration: 6 + trim: true + media_external_location: null + encryption_key: null + url: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status_callback: https://mycallbackurl.com + status_callback_method: POST + links: + media: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Compositions?Status=completed&RoomSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Compositions?Status=completed&RoomSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&PageSize=50&Page=0 + next_page_url: null + key: compositions description: OK security: - accountSid_authToken: [] operationId: ListComposition - x-maturity: - - GA post: description: '' + tags: + - VideoV1Composition responses: '201': content: application/json: schema: $ref: '#/components/schemas/video.v1.composition' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: processing + date_created: '2015-07-30T20:00:00Z' + date_completed: null + date_deleted: null + sid: CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - user* + audio_sources_excluded: + - RTbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + video_layout: + custom: + video_sources: + - user* + video_sources_excluded: + - RTcaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 800 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: + - 2 + - 3 + trim: true + format: mp4 + resolution: 1920x1080 + bitrate: 0 + size: 0 + duration: 0 + media_external_location: null + encryption_key: null + url: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status_callback: https://mycallbackurl.com + status_callback_method: POST + links: + media: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media description: Created security: - accountSid_authToken: [] operationId: CreateComposition - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1537,6 +1773,19 @@ paths: for more info. required: - RoomSid + examples: + create: + value: + RoomSid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + AudioSources: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - user* + AudioSourcesExcluded: + - RTbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VideoLayout: '{}' + Trim: true + Format: mp4 + Resolution: 1920x1080 /v1/CompositionHooks/{Sid}: servers: - url: https://video.twilio.com @@ -1550,6 +1799,8 @@ paths: get: description: Returns a single CompositionHook resource identified by a CompositionHook SID. + tags: + - VideoV1CompositionHook parameters: - name: Sid in: path @@ -1566,15 +1817,62 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.composition_hook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My composition hook + enabled: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - user* + audio_sources_excluded: + - moderator* + video_layout: + grid: + video_sources: + - '*' + video_sources_excluded: + - moderator* + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + pip: + video_sources: + - student* + video_sources_excluded: [] + reuse: none + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + resolution: 1280x720 + format: webm + trim: true + status_callback: http://www.example.com + status_callback_method: POST + url: https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCompositionHook - x-maturity: - - GA delete: description: Delete a Recording CompositionHook resource identified by a `CompositionHook SID`. + tags: + - VideoV1CompositionHook parameters: - name: Sid in: path @@ -1591,10 +1889,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCompositionHook - x-maturity: - - GA post: description: '' + tags: + - VideoV1CompositionHook parameters: - name: Sid in: path @@ -1611,12 +1909,67 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.composition_hook' + examples: + updateAllFields: + value: + friendly_name: My composition hook + enabled: true + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + sid: HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - user* + - moderator + audio_sources_excluded: + - admin + video_layout: + custom: + video_sources: + - user* + video_sources_excluded: + - moderator + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 800 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: + - 2 + - 3 + trim: true + format: mp4 + resolution: 1280x720 + status_callback: http://www.example.com + status_callback_method: POST + url: https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateWithDefaults: + value: + friendly_name: My composition hook + enabled: true + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + sid: HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - user* + - moderator + audio_sources_excluded: + - admin + video_layout: {} + trim: true + format: mp4 + resolution: 1280x720 + status_callback: null + status_callback_method: POST + url: https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCompositionHook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1713,6 +2066,32 @@ paths: Can be: `POST` or `GET` and the default is `POST`.' required: - FriendlyName + examples: + updateAllFields: + value: + FriendlyName: My composition hook + Enabled: true + AudioSources: + - user* + - moderator + AudioSourcesExcluded: + - admin + VideoLayout: '{}' + Trim: true + Format: mp4 + Resolution: 1280x720 + StatusCallback: http://www.example.com + StatusCallbackMethod: POST + updateWithDefaults: + value: + FriendlyName: My composition hook + AudioSources: + - user* + - moderator + AudioSourcesExcluded: + - admin + Format: mp4 + Resolution: 1280x720 /v1/CompositionHooks: servers: - url: https://video.twilio.com @@ -1725,6 +2104,8 @@ paths: pathType: list get: description: List of all Recording CompositionHook resources. + tags: + - VideoV1CompositionHook parameters: - name: Enabled in: query @@ -1732,6 +2113,11 @@ paths: matches this parameter. schema: type: boolean + examples: + readEmpty: + value: true + readResults: + value: true - name: DateCreatedAfter in: query description: Read only CompositionHook resources created on or after this @@ -1739,6 +2125,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-01-01T00:00:01Z' - name: DateCreatedBefore in: query description: Read only CompositionHook resources created before this [ISO @@ -1746,6 +2135,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-12-31T23:59:59Z' - name: FriendlyName in: query description: Read only CompositionHook resources with friendly names that @@ -1753,6 +2145,9 @@ paths: `*` characters as wildcard match. schema: type: string + examples: + readResults: + value: '*Hook*' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1785,48 +2180,149 @@ paths: items: $ref: '#/components/schemas/video.v1.composition_hook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + composition_hooks: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/CompositionHooks?Enabled=True&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/CompositionHooks?Enabled=True&PageSize=50&Page=0 + next_page_url: null + key: composition_hooks + readResults: + value: + composition_hooks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My Special Hook1 + enabled: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - '*' + audio_sources_excluded: [] + video_layout: + grid: + video_sources: + - '*' + video_sources_excluded: + - moderator* + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + pip: + video_sources: + - student* + video_sources_excluded: [] + reuse: none + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + resolution: 1280x720 + format: webm + trim: true + status_callback: http://www.example.com + status_callback_method: POST + url: https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/CompositionHooks?FriendlyName=%2AHook%2A&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&Enabled=True&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/CompositionHooks?FriendlyName=%2AHook%2A&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&Enabled=True&PageSize=50&Page=0 + next_page_url: null + key: composition_hooks description: OK security: - accountSid_authToken: [] operationId: ListCompositionHook - x-maturity: - - GA post: description: '' + tags: + - VideoV1CompositionHook responses: '201': content: application/json: schema: $ref: '#/components/schemas/video.v1.composition_hook' + examples: + create: + value: + friendly_name: My composition hook + enabled: false + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: null + sid: HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - user* + - moderator + audio_sources_excluded: + - admin + video_layout: + custom: + video_sources: + - user* + video_sources_excluded: + - moderator + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 800 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: + - 2 + - 3 + trim: true + format: mp4 + resolution: 1280x720 + status_callback: http://www.example.com + status_callback_method: POST + url: https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCompositionHook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1923,6 +2419,22 @@ paths: for more info. required: - FriendlyName + examples: + create: + value: + FriendlyName: My composition hook + Enabled: false + AudioSources: + - user* + - moderator + AudioSourcesExcluded: + - admin + VideoLayout: '{}' + Trim: true + Format: mp4 + Resolution: 1280x720 + StatusCallback: http://www.example.com + StatusCallbackMethod: POST /v1/CompositionSettings/Default: servers: - url: https://video.twilio.com @@ -1932,37 +2444,59 @@ paths: - friendly_name - aws_storage_enabled - encryption_enabled - pathType: instance mountName: composition_settings className: composition_settings + pathType: instance get: description: '' + tags: + - VideoV1CompositionSettings responses: '200': content: application/json: schema: $ref: '#/components/schemas/video.v1.composition_settings' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: string + aws_credentials_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aws_s3_url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + aws_storage_enabled: true + encryption_enabled: true + url: https://video.twilio.com/v1/CompositionSettings/Default description: OK security: - accountSid_authToken: [] operationId: FetchCompositionSettings - x-maturity: - - GA post: description: '' + tags: + - VideoV1CompositionSettings responses: '201': content: application/json: schema: $ref: '#/components/schemas/video.v1.composition_settings' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + aws_credentials_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aws_s3_url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + aws_storage_enabled: true + encryption_enabled: true + url: https://video.twilio.com/v1/CompositionSettings/Default description: Created security: - accountSid_authToken: [] operationId: CreateCompositionSettings - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1993,8 +2527,7 @@ paths: should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described - in the RFC - 3986. + in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2). AwsStorageEnabled: type: boolean description: Whether all compositions should be written to the `aws_s3_url`. @@ -2005,6 +2538,15 @@ paths: form. The default is `false`. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name + AwsCredentialsSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + EncryptionKeySid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + AwsS3Url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + AwsStorageEnabled: true + EncryptionEnabled: true /v1/Recordings/{Sid}: servers: - url: https://video.twilio.com @@ -2017,11 +2559,16 @@ paths: - type - duration - codec - pathType: instance dependentProperties: - video/v1/recording_media: '{recording_sid: sid}' + media: + mapping: + recording_sid: sid + resource_url: /v1/Recordings/{recording_sid}/Media + pathType: instance get: description: Returns a single Recording resource identified by a Recording SID. + tags: + - VideoV1Recording parameters: - name: Sid in: path @@ -2038,14 +2585,40 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: processing + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T21:00:00Z' + date_deleted: '2015-07-30T22:00:00Z' + sid: RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 0 + url: https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: audio + duration: 0 + container_format: mka + codec: OPUS + track_name: A name + offset: 10 + status_callback: https://mycallbackurl.com + status_callback_method: POST + grouping_sids: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_external_location: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + encryption_key: public_key + links: + media: https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media description: OK security: - accountSid_authToken: [] operationId: FetchRecording - x-maturity: - - GA delete: description: Delete a Recording resource identified by a Recording SID. + tags: + - VideoV1Recording parameters: - name: Sid in: path @@ -2062,8 +2635,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRecording - x-maturity: - - GA /v1/Recordings: servers: - url: https://video.twilio.com @@ -2076,11 +2647,16 @@ paths: - type - duration - codec - pathType: list dependentProperties: - video/v1/recording_media: '{recording_sid: sid}' + media: + mapping: + recording_sid: sid + resource_url: /v1/Recordings/{recording_sid}/Media + pathType: list get: description: List of all Track recordings. + tags: + - VideoV1Recording parameters: - name: Status in: query @@ -2089,6 +2665,11 @@ paths: schema: type: string $ref: '#/components/schemas/recording_enum_status' + examples: + readEmpty: + value: completed + readResults: + value: completed - name: SourceSid in: query description: Read only the recordings that have this `source_sid`. @@ -2097,6 +2678,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: source_sid + readResults: + value: source_sid - name: GroupingSid in: query description: Read only recordings with this `grouping_sid`, which may include @@ -2108,6 +2694,14 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: + - RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readResults: + value: + - RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: DateCreatedAfter in: query description: Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2115,6 +2709,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-01-01T00:00:01Z' - name: DateCreatedBefore in: query description: Read only recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2122,6 +2719,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-12-31T23:59:59Z' - name: MediaType in: query description: Read only recordings that have this media type. Can be either @@ -2129,6 +2729,11 @@ paths: schema: type: string $ref: '#/components/schemas/recording_enum_type' + examples: + readEmpty: + value: audio + readResults: + value: audio - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2161,34 +2766,79 @@ paths: items: $ref: '#/components/schemas/video.v1.recording' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + recordings: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Recordings?Status=completed&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Recordings?Status=completed&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: recordings + readResults: + value: + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T21:00:00Z' + date_deleted: '2015-07-30T22:00:00Z' + sid: RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 23 + type: audio + duration: 10 + container_format: mka + codec: OPUS + track_name: A name + offset: 10 + status_callback: https://mycallbackurl.com + status_callback_method: POST + grouping_sids: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_external_location: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + encryption_key: public_key + url: https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + media: https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Recordings?Status=completed&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Recordings?Status=completed&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: recordings description: OK security: - accountSid_authToken: [] operationId: ListRecording - x-maturity: - - GA /v1/RecordingSettings/Default: servers: - url: https://video.twilio.com @@ -2198,37 +2848,59 @@ paths: - friendly_name - aws_storage_enabled - encryption_enabled - pathType: instance mountName: recording_settings className: recording_settings + pathType: instance get: description: '' + tags: + - VideoV1RecordingSettings responses: '200': content: application/json: schema: $ref: '#/components/schemas/video.v1.recording_settings' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: string + aws_credentials_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aws_s3_url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + aws_storage_enabled: true + encryption_enabled: true + url: https://video.twilio.com/v1/RecordingSettings/Default description: OK security: - accountSid_authToken: [] operationId: FetchRecordingSettings - x-maturity: - - GA post: description: '' + tags: + - VideoV1RecordingSettings responses: '201': content: application/json: schema: $ref: '#/components/schemas/video.v1.recording_settings' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + aws_credentials_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aws_s3_url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + aws_storage_enabled: true + encryption_enabled: true + url: https://video.twilio.com/v1/RecordingSettings/Default description: Created security: - accountSid_authToken: [] operationId: CreateRecordingSettings - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2259,8 +2931,7 @@ paths: be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described - in the RFC - 3986. + in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2). AwsStorageEnabled: type: boolean description: Whether all recordings should be written to the `aws_s3_url`. @@ -2271,6 +2942,15 @@ paths: form. The default is `false`. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name + AwsCredentialsSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + EncryptionKeySid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + AwsS3Url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + AwsStorageEnabled: true + EncryptionEnabled: true /v1/Rooms/{Sid}: servers: - url: https://video.twilio.com @@ -2280,13 +2960,24 @@ paths: - sid - unique_name - status - pathType: instance dependentProperties: - room_recording: '{room_sid: sid}' - participant: '{room_sid: sid}' - recording_rules: '{room_sid: sid}' + recordings: + mapping: + room_sid: sid + resource_url: /v1/Rooms/{room_sid}/Recordings + participants: + mapping: + room_sid: sid + resource_url: /v1/Rooms/{room_sid}/Participants + recording_rules: + mapping: + room_sid: sid + resource_url: /v1/Rooms/{room_sid}/RecordingRules + pathType: instance get: description: '' + tags: + - VideoV1Room parameters: - name: Sid in: path @@ -2300,14 +2991,45 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: peer-to-peer + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: unique_name + max_participants: 10 + max_participant_duration: 86400 + max_concurrent_published_tracks: 0 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + audio_only: false + media_region: us1 + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules description: OK security: - accountSid_authToken: [] operationId: FetchRoom - x-maturity: - - GA post: description: '' + tags: + - VideoV1Room parameters: - name: Sid in: path @@ -2321,12 +3043,41 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: completed + type: peer-to-peer + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: unique_name + max_participants: 10 + max_participant_duration: 86400 + max_concurrent_published_tracks: 10 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + duration: 10 + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules description: OK security: - accountSid_authToken: [] operationId: UpdateRoom - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2341,6 +3092,10 @@ paths: to end the room. required: - Status + examples: + update: + value: + Status: completed /v1/Rooms: servers: - url: https://video.twilio.com @@ -2350,25 +3105,243 @@ paths: - sid - unique_name - status - pathType: list dependentProperties: - room_recording: '{room_sid: sid}' - participant: '{room_sid: sid}' - recording_rules: '{room_sid: sid}' + recordings: + mapping: + room_sid: sid + resource_url: /v1/Rooms/{room_sid}/Recordings + participants: + mapping: + room_sid: sid + resource_url: /v1/Rooms/{room_sid}/Participants + recording_rules: + mapping: + room_sid: sid + resource_url: /v1/Rooms/{room_sid}/RecordingRules + pathType: list post: description: '' + tags: + - VideoV1Room responses: '201': content: application/json: schema: $ref: '#/components/schemas/video.v1.room' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: peer-to-peer + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + max_concurrent_published_tracks: 0 + max_participants: 10 + max_participant_duration: 86400 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createWebrtcGo: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: go + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: room1 + max_participants: 10 + max_participant_duration: 86400 + max_concurrent_published_tracks: 0 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createGroupRooms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: group + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: grouproom + max_participants: 50 + max_participant_duration: 86400 + max_concurrent_published_tracks: 170 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createGroupRoomsWithAudioOnlyEnabled: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: group + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: grouproom + max_participants: 50 + max_participant_duration: 86400 + max_concurrent_published_tracks: 170 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: [] + media_region: us1 + audio_only: true + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createSmallGroupRooms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: group-small + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: SmallDailyStandup + max_participants: 4 + max_participant_duration: 86400 + max_concurrent_published_tracks: 170 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createLargeGroupRooms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: group + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: MyWebinar + max_participants: 50 + max_participant_duration: 86400 + max_concurrent_published_tracks: 16 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createLargeGroupRoomsWithAudioOnlyEnabled: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: group + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: MyWebinar + max_participants: 50 + max_participant_duration: 86400 + max_concurrent_published_tracks: 16 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: [] + media_region: us1 + audio_only: true + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules description: Created security: - accountSid_authToken: [] operationId: CreateRoom - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2434,7 +3407,7 @@ paths: MediaRegion: type: string description: 'The region for the media server in Group Rooms. Can - be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-address-whitelisting#group-rooms-media-servers). + be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#group-rooms-media-servers). ***This feature is not available in `peer-to-peer` rooms.***' RecordingRules: description: A collection of Recording Rules that describe how to @@ -2463,8 +3436,43 @@ paths: type: boolean description: When set to true, indicated that this is the large room. + examples: + create: + value: {} + createWebrtcGo: + value: + Type: go + UniqueName: room1 + createGroupRooms: + value: + Type: group + UniqueName: grouproom + RecordingRules: '%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D' + createGroupRoomsWithAudioOnlyEnabled: + value: + Type: group + UniqueName: grouproom + RecordingRules: '%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D' + AudioOnly: true + createSmallGroupRooms: + value: + Type: group-small + UniqueName: SmallDailyStandup + createLargeGroupRooms: + value: + Type: group + UniqueName: MyWebinar + MaxParticipants: 90 + createLargeGroupRoomsWithAudioOnlyEnabled: + value: + Type: group + UniqueName: MyWebinar + MaxParticipants: 90 + AudioOnly: true get: description: '' + tags: + - VideoV1Room parameters: - name: Status in: query @@ -2473,6 +3481,9 @@ paths: schema: type: string $ref: '#/components/schemas/room_enum_room_status' + examples: + readWithStatus: + value: completed - name: UniqueName in: query description: Read only rooms with the this `unique_name`. @@ -2523,34 +3534,83 @@ paths: items: $ref: '#/components/schemas/video.v1.room' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + rooms: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms?PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms?PageSize=50&Page=0 + next_page_url: null + key: rooms + readWithStatus: + value: + rooms: + - sid: RM4070b618362c1682b2385b1f9982833c + status: completed + date_created: '2017-04-03T22:21:49Z' + date_updated: '2017-04-03T22:21:51Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: peer-to-peer + enable_turn: true + unique_name: RM4070b618362c1682b2385b1f9982833c + status_callback: null + status_callback_method: POST + end_time: '2017-04-03T22:21:51Z' + duration: 2 + max_participants: 10 + max_participant_duration: 86400 + max_concurrent_published_tracks: 10 + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + large_room: false + url: https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c + links: + participants: https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/Participants + recordings: https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/RecordingRules + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms?Status=completed&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms?Status=completed&PageSize=50&Page=0 + next_page_url: null + key: rooms description: OK security: - accountSid_authToken: [] operationId: ListRoom - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{Sid}: servers: - url: https://video.twilio.com @@ -2560,15 +3620,33 @@ paths: - sid - identity - status - pathType: instance dependentProperties: - published_track: '{room_sid: room_sid, participant_sid: sid}' - subscribed_track: '{room_sid: room_sid, participant_sid: sid}' - subscribe_rules: '{room_sid: room_sid, participant_sid: sid}' - anonymize: '{room_sid: room_sid, sid: sid}' + published_tracks: + mapping: + room_sid: room_sid + participant_sid: sid + resource_url: /v1/Rooms/{room_sid}/Participants/{participant_sid}/PublishedTracks + subscribed_tracks: + mapping: + room_sid: room_sid + participant_sid: sid + resource_url: /v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribedTracks + subscribe_rules: + mapping: + room_sid: room_sid + participant_sid: sid + resource_url: /v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribeRules + anonymize: + mapping: + room_sid: room_sid + sid: sid + resource_url: /v1/Rooms/{room_sid}/Participants/{sid}/Anonymize parent: /Rooms/{Sid} + pathType: instance get: description: '' + tags: + - VideoV1Participant parameters: - name: RoomSid in: path @@ -2588,14 +3666,33 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + start_time: '2015-07-30T20:00:00Z' + end_time: null + sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob + status: connected + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + duration: null + links: + published_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks + subscribed_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks + subscribe_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules + anonymize: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize description: OK security: - accountSid_authToken: [] operationId: FetchRoomParticipant - x-maturity: - - GA post: description: '' + tags: + - VideoV1Participant parameters: - name: RoomSid in: path @@ -2615,12 +3712,29 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-30T20:00:00Z' + date_updated: '2017-07-30T20:00:00Z' + start_time: '2017-07-30T20:00:00Z' + end_time: '2017-07-30T20:00:01Z' + sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: alice + status: disconnected + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + duration: 1 + links: + published_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks + subscribed_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks + subscribe_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules + anonymize: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize description: OK security: - accountSid_authToken: [] operationId: UpdateRoomParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2635,6 +3749,10 @@ paths: or `disconnected`. For `in-progress` Rooms the default Status is `connected`, for `completed` Rooms only `disconnected` Participants are returned.' + examples: + update: + value: + Status: disconnected /v1/Rooms/{RoomSid}/Participants: servers: - url: https://video.twilio.com @@ -2644,15 +3762,33 @@ paths: - sid - identity - status - pathType: list dependentProperties: - published_track: '{room_sid: room_sid, participant_sid: sid}' - subscribed_track: '{room_sid: room_sid, participant_sid: sid}' - subscribe_rules: '{room_sid: room_sid, participant_sid: sid}' - anonymize: '{room_sid: room_sid, sid: sid}' + published_tracks: + mapping: + room_sid: room_sid + participant_sid: sid + resource_url: /v1/Rooms/{room_sid}/Participants/{participant_sid}/PublishedTracks + subscribed_tracks: + mapping: + room_sid: room_sid + participant_sid: sid + resource_url: /v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribedTracks + subscribe_rules: + mapping: + room_sid: room_sid + participant_sid: sid + resource_url: /v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribeRules + anonymize: + mapping: + room_sid: room_sid + sid: sid + resource_url: /v1/Rooms/{room_sid}/Participants/{sid}/Anonymize parent: /Rooms/{Sid} + pathType: list get: description: '' + tags: + - VideoV1Participant parameters: - name: RoomSid in: path @@ -2668,12 +3804,18 @@ paths: schema: type: string $ref: '#/components/schemas/room_participant_enum_status' + examples: + readFilters: + value: disconnected - name: Identity in: query description: Read only the Participants with this [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value. schema: type: string + examples: + readFilters: + value: alice - name: DateCreatedAfter in: query description: Read only Participants that started after this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) @@ -2681,6 +3823,9 @@ paths: schema: type: string format: date-time + examples: + readFilters: + value: '2017-01-01T00:00:01Z' - name: DateCreatedBefore in: query description: Read only Participants that started before this date in [ISO @@ -2688,6 +3833,9 @@ paths: schema: type: string format: date-time + examples: + readFilters: + value: '2017-12-31T23:59:59Z' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2720,47 +3868,86 @@ paths: items: $ref: '#/components/schemas/video.v1.room.room_participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + participants: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + next_page_url: null + key: participants + readFilters: + value: + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-30T20:00:00Z' + date_updated: '2017-07-30T20:00:00Z' + start_time: '2017-07-30T20:00:00Z' + end_time: '2017-07-30T20:00:01Z' + sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: alice + status: disconnected + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + duration: 1 + links: + published_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks + subscribed_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks + subscribe_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules + anonymize: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0 + next_page_url: null + key: participants description: OK security: - accountSid_authToken: [] operationId: ListRoomParticipant - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{Sid}/Anonymize: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - status - pathType: instance parent: /Rooms/{RoomSid}/Participants/{Sid} + pathType: instance post: description: '' + tags: + - VideoV1Anonymize parameters: - name: RoomSid in: path @@ -2780,26 +3967,40 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_anonymize' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + start_time: '2015-07-30T20:00:00Z' + end_time: null + sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: disconnected + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize + duration: 1 description: OK security: - accountSid_authToken: [] operationId: UpdateRoomParticipantAnonymize - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks/{Sid}: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - name - enabled - kind - pathType: instance parent: /Rooms/{RoomSid}/Participants/{Sid} + pathType: instance get: description: Returns a single Track resource represented by TrackName or SID. + tags: + - VideoV1PublishedTrack parameters: - name: RoomSid in: path @@ -2827,27 +4028,39 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_published_track' + examples: + fetch: + value: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: bob-track + kind: data + enabled: true + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks/MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRoomParticipantPublishedTrack - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - name - enabled - kind - pathType: list parent: /Rooms/{RoomSid}/Participants/{Sid} + pathType: list get: description: Returns a list of tracks associated with a given Participant. Only `currently` Published Tracks are in the list resource. + tags: + - VideoV1PublishedTrack parameters: - name: RoomSid in: path @@ -2895,48 +4108,60 @@ paths: items: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_published_track' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + published_tracks: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0 + next_page_url: null + key: published_tracks description: OK security: - accountSid_authToken: [] operationId: ListRoomParticipantPublishedTrack - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - participant_sid - room_sid - rules - pathType: list parent: /Rooms/{RoomSid}/Participants/{Sid} className: subscribe_rules + pathType: list get: description: Returns a list of Subscribe Rules for the Participant. + tags: + - VideoV1SubscribeRules parameters: - name: RoomSid in: path @@ -2958,14 +4183,28 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule' + examples: + readEmpty: + value: + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: null + date_updated: null + rules: + - type: include + all: true + publisher: null + track: null + kind: null + priority: null description: OK security: - accountSid_authToken: [] operationId: FetchRoomParticipantSubscribeRule - x-maturity: - - GA post: description: Update the Subscribe Rules for the Participant + tags: + - VideoV1SubscribeRules parameters: - name: RoomSid in: path @@ -2986,12 +4225,24 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule' + examples: + updateFilters: + value: + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: null + date_updated: null + rules: + - type: exclude + all: true + publisher: null + track: null + kind: null + priority: null description: Accepted security: - accountSid_authToken: [] operationId: UpdateRoomParticipantSubscribeRule - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3003,22 +4254,28 @@ paths: description: A JSON-encoded array of subscribe rules. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) section for further information. + examples: + updateFilters: + value: + Rules: '%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D' /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks/{Sid}: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - name - enabled - kind - pathType: instance parent: /Rooms/{RoomSid}/Participants/{Sid} + pathType: instance get: description: 'Returns a single Track resource represented by `track_sid`. Note: This is one resource with the Video API that requires a SID, be Track Name on the subscriber side is not guaranteed to be unique.' + tags: + - VideoV1SubscribedTrack parameters: - name: RoomSid in: path @@ -3048,26 +4305,39 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_subscribed_track' + examples: + fetch: + value: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + publisher_sid: PAbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: bob-track + kind: data + enabled: true + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks/MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRoomParticipantSubscribedTrack - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - name - enabled - kind - pathType: list parent: /Rooms/{RoomSid}/Participants/{Sid} + pathType: list get: description: Returns a list of tracks that are subscribed for the participant. + tags: + - VideoV1SubscribedTrack parameters: - name: RoomSid in: path @@ -3114,34 +4384,44 @@ paths: items: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_subscribed_track' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + subscribed_tracks: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks?PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks?PageSize=50&Page=0 + next_page_url: null + key: subscribed_tracks description: OK security: - accountSid_authToken: [] operationId: ListRoomParticipantSubscribedTrack - x-maturity: - - GA /v1/Rooms/{RoomSid}/Recordings/{Sid}: servers: - url: https://video.twilio.com @@ -3154,13 +4434,19 @@ paths: - type - duration - codec - pathType: instance dependentProperties: - video/v1/room_recording_media: '{room_sid: room_sid, sid: sid}' + media: + mapping: + room_sid: room_sid + sid: sid + resource_url: /v1/Rooms/{room_sid}/Recordings/{sid}/Media parent: /Rooms/{Sid} className: room_recording + pathType: instance get: description: '' + tags: + - VideoV1RoomRecording parameters: - name: RoomSid in: path @@ -3186,14 +4472,39 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: processing + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T21:00:00Z' + date_deleted: '2015-07-30T22:00:00Z' + sid: RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 0 + type: audio + duration: 0 + container_format: mka + codec: OPUS + track_name: A name + offset: 10 + grouping_sids: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_external_location: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + encryption_key: public_key + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + media: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media description: OK security: - accountSid_authToken: [] operationId: FetchRoomRecording - x-maturity: - - GA delete: description: '' + tags: + - VideoV1RoomRecording parameters: - name: RoomSid in: path @@ -3219,8 +4530,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRoomRecording - x-maturity: - - GA /v1/Rooms/{RoomSid}/Recordings: servers: - url: https://video.twilio.com @@ -3233,13 +4542,19 @@ paths: - type - duration - codec - pathType: list dependentProperties: - video/v1/room_recording_media: '{room_sid: room_sid, sid: sid}' + media: + mapping: + room_sid: room_sid + sid: sid + resource_url: /v1/Rooms/{room_sid}/Recordings/{sid}/Media parent: /Rooms/{Sid} className: room_recording + pathType: list get: description: '' + tags: + - VideoV1RoomRecording parameters: - name: RoomSid in: path @@ -3257,6 +4572,9 @@ paths: schema: type: string $ref: '#/components/schemas/room_recording_enum_status' + examples: + readResults: + value: completed - name: SourceSid in: query description: Read only the recordings that have this `source_sid`. @@ -3265,6 +4583,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readResults: + value: source_sid - name: DateCreatedAfter in: query description: Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -3272,6 +4593,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-01-01T00:00:01Z' - name: DateCreatedBefore in: query description: Read only Recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -3279,6 +4603,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-12-31T23:59:59Z' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3311,47 +4638,93 @@ paths: items: $ref: '#/components/schemas/video.v1.room.room_recording' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + recordings: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?PageSize=50&Page=0 + next_page_url: null + key: recordings + readResults: + value: + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T21:00:00Z' + date_deleted: '2015-07-30T22:00:00Z' + sid: RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 23 + type: audio + duration: 10 + container_format: mka + codec: OPUS + track_name: A name + offset: 10 + grouping_sids: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_external_location: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + encryption_key: public_key + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + media: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?Status=completed&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&SourceSid=source_sid&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?Status=completed&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&SourceSid=source_sid&PageSize=50&Page=0 + next_page_url: null + key: recordings description: OK security: - accountSid_authToken: [] operationId: ListRoomRecording - x-maturity: - - GA /v1/Rooms/{RoomSid}/RecordingRules: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - room_sid - rules - pathType: list parent: /Rooms/{Sid} className: recording_rules + pathType: list get: description: Returns a list of Recording Rules for the Room. + tags: + - VideoV1RecordingRules parameters: - name: RoomSid in: path @@ -3366,14 +4739,23 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_recording_rule' + examples: + fetch: + value: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + rules: + - type: include + all: true description: OK security: - accountSid_authToken: [] operationId: FetchRoomRecordingRule - x-maturity: - - GA post: description: Update the Recording Rules for the Room + tags: + - VideoV1RecordingRules parameters: - name: RoomSid in: path @@ -3388,12 +4770,19 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_recording_rule' + examples: + update: + value: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + rules: + - type: include + all: true description: Accepted security: - accountSid_authToken: [] operationId: UpdateRoomRecordingRule - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3403,8 +4792,26 @@ paths: properties: Rules: description: A JSON-encoded array of recording rules. + examples: + update: + value: + Rules: '%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D' servers: - url: https://video.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: VideoV1Anonymize +- name: VideoV1Composition +- name: VideoV1CompositionHook +- name: VideoV1CompositionSettings +- name: VideoV1Media +- name: VideoV1Participant +- name: VideoV1PublishedTrack +- name: VideoV1Recording +- name: VideoV1RecordingRules +- name: VideoV1RecordingSettings +- name: VideoV1Room +- name: VideoV1RoomRecording +- name: VideoV1SubscribeRules +- name: VideoV1SubscribedTrack +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_voice_v1.yaml b/spec/yaml/twilio_voice_v1.yaml index db0b30c8..0d7f161f 100644 --- a/spec/yaml/twilio_voice_v1.yaml +++ b/spec/yaml/twilio_voice_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: voice.v1.archived_call: type: object @@ -49,6 +53,10 @@ components: nullable: true description: The URL we call using the `voice_method` when the BYOC Trunk receives a call. + x-twilio: + pii: + handling: standard + deleteSla: 30 voice_method: type: string format: http-method @@ -68,6 +76,10 @@ components: nullable: true description: The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`. + x-twilio: + pii: + handling: standard + deleteSla: 30 voice_fallback_method: type: string format: http-method @@ -87,6 +99,10 @@ components: nullable: true description: The URL that we call to pass status parameters (such as call ended) to your application. + x-twilio: + pii: + handling: standard + deleteSla: 30 status_callback_method: type: string format: http-method @@ -225,6 +241,10 @@ components: nullable: true description: The SIP address you want Twilio to route your calls to. This must be a `sip:` schema. `sips` is NOT supported. + x-twilio: + pii: + handling: standard + deleteSla: 30 priority: type: integer nullable: true @@ -298,10 +318,10 @@ components: high_risk_tollfraud_numbers_enabled: type: boolean nullable: true - description: Whether dialing to high-risk [toll fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) + description: Whether dialing to high-risk [toll fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html) numbers is enabled. These prefixes include narrow number ranges that have a high-risk of international revenue sharing fraud (IRSF) attacks, also - known as [toll fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud). + known as [toll fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html). These prefixes are collected from anti-fraud databases and verified by analyzing calls on our network. These prefixes are not available for download and are updated frequently @@ -350,10 +370,10 @@ components: high_risk_tollfraud_numbers_enabled: type: boolean nullable: true - description: Whether dialing to high-risk [toll fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) + description: Whether dialing to high-risk [toll fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html) numbers is enabled. These prefixes include narrow number ranges that have a high-risk of international revenue sharing fraud (IRSF) attacks, also - known as [toll fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud). + known as [toll fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html). These prefixes are collected from anti-fraud databases and verified by analyzing calls on our network. These prefixes are not available for download and are updated frequently @@ -432,6 +452,10 @@ components: type: string nullable: true description: An IP address in dotted decimal notation, IPv4 only. + x-twilio: + pii: + handling: standard + deleteSla: 30 cidr_prefix_length: type: integer nullable: true @@ -455,6 +479,25 @@ components: format: uri nullable: true description: The absolute URL of the resource. + recording_enum_status: + type: string + enum: + - in-progress + - paused + - stopped + - processing + - completed + - absent + recording_enum_source: + type: string + enum: + - DialVerb + - Conference + - OutboundAPI + - Trunking + - RecordVerb + - StartCallRecordingAPI + - StartConferenceRecordingAPI voice.v1.source_ip_mapping: type: object properties: @@ -498,10 +541,6 @@ components: format: uri nullable: true description: The absolute URL of the resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Voice description: This is the public Twilio REST API. @@ -513,20 +552,22 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Archives/{Date}/Calls/{Sid}: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance mountName: archived_calls + pathType: instance delete: description: 'Delete an archived call record from Bulk Export. Note: this does not also delete the record from the Voice API.' + tags: + - VoiceV1ArchivedCall parameters: - name: Date in: path @@ -551,8 +592,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteArchivedCall - x-maturity: - - Beta /v1/ByocTrunks: servers: - url: https://voice.twilio.com @@ -566,18 +605,36 @@ paths: pathType: list post: description: '' + tags: + - VoiceV1ByocTrunk responses: '201': content: application/json: schema: $ref: '#/components/schemas/voice.v1.byoc_trunk' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_url: https://byoc.example.com/twilio/app + voice_method: POST + voice_fallback_method: POST + voice_fallback_url: https://byoc.example.com/twilio/fallback + status_callback_method: POST + status_callback_url: https://byoc.example.com/twilio/status_callback + cnam_lookup_enabled: false + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + from_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:36Z' + url: https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateByocTrunk - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -665,8 +722,23 @@ paths: call, configure this with a [SIP Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure proper routing. If not configured, the from domain will default to "sip.twilio.com". + examples: + create: + value: + FriendlyName: friendly_name + VoiceUrl: https://byoc.example.com/twilio/app + VoiceMethod: POST + VoiceFallbackUrl: https://byoc.example.com/twilio/fallback + VoiceFallbackMethod: POST + StatusCallbackUrl: https://byoc.example.com/twilio/status_callback + StatusCallbackMethod: POST + CnamLookupEnabled: false + ConnectionPolicySid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FromDomainSid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - VoiceV1ByocTrunk parameters: - name: PageSize in: query @@ -700,34 +772,70 @@ paths: items: $ref: '#/components/schemas/voice.v1.byoc_trunk' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0 + next_page_url: null + key: byoc_trunks + byoc_trunks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_url: https://byoc.example.com/twilio/app + voice_method: POST + voice_fallback_method: POST + voice_fallback_url: https://byoc.example.com/twilio/fallback + status_callback_method: POST + status_callback_url: https://byoc.example.com/twilio/status_callback + cnam_lookup_enabled: false + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + from_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0 + next_page_url: null + key: byoc_trunks + byoc_trunks: [] description: OK security: - accountSid_authToken: [] operationId: ListByocTrunk - x-maturity: - - GA /v1/ByocTrunks/{Sid}: servers: - url: https://voice.twilio.com @@ -741,6 +849,8 @@ paths: pathType: instance get: description: '' + tags: + - VoiceV1ByocTrunk parameters: - name: Sid in: path @@ -758,14 +868,32 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.byoc_trunk' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_url: https://byoc.example.com/twilio/app + voice_method: POST + voice_fallback_method: POST + voice_fallback_url: https://byoc.example.com/twilio/fallback + status_callback_method: POST + status_callback_url: https://byoc.example.com/twilio/status_callback + cnam_lookup_enabled: false + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + from_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchByocTrunk - x-maturity: - - GA post: description: '' + tags: + - VoiceV1ByocTrunk parameters: - name: Sid in: path @@ -783,12 +911,28 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.byoc_trunk' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: update_name + voice_url: https://byoc.example.com/twilio_updated/app + voice_method: GET + voice_fallback_method: GET + voice_fallback_url: https://byoc.example.com/twilio_updated/fallback + status_callback_method: GET + status_callback_url: https://byoc.example.com/twilio_updated/status_callback + cnam_lookup_enabled: true + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + from_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateByocTrunk - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -875,8 +1019,23 @@ paths: call, configure this with a [SIP Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure proper routing. If not configured, the from domain will default to "sip.twilio.com". + examples: + update: + value: + FriendlyName: update_name + VoiceUrl: https://byoc.example.com/twilio_updated/app + VoiceMethod: GET + VoiceFallbackUrl: https://byoc.example.com/twilio_updated/fallback + VoiceFallbackMethod: GET + StatusCallbackUrl: https://byoc.example.com/twilio_updated/status_callback + StatusCallbackMethod: GET + CnamLookupEnabled: true + ConnectionPolicySid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + FromDomainSid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab delete: description: '' + tags: + - VoiceV1ByocTrunk parameters: - name: Sid in: path @@ -894,8 +1053,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteByocTrunk - x-maturity: - - GA /v1/ConnectionPolicies: servers: - url: https://voice.twilio.com @@ -904,23 +1061,37 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list dependentProperties: - connection_policy_target: '{connection_policy_sid: sid}' + targets: + mapping: + connection_policy_sid: sid + resource_url: /v1/ConnectionPolicies/{connection_policy_sid}/Targets + pathType: list post: description: '' + tags: + - VoiceV1ConnectionPolicy responses: '201': content: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:36Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + targets: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets description: Created security: - accountSid_authToken: [] operationId: CreateConnectionPolicy - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -932,8 +1103,14 @@ paths: type: string description: A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long. + examples: + create: + value: + FriendlyName: friendly_name get: description: '' + tags: + - VoiceV1ConnectionPolicy parameters: - name: PageSize in: query @@ -967,34 +1144,63 @@ paths: items: $ref: '#/components/schemas/voice.v1.connection_policy' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0 + next_page_url: null + key: connection_policies + connection_policies: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + targets: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0 + next_page_url: null + key: connection_policies + connection_policies: [] description: OK security: - accountSid_authToken: [] operationId: ListConnectionPolicy - x-maturity: - - GA /v1/ConnectionPolicies/{Sid}: servers: - url: https://voice.twilio.com @@ -1003,11 +1209,16 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance dependentProperties: - connection_policy_target: '{connection_policy_sid: sid}' + targets: + mapping: + connection_policy_sid: sid + resource_url: /v1/ConnectionPolicies/{connection_policy_sid}/Targets + pathType: instance get: description: '' + tags: + - VoiceV1ConnectionPolicy parameters: - name: Sid in: path @@ -1025,14 +1236,25 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + targets: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets description: OK security: - accountSid_authToken: [] operationId: FetchConnectionPolicy - x-maturity: - - GA post: description: '' + tags: + - VoiceV1ConnectionPolicy parameters: - name: Sid in: path @@ -1050,12 +1272,21 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: updated_name + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + targets: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets description: OK security: - accountSid_authToken: [] operationId: UpdateConnectionPolicy - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1067,8 +1298,14 @@ paths: type: string description: A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long. + examples: + update: + value: + FriendlyName: updated_name delete: description: '' + tags: + - VoiceV1ConnectionPolicy parameters: - name: Sid in: path @@ -1086,8 +1323,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConnectionPolicy - x-maturity: - - GA /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets: servers: - url: https://voice.twilio.com @@ -1098,11 +1333,13 @@ paths: - friendly_name - target - enabled - pathType: list parent: /ConnectionPolicies/{Sid} className: connection_policy_target + pathType: list post: description: '' + tags: + - VoiceV1ConnectionPolicyTarget parameters: - name: ConnectionPolicySid in: path @@ -1119,12 +1356,24 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy.connection_policy_target' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + target: sip:sip-box.com:1234 + priority: 1 + weight: 20 + enabled: true + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:36Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateConnectionPolicyTarget - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1158,8 +1407,18 @@ paths: description: Whether the Target is enabled. The default is `true`. required: - Target + examples: + create: + value: + FriendlyName: friendly_name + Target: sip:sip-box.com:1234 + Priority: 1 + Weight: 20 + Enabled: true get: description: '' + tags: + - VoiceV1ConnectionPolicyTarget parameters: - name: ConnectionPolicySid in: path @@ -1202,34 +1461,66 @@ paths: items: $ref: '#/components/schemas/voice.v1.connection_policy.connection_policy_target' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0 + next_page_url: null + key: targets + targets: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + target: sip:sip-box.com:1234 + priority: 1 + weight: 20 + enabled: true + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0 + next_page_url: null + key: targets + targets: [] description: OK security: - accountSid_authToken: [] operationId: ListConnectionPolicyTarget - x-maturity: - - GA /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid}: servers: - url: https://voice.twilio.com @@ -1240,11 +1531,13 @@ paths: - friendly_name - target - enabled - pathType: instance parent: /ConnectionPolicies/{Sid} className: connection_policy_target + pathType: instance get: description: '' + tags: + - VoiceV1ConnectionPolicyTarget parameters: - name: ConnectionPolicySid in: path @@ -1271,14 +1564,28 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy.connection_policy_target' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + target: sip:sip-box.com:1234 + priority: 1 + weight: 20 + enabled: true + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConnectionPolicyTarget - x-maturity: - - GA post: description: '' + tags: + - VoiceV1ConnectionPolicyTarget parameters: - name: ConnectionPolicySid in: path @@ -1305,12 +1612,24 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy.connection_policy_target' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: updated_name + target: sip:sip-updated.com:4321 + priority: 2 + weight: 10 + enabled: false + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateConnectionPolicyTarget - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1342,8 +1661,18 @@ paths: Enabled: type: boolean description: Whether the Target is enabled. + examples: + update: + value: + FriendlyName: updated_name + Target: sip:sip-updated.com:4321 + Priority: 2 + Weight: 10 + Enabled: false delete: description: '' + tags: + - VoiceV1ConnectionPolicyTarget parameters: - name: ConnectionPolicySid in: path @@ -1370,32 +1699,35 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConnectionPolicyTarget - x-maturity: - - GA /v1/DialingPermissions: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list className: dialing_permissions + pathType: list /v1/DialingPermissions/Countries/{IsoCode}: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - iso_code - name - continent - pathType: instance dependentProperties: - highrisk_special_prefix: '{iso_code: iso_code}' + highrisk_special_prefixes: + mapping: + iso_code: iso_code + resource_url: /v1/DialingPermissions/Countries/{iso_code}/HighRiskSpecialPrefixes parent: /DialingPermissions + pathType: instance get: description: Retrieve voice dialing country permissions identified by the given ISO country code + tags: + - VoiceV1Country parameters: - name: IsoCode in: path @@ -1411,27 +1743,44 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country-instance' + examples: + fetch: + value: + iso_code: US + name: United States/Canada + country_codes: + - '+1' + continent: NORTH_AMERICA + low_risk_numbers_enabled: false + high_risk_special_numbers_enabled: false + high_risk_tollfraud_numbers_enabled: false + url: https://voice.twilio.com/v1/DialingPermissions/Countries/US + links: + highrisk_special_prefixes: https://voice.twilio.com/v1/DialingPermissions/Countries/US/HighRiskSpecialPrefixes description: OK security: - accountSid_authToken: [] operationId: FetchDialingPermissionsCountry - x-maturity: - - Preview /v1/DialingPermissions/Countries: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - iso_code - name - continent - pathType: list dependentProperties: - highrisk_special_prefix: '{iso_code: iso_code}' + highrisk_special_prefixes: + mapping: + iso_code: iso_code + resource_url: /v1/DialingPermissions/Countries/{iso_code}/HighRiskSpecialPrefixes parent: /DialingPermissions + pathType: list get: description: Retrieve all voice dialing country permissions for this account + tags: + - VoiceV1Country parameters: - name: IsoCode in: query @@ -1440,6 +1789,9 @@ paths: schema: type: string format: iso-country-code + examples: + readUs: + value: US - name: Continent in: query description: Filter to retrieve the country permissions by specifying the @@ -1466,8 +1818,8 @@ paths: - name: HighRiskTollfraudNumbersEnabled in: query description: 'Filter to retrieve the country permissions with dialing to high-risk - [toll fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) numbers - enabled. Can be: `true` or `false`.' + [toll fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html) + numbers enabled. Can be: `true` or `false`.' schema: type: boolean - name: PageSize @@ -1502,59 +1854,85 @@ paths: items: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readUs: + value: + content: + - iso_code: US + name: United States/Canada + country_codes: + - '+1' + continent: NORTH_AMERICA + low_risk_numbers_enabled: false + high_risk_special_numbers_enabled: false + high_risk_tollfraud_numbers_enabled: false + url: https://voice.twilio.com/v1/DialingPermissions/Countries/US + links: + highrisk_special_prefixes: https://voice.twilio.com/v1/DialingPermissions/Countries/US/HighRiskSpecialPrefixes + meta: + first_page_url: https://voice.twilio.com/v1/DialingPermissions/Countries?IsoCode=US&PageSize=50&Page=0 + key: content + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://voice.twilio.com/v1/DialingPermissions/Countries?IsoCode=US&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDialingPermissionsCountry - x-maturity: - - Preview /v1/DialingPermissions/BulkCountryUpdates: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - update_request - update_count - pathType: list parent: /DialingPermissions + pathType: list post: description: Create a bulk update request to change voice dialing country permissions of one or more countries identified by the corresponding [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + tags: + - VoiceV1BulkCountryUpdate responses: '201': content: application/json: schema: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country_bulk_update' + examples: + create: + value: + update_count: 1 + update_request: accepted description: Created security: - accountSid_authToken: [] operationId: CreateDialingPermissionsCountryBulkUpdate - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1569,19 +1947,27 @@ paths: "high_risk_tollfraud_numbers_enabled": "false" } ]`' required: - UpdateRequest + examples: + create: + value: + UpdateRequest: '[ { "iso_code": "GB", "low_risk_numbers": "Enabled", + "high_risk_special_numbers":"Enabled", "high_risk_irsf_numbers": + "Enabled" } ]' /v1/DialingPermissions/Countries/{IsoCode}/HighRiskSpecialPrefixes: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - prefix - pathType: list parent: /DialingPermissions/Countries/{IsoCode} mountName: highrisk_special_prefixes + pathType: list get: description: Fetch the high-risk special services prefixes from the country resource corresponding to the [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + tags: + - VoiceV1HighriskSpecialPrefix parameters: - name: IsoCode in: path @@ -1624,72 +2010,94 @@ paths: items: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country.dialing_permissions_hrs_prefixes' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readLv: + value: + content: + - prefix: '+37181' + - prefix: '+3719000' + meta: + first_page_url: https://voice.twilio.com/v1/DialingPermissions/Countries/LV/HighRiskSpecialPrefixes?PageSize=50&Page=0 + key: content + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://voice.twilio.com/v1/DialingPermissions/Countries/LV/HighRiskSpecialPrefixes?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDialingPermissionsHrsPrefixes - x-maturity: - - Preview /v1/Settings: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - dialing_permissions_inheritance - pathType: instance parent: /DialingPermissions className: settings + pathType: instance get: description: Retrieve voice dialing permissions inheritance for the sub-account + tags: + - VoiceV1Settings responses: '200': content: application/json: schema: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_settings' + examples: + fetch: + value: + dialing_permissions_inheritance: true + url: https://voice.twilio.com/v1/Settings description: OK security: - accountSid_authToken: [] operationId: FetchDialingPermissionsSettings - x-maturity: - - Preview post: description: Update voice dialing permissions inheritance for the sub-account + tags: + - VoiceV1Settings responses: '202': content: application/json: schema: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_settings' + examples: + update: + value: + dialing_permissions_inheritance: true + url: https://voice.twilio.com/v1/Settings description: Accepted security: - accountSid_authToken: [] operationId: UpdateDialingPermissionsSettings - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1701,6 +2109,10 @@ paths: type: boolean description: '`true` for the sub-account to inherit voice dialing permissions from the Master Project; otherwise `false`.' + examples: + update: + value: + DialingPermissionsInheritance: true /v1/IpRecords: servers: - url: https://voice.twilio.com @@ -1715,18 +2127,29 @@ paths: pathType: list post: description: '' + tags: + - VoiceV1IpRecord responses: '201': content: application/json: schema: $ref: '#/components/schemas/voice.v1.ip_record' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + ip_address: 10.2.3.4 + cidr_prefix_length: 30 + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:36Z' + url: https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateIpRecord - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1748,8 +2171,16 @@ paths: is used, which for IPv4 is value 32. required: - IpAddress + examples: + create: + value: + FriendlyName: friendly_name + IpAddress: 10.2.3.4 + CidrPrefixLength: 30 get: description: '' + tags: + - VoiceV1IpRecord parameters: - name: PageSize in: query @@ -1783,34 +2214,63 @@ paths: items: $ref: '#/components/schemas/voice.v1.ip_record' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0 + next_page_url: null + key: ip_records + ip_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + ip_address: 10.2.3.4 + cidr_prefix_length: 30 + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0 + next_page_url: null + key: ip_records + ip_records: [] description: OK security: - accountSid_authToken: [] operationId: ListIpRecord - x-maturity: - - GA /v1/IpRecords/{Sid}: servers: - url: https://voice.twilio.com @@ -1825,6 +2285,8 @@ paths: pathType: instance get: description: '' + tags: + - VoiceV1IpRecord parameters: - name: Sid in: path @@ -1842,14 +2304,25 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.ip_record' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + ip_address: 10.2.3.4 + cidr_prefix_length: 30 + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchIpRecord - x-maturity: - - GA post: description: '' + tags: + - VoiceV1IpRecord parameters: - name: Sid in: path @@ -1867,12 +2340,21 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.ip_record' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: update_name + ip_address: 10.2.3.4 + cidr_prefix_length: 30 + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateIpRecord - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1884,8 +2366,14 @@ paths: type: string description: A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long. + examples: + update: + value: + FriendlyName: update_name delete: description: '' + tags: + - VoiceV1IpRecord parameters: - name: Sid in: path @@ -1903,8 +2391,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteIpRecord - x-maturity: - - GA /v1/SourceIpMappings: servers: - url: https://voice.twilio.com @@ -1919,18 +2405,27 @@ paths: pathType: list post: description: '' + tags: + - VoiceV1SourceIpMapping responses: '201': content: application/json: schema: $ref: '#/components/schemas/voice.v1.source_ip_mapping' + examples: + create: + value: + sid: IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_record_sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sip_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:36Z' + url: https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSourceIpMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1955,8 +2450,15 @@ paths: required: - IpRecordSid - SipDomainSid + examples: + create: + value: + IpRecordSid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SipDomainSid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' + tags: + - VoiceV1SourceIpMapping parameters: - name: PageSize in: query @@ -1990,34 +2492,61 @@ paths: items: $ref: '#/components/schemas/voice.v1.source_ip_mapping' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0 + next_page_url: null + key: source_ip_mappings + source_ip_mappings: + - sid: IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_record_sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sip_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0 + next_page_url: null + key: source_ip_mappings + source_ip_mappings: [] description: OK security: - accountSid_authToken: [] operationId: ListSourceIpMapping - x-maturity: - - GA /v1/SourceIpMappings/{Sid}: servers: - url: https://voice.twilio.com @@ -2032,6 +2561,8 @@ paths: pathType: instance get: description: '' + tags: + - VoiceV1SourceIpMapping parameters: - name: Sid in: path @@ -2049,14 +2580,23 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.source_ip_mapping' + examples: + fetch: + value: + sid: IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_record_sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sip_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSourceIpMapping - x-maturity: - - GA post: description: '' + tags: + - VoiceV1SourceIpMapping parameters: - name: Sid in: path @@ -2074,12 +2614,19 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.source_ip_mapping' + examples: + update: + value: + sid: IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_record_sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sip_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSourceIpMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2096,8 +2643,14 @@ paths: be mapped to. required: - SipDomainSid + examples: + update: + value: + SipDomainSid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab delete: description: '' + tags: + - VoiceV1SourceIpMapping parameters: - name: Sid in: path @@ -2115,17 +2668,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSourceIpMapping - x-maturity: - - GA servers: - url: https://voice.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. +tags: +- name: VoiceV1ArchivedCall +- name: VoiceV1BulkCountryUpdate +- name: VoiceV1ByocTrunk +- name: VoiceV1ConnectionPolicy +- name: VoiceV1ConnectionPolicyTarget +- name: VoiceV1Country +- name: VoiceV1HighriskSpecialPrefix +- name: VoiceV1IpRecord +- name: VoiceV1Media +- name: VoiceV1MediaUrl +- name: VoiceV1Recording +- name: VoiceV1Settings +- name: VoiceV1SourceIpMapping +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_wireless_v1.yaml b/spec/yaml/twilio_wireless_v1.yaml index 8241a881..77e23160 100644 --- a/spec/yaml/twilio_wireless_v1.yaml +++ b/spec/yaml/twilio_wireless_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: wireless.v1.account_usage_record: type: object @@ -20,11 +24,11 @@ components: commands: nullable: true description: An object that describes the aggregated Commands usage for - all SIMs during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/wireless/api/account-usagerecord-resource#commands-usage-object). + all SIMs during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/iot/wireless/api/account-usagerecord-resource#commands-usage-object). data: nullable: true description: An object that describes the aggregated Data usage for all - SIMs over the period. See [Data Usage Object](https://www.twilio.com/docs/wireless/api/account-usagerecord-resource#data-usage-object). + SIMs over the period. See [Data Usage Object](https://www.twilio.com/docs/iot/wireless/api/account-usagerecord-resource#data-usage-object). account_usage_record_enum_granularity: type: string enum: @@ -55,7 +59,7 @@ components: maxLength: 34 pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) + description: The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that the Command was sent to or from. command: type: string @@ -63,6 +67,10 @@ components: description: The message being sent to or from the SIM. For text mode messages, this can be up to 160 characters. For binary mode messages, this is a series of up to 140 bytes of data encoded using base64. + x-twilio: + pii: + handling: standard + deleteSla: 30 command_mode: type: string $ref: '#/components/schemas/command_enum_command_mode' @@ -83,7 +91,7 @@ components: $ref: '#/components/schemas/command_enum_status' nullable: true description: 'The status of the Command. Can be: `queued`, `sent`, `delivered`, - `received`, or `failed`. See [Status Values](https://www.twilio.com/docs/wireless/api/command-resource#status-values) + `received`, or `failed`. See [Status Values](https://www.twilio.com/docs/iot/wireless/api/command-resource#status-values) for a description of each state.' direction: type: string @@ -145,7 +153,7 @@ components: sim_sid: type: string nullable: true - description: The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) + description: The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that the Data Session is for. account_sid: type: string @@ -177,7 +185,7 @@ components: operator_name: type: string nullable: true - description: The friendly name of the mobile operator network that the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource)-connected + description: The friendly name of the mobile operator network that the [SIM](https://www.twilio.com/docs/iot/wireless/api/sim-resource)-connected device is attached to. This is determined by looking up the `operator_mnc`. cell_id: type: string @@ -189,7 +197,7 @@ components: description: 'An object that describes the estimated location in latitude and longitude where the device''s Data Session took place. The location is derived from the `cell_id` when the Data Session was last updated. - See [Cell Location Estimate Object](https://www.twilio.com/docs/wireless/api/datasession-resource#cell-location-estimate-object). ' + See [Cell Location Estimate Object](https://www.twilio.com/docs/iot/wireless/api/datasession-resource#cell-location-estimate-object). ' packets_uploaded: type: integer nullable: true @@ -263,7 +271,7 @@ components: nullable: true description: 'The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering - models](https://www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans).' + models](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans).' data_limit: type: integer nullable: true @@ -274,7 +282,7 @@ components: messaging_enabled: type: boolean nullable: true - description: Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/wireless/api/command-resource). + description: Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/iot/wireless/api/command-resource). voice_enabled: type: boolean nullable: true @@ -283,7 +291,7 @@ components: type: boolean nullable: true description: Whether SIMs can roam on networks other than the home network - (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming). + (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming). national_roaming_data_limit: type: integer nullable: true @@ -345,6 +353,10 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -359,17 +371,25 @@ components: maxLength: 34 pattern: ^WP[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) + description: The SID of the [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource) to which the Sim resource is assigned. friendly_name: type: string nullable: true description: The string that you assigned to describe the Sim resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 iccid: type: string nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM. + x-twilio: + pii: + handling: standard + deleteSla: 30 e_id: type: string nullable: true @@ -380,7 +400,7 @@ components: nullable: true description: 'The status of the Sim resource. Can be: `new`, `ready`, `active`, `deactivated`, `canceled`, `deleted`, `scheduled`, or `updating`. See - [Status Values](https://www.twilio.com/docs/wireless/api/sim-resource#status-values) + [Status Values](https://www.twilio.com/docs/iot/wireless/api/sim-resource#status-values) for the description of each status.' reset_status: type: string @@ -394,7 +414,7 @@ components: format: uri nullable: true description: The URL we call using the `commands_callback_method` when the - SIM originates a machine-to-machine [Command](https://www.twilio.com/docs/wireless/api/command-resource). + SIM originates a machine-to-machine [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body will be ignored. commands_callback_method: @@ -532,7 +552,7 @@ components: sim_sid: type: string nullable: true - description: The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) + description: The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that this Usage Record is for. account_sid: type: string @@ -550,21 +570,17 @@ components: commands: nullable: true description: An object that describes the SIM's usage of Commands during - the specified period. See [Commands Usage Object](https://www.twilio.com/docs/wireless/api/sim-usagerecord-resource#commands-usage-object). + the specified period. See [Commands Usage Object](https://www.twilio.com/docs/iot/wireless/api/sim-usagerecord-resource#commands-usage-object). data: nullable: true description: An object that describes the SIM's data usage during the specified - period. See [Data Usage Object](https://www.twilio.com/docs/wireless/api/sim-usagerecord-resource#data-usage-object). + period. See [Data Usage Object](https://www.twilio.com/docs/iot/wireless/api/sim-usagerecord-resource#data-usage-object). usage_record_enum_granularity: type: string enum: - hourly - daily - all - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Wireless description: This is the public Twilio REST API. @@ -576,7 +592,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/UsageRecords: @@ -589,6 +605,8 @@ paths: pathType: list get: description: '' + tags: + - WirelessV1UsageRecord parameters: - name: End in: query @@ -597,6 +615,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Start in: query description: Only include usage that has occurred on or after this date. Format @@ -604,6 +625,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Granularity in: query description: 'How to summarize the usage by time. Can be: `daily`, `hourly`, @@ -644,34 +668,93 @@ paths: items: $ref: '#/components/schemas/wireless.v1.account_usage_record' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + fetch: + value: + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + commands: + billing_units: USD + billed: 0 + total: 3 + from_sim: 1 + to_sim: 2 + home: + billing_units: USD + billed: 0 + total: 3 + from_sim: 1 + to_sim: 2 + national_roaming: + billing_units: USD + billed: 0 + total: 0 + from_sim: 0 + to_sim: 0 + international_roaming: [] + data: + billing_units: USD + billed: 0.35 + total: 3494609 + upload: 731560 + download: 2763049 + units: bytes + home: + billing_units: USD + billed: 0.35 + total: 3494609 + upload: 731560 + download: 2763049 + units: bytes + national_roaming: + billing_units: USD + billed: 0 + total: 0 + upload: 0 + download: 0 + units: bytes + international_roaming: [] + period: + start: '2015-07-30T20:00:00Z' + end: '2015-07-30T20:00:00Z' + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + commands: {} + data: {} + period: {} + meta: + first_page_url: https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListAccountUsageRecord - x-maturity: - - GA /v1/Commands/{Sid}: servers: - url: https://wireless.twilio.com @@ -687,6 +770,8 @@ paths: pathType: instance get: description: Fetch a Command instance from your account. + tags: + - WirelessV1Command parameters: - name: Sid in: path @@ -703,14 +788,43 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.command' + examples: + fetchCommandSms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: text + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: true + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: from_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: sms + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchCommandIp: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: text + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: false + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: to_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: ip + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCommand - x-maturity: - - GA delete: description: Delete a Command instance from your account. + tags: + - WirelessV1Command parameters: - name: Sid in: path @@ -727,8 +841,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCommand - x-maturity: - - GA /v1/Commands: servers: - url: https://wireless.twilio.com @@ -744,13 +856,22 @@ paths: pathType: list get: description: Retrieve a list of Commands from your account. + tags: + - WirelessV1Command parameters: - name: Sim in: query - description: The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/wireless/api/sim-resource) + 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 - name: Status in: query description: 'The status of the resources to read. Can be: `queued`, `sent`, @@ -758,12 +879,26 @@ paths: schema: type: string $ref: '#/components/schemas/command_enum_status' + examples: + readEmpty: + value: queued + readFull: + value: queued + readIp: + value: queued - name: Direction in: query description: Only return Commands with this direction value. schema: type: string $ref: '#/components/schemas/command_enum_direction' + examples: + readEmpty: + value: from_sim + readFull: + value: from_sim + readIp: + value: to_sim - name: Transport in: query description: 'Only return Commands with this transport value. Can be: `sms` @@ -771,6 +906,9 @@ paths: schema: type: string $ref: '#/components/schemas/command_enum_transport' + examples: + readIp: + value: ip - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -803,48 +941,133 @@ paths: items: $ref: '#/components/schemas/wireless.v1.command' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + commands: [] + meta: + first_page_url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 + key: commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 + readFull: + value: + commands: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: text + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: true + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: from_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: sms + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 + key: commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 + readIp: + value: + commands: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: binary + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: true + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: to_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: ip + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0 + key: commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCommand - x-maturity: - - GA post: description: Send a Command to a Sim. + tags: + - WirelessV1Command responses: '201': content: application/json: schema: $ref: '#/components/schemas/wireless.v1.command' + examples: + createCommandSms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: text + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: true + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: from_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: sms + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createCommandIp: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: binary + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: true + direction: to_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: ip + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCommand - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -858,7 +1081,7 @@ paths: in text mode or a Base64 encoded byte string in binary mode. Sim: type: string - description: The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource) + description: The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to send the Command to. CallbackMethod: type: string @@ -904,6 +1127,24 @@ paths: receipt from the device. The default value is `true`. required: - Command + examples: + createCommandSms: + value: + CallbackMethod: callback_method + CallbackUrl: http://www.example.com + Command: command + CommandMode: text + Sim: sim + IncludeSid: include_sid + createCommandIp: + value: + CallbackMethod: callback_method + CallbackUrl: http://www.example.com + Command: command + CommandMode: binary + DeliveryReceiptRequested: true + Sim: sim + IncludeSid: include_sid /v1/Sims/{SimSid}/DataSessions: servers: - url: https://wireless.twilio.com @@ -915,14 +1156,16 @@ paths: - packets_downloaded - start - end - pathType: list parent: /Sims/{Sid} + pathType: list get: description: '' + tags: + - WirelessV1DataSession parameters: - name: SimSid in: path - description: The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) + description: The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) with the Data Sessions to read. schema: type: string @@ -959,34 +1202,76 @@ paths: items: $ref: '#/components/schemas/wireless.v1.sim.data_session' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + fetch: + value: + data_sessions: + - sid: WNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + radio_link: LTE + operator_mcc: '' + operator_mnc: '' + operator_country: '' + operator_name: '' + cell_id: '' + cell_location_estimate: {} + packets_uploaded: 0 + packets_downloaded: 0 + last_updated: '2015-07-30T20:00:00Z' + start: '2015-07-30T20:00:00Z' + end: null + imei: null + - sid: WNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + radio_link: 3G + operator_mcc: '' + operator_mnc: '' + operator_country: '' + operator_name: '' + cell_id: '' + cell_location_estimate: {} + packets_uploaded: 0 + packets_downloaded: 0 + last_updated: '2015-07-30T20:00:00Z' + start: '2015-07-30T20:00:00Z' + end: '2015-07-30T20:00:00Z' + imei: 014931000129700 + meta: + first_page_url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions?PageSize=50&Page=0 + key: data_sessions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDataSession - x-maturity: - - GA /v1/RatePlans: servers: - url: https://wireless.twilio.com @@ -1000,6 +1285,8 @@ paths: pathType: list get: description: '' + tags: + - WirelessV1RatePlan parameters: - name: PageSize in: query @@ -1033,48 +1320,116 @@ paths: items: $ref: '#/components/schemas/wireless.v1.rate_plan' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 + key: rate_plans + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 + rate_plans: [] + readFull: + value: + meta: + first_page_url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 + key: rate_plans + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 + rate_plans: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + national_roaming_data_limit: 1000 + international_roaming: + - data + - messaging + - voice + international_roaming_data_limit: 1000 + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_notification_method: POST + usage_notification_url: https://callback.com + data_limit_strategy: block + url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListRatePlan - x-maturity: - - GA post: description: '' + tags: + - WirelessV1RatePlan responses: '201': content: application/json: schema: $ref: '#/components/schemas/wireless.v1.rate_plan' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_limit_strategy: block + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + national_roaming_data_limit: 1000 + international_roaming: + - data + - messaging + - voice + international_roaming_data_limit: 1000 + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_notification_method: POST + usage_notification_url: https://callback.com + url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRatePlan - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1105,18 +1460,18 @@ paths: type: string description: 'The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the - available [data metering models](https://www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans).' + available [data metering models](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans).' MessagingEnabled: type: boolean description: Whether SIMs can make, send, and receive SMS using - [Commands](https://www.twilio.com/docs/wireless/api/command-resource). + [Commands](https://www.twilio.com/docs/iot/wireless/api/command-resource). VoiceEnabled: type: boolean description: Deprecated. NationalRoamingEnabled: type: boolean description: Whether SIMs can roam on networks other than the home - network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming). + network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming). InternationalRoaming: type: array items: @@ -1130,13 +1485,31 @@ paths: in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. - Can be up to 2TB. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming) + Can be up to 2TB. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming) for more info. InternationalRoamingDataLimit: type: integer description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB. + examples: + create: + value: + UniqueName: unique_name + DataEnabled: true + DataLimit: 1000 + DataMetering: payg + MessagingEnabled: true + VoiceEnabled: true + FriendlyName: friendly_name + NationalRoamingEnabled: true + InternationalRoaming: + - data + - voice + - messaging + NationalRoamingDataLimit: 1000 + InternationalRoamingDataLimit: 1000 + Status: status /v1/RatePlans/{Sid}: servers: - url: https://wireless.twilio.com @@ -1150,6 +1523,8 @@ paths: pathType: instance get: description: '' + tags: + - WirelessV1RatePlan parameters: - name: Sid in: path @@ -1163,14 +1538,39 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.rate_plan' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + national_roaming_data_limit: 1000 + international_roaming: + - data + - messaging + - voice + international_roaming_data_limit: 1000 + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_notification_method: POST + usage_notification_url: https://callback.com + data_limit_strategy: block + url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRatePlan - x-maturity: - - GA post: description: '' + tags: + - WirelessV1RatePlan parameters: - name: Sid in: path @@ -1184,12 +1584,35 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.rate_plan' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + national_roaming_data_limit: 1000 + international_roaming: + - data + - messaging + - voice + international_roaming_data_limit: 1000 + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_notification_method: POST + usage_notification_url: https://callback.com + data_limit_strategy: block + url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRatePlan - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1206,8 +1629,17 @@ paths: type: string description: A descriptive string that you create to describe the resource. It does not have to be unique. + examples: + update: + value: + UniqueName: unique_name + FriendlyName: friendly_name + UsageNotificationMethod: POST + UsageNotificationUrl: https://callback.com delete: description: '' + tags: + - WirelessV1RatePlan parameters: - name: Sid in: path @@ -1221,8 +1653,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRatePlan - x-maturity: - - GA /v1/Sims/{Sid}: servers: - url: https://wireless.twilio.com @@ -1233,12 +1663,20 @@ paths: - unique_name - friendly_name - status - pathType: instance dependentProperties: - usage_record: '{sim_sid: sid}' - data_session: '{sim_sid: sid}' + usage_records: + mapping: + sim_sid: sid + resource_url: /v1/Sims/{sim_sid}/UsageRecords + data_sessions: + mapping: + sim_sid: sid + resource_url: /v1/Sims/{sim_sid}/DataSessions + pathType: instance get: description: Fetch a Sim resource on your Account. + tags: + - WirelessV1Sim parameters: - name: Sid in: path @@ -1252,14 +1690,44 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.sim' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: POST + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + sms_fallback_method: POST + sms_fallback_url: http://www.example.com + sms_method: POST + sms_url: http://www.example.com + voice_fallback_method: POST + voice_fallback_url: http://www.example.com + voice_method: POST + voice_url: http://www.example.com + links: + data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions + rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: new + reset_status: null + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.1 description: OK security: - accountSid_authToken: [] operationId: FetchSim - x-maturity: - - GA post: description: Updates the given properties of a Sim resource on your Account. + tags: + - WirelessV1Sim parameters: - name: Sid in: path @@ -1273,12 +1741,98 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.sim' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: POST + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions + rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: new + reset_status: null + sms_fallback_method: POST + sms_fallback_url: http://www.example.com + sms_method: POST + sms_url: http://www.example.com + voice_fallback_method: POST + voice_fallback_url: http://www.example.com + voice_method: POST + voice_url: http://www.example.com + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.30 + updateMoveToSubaccount: + value: + account_sid: ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + unique_name: unique_name + commands_callback_method: POST + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions + rate_plan: https://wireless.twilio.com/v1/RatePlans/WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords + rate_plan_sid: WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: new + reset_status: null + sms_fallback_method: POST + sms_fallback_url: http://www.example.com + sms_method: POST + sms_url: http://www.example.com + voice_fallback_method: POST + voice_fallback_url: http://www.example.com + voice_method: POST + voice_url: http://www.example.com + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.30 + updateResetConnectivity: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: GET + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions + rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: active + reset_status: resetting + sms_fallback_method: POST + sms_fallback_url: http://www.example.com + sms_method: POST + sms_url: http://www.example.com + voice_fallback_method: POST + voice_fallback_url: http://www.example.com + voice_method: POST + voice_url: http://www.example.com + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.30 description: OK security: - accountSid_authToken: [] operationId: UpdateSim - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1318,7 +1872,7 @@ paths: Sim resource. It does not need to be unique. RatePlan: type: string - description: The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) + description: The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource) to which the Sim resource should be assigned. Status: type: string @@ -1341,7 +1895,7 @@ paths: type: string format: uri description: The URL we should call using the `commands_callback_method` - when the SIM sends a [Command](https://www.twilio.com/docs/wireless/api/command-resource). + when the SIM sends a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored. SmsFallbackMethod: @@ -1378,7 +1932,7 @@ paths: type: string format: uri description: The URL we should call using the `sms_method` when - the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/wireless/api/command-resource). + the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). VoiceFallbackMethod: type: string format: http-method @@ -1422,9 +1976,39 @@ paths: be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between - Subaccounts documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts). + 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 delete: description: Delete a Sim resource on your Account. + tags: + - WirelessV1Sim parameters: - name: Sid in: path @@ -1438,8 +2022,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSim - x-maturity: - - GA /v1/Sims: servers: - url: https://wireless.twilio.com @@ -1450,12 +2032,20 @@ paths: - unique_name - friendly_name - status - pathType: list dependentProperties: - usage_record: '{sim_sid: sid}' - data_session: '{sim_sid: sid}' + usage_records: + mapping: + sim_sid: sid + resource_url: /v1/Sims/{sim_sid}/UsageRecords + data_sessions: + mapping: + sim_sid: sid + resource_url: /v1/Sims/{sim_sid}/DataSessions + pathType: list get: description: Retrieve a list of Sim resources on your Account. + tags: + - WirelessV1Sim parameters: - name: Status in: query @@ -1463,18 +2053,37 @@ paths: schema: type: string $ref: '#/components/schemas/sim_enum_status' + examples: + readEmpty: + value: new + readFull: + value: new - name: Iccid in: query description: Only return Sim resources with this ICCID. This will return a list with a maximum size of 1. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: iccid + readFull: + value: iccid - name: RatePlan in: query - description: The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). + 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 - name: EId in: query description: Deprecated. @@ -1518,34 +2127,82 @@ paths: items: $ref: '#/components/schemas/wireless.v1.sim' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sims: [] + meta: + first_page_url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + readFull: + value: + sims: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: POST + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions + rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: new + reset_status: resetting + sms_fallback_method: POST + sms_fallback_url: http://www.example.com + sms_method: POST + sms_url: http://www.example.com + voice_fallback_method: POST + voice_fallback_url: http://www.example.com + voice_method: POST + voice_url: http://www.example.com + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.30 + meta: + first_page_url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSim - x-maturity: - - GA /v1/Sims/{SimSid}/UsageRecords: servers: - url: https://wireless.twilio.com @@ -1553,14 +2210,16 @@ paths: x-twilio: defaultOutputProperties: - period - pathType: list parent: /Sims/{Sid} + pathType: list get: description: '' + tags: + - WirelessV1UsageRecord parameters: - name: SimSid in: path - description: The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) to + description: The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to read the usage from. schema: type: string @@ -1573,6 +2232,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Start in: query description: Only include usage that has occurred on or after this date, specified @@ -1581,6 +2243,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Granularity in: query description: 'How to summarize the usage by time. Can be: `daily`, `hourly`, @@ -1621,36 +2286,102 @@ paths: items: $ref: '#/components/schemas/wireless.v1.sim.usage_record' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + fetch: + value: + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + commands: + billing_units: USD + billed: 0 + total: 3 + from_sim: 1 + to_sim: 2 + home: + billing_units: USD + billed: 0 + total: 3 + from_sim: 1 + to_sim: 2 + national_roaming: + billing_units: USD + billed: 0 + total: 0 + from_sim: 0 + to_sim: 0 + international_roaming: [] + data: + billing_units: USD + billed: 0.35 + total: 3494609 + upload: 731560 + download: 2763049 + units: bytes + home: + billing_units: USD + billed: 0.35 + total: 3494609 + upload: 731560 + download: 2763049 + units: bytes + national_roaming: + billing_units: USD + billed: 0 + total: 0 + upload: 0 + download: 0 + units: bytes + international_roaming: [] + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + period: + start: '2015-07-30T20:00:00Z' + end: '2015-07-30T20:00:00Z' + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + commands: {} + data: {} + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + period: {} + meta: + first_page_url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListUsageRecord - x-maturity: - - GA servers: - url: https://wireless.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. +tags: +- name: WirelessV1Command +- name: WirelessV1DataSession +- name: WirelessV1RatePlan +- name: WirelessV1Sim +- name: WirelessV1UsageRecord +security: +- accountSid_authToken: []