From 810c637f9e9375b330f3502c3b65e8f96ae4943f Mon Sep 17 00:00:00 2001 From: Sam Harrison Date: Mon, 23 Jan 2023 11:27:04 -0600 Subject: [PATCH] fix: use long property descriptions if available --- spec/json/twilio_accounts_v1.json | 36 +- spec/json/twilio_api_v2010.json | 1776 ++++++++-------- spec/json/twilio_autopilot_v1.json | 252 +-- spec/json/twilio_bulkexports_v1.json | 28 +- spec/json/twilio_chat_v1.json | 216 +- spec/json/twilio_chat_v2.json | 300 +-- spec/json/twilio_chat_v3.json | 28 +- spec/json/twilio_content_v1.json | 28 +- spec/json/twilio_conversations_v1.json | 492 ++--- spec/json/twilio_events_v1.json | 56 +- spec/json/twilio_flex_v1.json | 174 +- spec/json/twilio_flex_v2.json | 4 +- spec/json/twilio_frontline_v1.json | 14 +- spec/json/twilio_insights_v1.json | 120 +- spec/json/twilio_lookups_v1.json | 14 +- spec/json/twilio_lookups_v2.json | 26 +- spec/json/twilio_media_v1.json | 86 +- spec/json/twilio_messaging_v1.json | 280 +-- spec/json/twilio_microvisor_v1.json | 28 +- spec/json/twilio_monitor_v1.json | 96 +- spec/json/twilio_notify_v1.json | 124 +- spec/json/twilio_numbers_v2.json | 156 +- spec/json/twilio_oauth_v1.json | 56 +- spec/json/twilio_preview.json | 306 +-- spec/json/twilio_pricing_v1.json | 66 +- spec/json/twilio_pricing_v2.json | 72 +- spec/json/twilio_proxy_v1.json | 206 +- spec/json/twilio_routes_v2.json | 28 +- spec/json/twilio_serverless_v1.json | 208 +- spec/json/twilio_studio_v1.json | 154 +- spec/json/twilio_studio_v2.json | 120 +- spec/json/twilio_supersim_v1.json | 200 +- spec/json/twilio_sync_v1.json | 212 +- spec/json/twilio_taskrouter_v1.json | 580 ++--- spec/json/twilio_trunking_v1.json | 140 +- spec/json/twilio_trusthub_v1.json | 184 +- spec/json/twilio_verify_v2.json | 328 +-- spec/json/twilio_video_v1.json | 318 +-- spec/json/twilio_voice_v1.json | 140 +- spec/json/twilio_wireless_v1.json | 154 +- spec/yaml/twilio_accounts_v1.yaml | 60 +- spec/yaml/twilio_api_v2010.yaml | 2712 +++++++++++++++--------- spec/yaml/twilio_autopilot_v1.yaml | 365 ++-- spec/yaml/twilio_bulkexports_v1.yaml | 57 +- spec/yaml/twilio_chat_v1.yaml | 352 +-- spec/yaml/twilio_chat_v2.yaml | 502 +++-- spec/yaml/twilio_chat_v3.yaml | 38 +- spec/yaml/twilio_content_v1.yaml | 43 +- spec/yaml/twilio_conversations_v1.yaml | 766 ++++--- spec/yaml/twilio_events_v1.yaml | 71 +- spec/yaml/twilio_flex_v1.yaml | 242 ++- spec/yaml/twilio_flex_v2.yaml | 7 +- spec/yaml/twilio_frontline_v1.yaml | 18 +- spec/yaml/twilio_insights_v1.yaml | 173 +- spec/yaml/twilio_lookups_v1.yaml | 18 +- spec/yaml/twilio_lookups_v2.yaml | 38 +- spec/yaml/twilio_media_v1.yaml | 136 +- spec/yaml/twilio_messaging_v1.yaml | 436 ++-- spec/yaml/twilio_microvisor_v1.yaml | 38 +- spec/yaml/twilio_monitor_v1.yaml | 165 +- spec/yaml/twilio_notify_v1.yaml | 233 +- spec/yaml/twilio_numbers_v2.yaml | 215 +- spec/yaml/twilio_oauth_v1.yaml | 75 +- spec/yaml/twilio_preview.yaml | 429 ++-- spec/yaml/twilio_pricing_v1.yaml | 89 +- spec/yaml/twilio_pricing_v2.yaml | 99 +- spec/yaml/twilio_proxy_v1.yaml | 318 ++- spec/yaml/twilio_routes_v2.yaml | 32 +- spec/yaml/twilio_serverless_v1.yaml | 288 +-- spec/yaml/twilio_studio_v1.yaml | 208 +- spec/yaml/twilio_studio_v2.yaml | 154 +- spec/yaml/twilio_supersim_v1.yaml | 329 ++- spec/yaml/twilio_sync_v1.yaml | 334 +-- spec/yaml/twilio_taskrouter_v1.yaml | 736 ++++--- spec/yaml/twilio_trunking_v1.yaml | 229 +- spec/yaml/twilio_trusthub_v1.yaml | 250 ++- spec/yaml/twilio_verify_v2.yaml | 490 +++-- spec/yaml/twilio_video_v1.yaml | 519 +++-- spec/yaml/twilio_voice_v1.yaml | 212 +- spec/yaml/twilio_wireless_v1.yaml | 245 ++- 80 files changed, 11285 insertions(+), 8242 deletions(-) diff --git a/spec/json/twilio_accounts_v1.json b/spec/json/twilio_accounts_v1.json index 5185ad41..7056360f 100644 --- a/spec/json/twilio_accounts_v1.json +++ b/spec/json/twilio_accounts_v1.json @@ -10,24 +10,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that the secondary Auth Token was created for" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the secondary Auth Token was created for." }, "auth_token": { "type": "string", "nullable": true, - "description": "The promoted Auth Token" + "description": "The promoted Auth Token that must be used to authenticate future API requests." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 formatted date and time in UTC when the resource was created" + "description": "The date and time in UTC 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 ISO 8601 formatted date and time in UTC when the resource was last updated" + "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", @@ -50,7 +50,7 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the AWS resource." }, "account_sid": { "type": "string", @@ -58,24 +58,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AWS resource." }, "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", @@ -94,7 +94,7 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the PublicKey resource." }, "account_sid": { "type": "string", @@ -102,24 +102,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Credential that the PublicKey resource belongs to" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Credential that the PublicKey resource belongs to." }, "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", @@ -138,24 +138,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that the secondary Auth Token was created for" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the secondary Auth Token was created for." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 formatted date and time in UTC when the resource was created" + "description": "The date and time in UTC 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 ISO 8601 formatted date and time in UTC when the resource was last updated" + "description": "The date and time in UTC when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "secondary_auth_token": { "type": "string", "nullable": true, - "description": "The generated secondary Auth Token" + "description": "The generated secondary Auth Token that can be used to authenticate future API requests." }, "url": { "type": "string", diff --git a/spec/json/twilio_api_v2010.json b/spec/json/twilio_api_v2010.json index 467355e4..891766b4 100644 --- a/spec/json/twilio_api_v2010.json +++ b/spec/json/twilio_api_v2010.json @@ -7,24 +7,24 @@ "auth_token": { "type": "string", "nullable": true, - "description": "The authorization token for this account" + "description": "The authorization token for this account. This token should be kept a secret, so no sharing." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date this account was created" + "description": "The date that this account was created, in GMT in RFC 2822 format" }, "date_updated": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date this account was last updated" + "description": "The date that this account was last updated, in GMT in RFC 2822 format." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this account" + "description": "A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address." }, "owner_account_sid": { "type": "string", @@ -32,7 +32,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique 34 character id representing the parent of this account" + "description": "The unique 34 character id that represents the parent of this account. The OwnerAccountSid of a parent account is it's own sid." }, "sid": { "type": "string", @@ -46,19 +46,19 @@ "type": "string", "$ref": "#/components/schemas/account_enum_status", "nullable": true, - "description": "The status of this account" + "description": "The status of this account. Usually `active`, but can be `suspended` or `closed`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Account Instance Subresources" + "description": "A Map of various subresources available for the given Account Instance" }, "type": { "type": "string", "$ref": "#/components/schemas/account_enum_type", "nullable": true, - "description": "The type of this account" + "description": "The type of this account. Either `Trial` or `Full` if it's been upgraded" }, "uri": { "type": "string", @@ -91,50 +91,50 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that is responsible for the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource." }, "city": { "type": "string", "nullable": true, - "description": "The city in which the address is located" + "description": "The city in which the address is located." }, "customer_name": { "type": "string", "nullable": true, - "description": "The name associated with the address" + "description": "The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "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." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code of the address" + "description": "The ISO country code of the address." }, "postal_code": { "type": "string", "nullable": true, - "description": "The postal code of the address" + "description": "The postal code of the address." }, "region": { "type": "string", "nullable": true, - "description": "The state or region of the address" + "description": "The state or region of the address." }, "sid": { "type": "string", @@ -142,37 +142,37 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Address resource." }, "street": { "type": "string", "nullable": true, - "description": "The number and street address of the address" + "description": "The number and street address of the address." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "emergency_enabled": { "type": "boolean", "nullable": true, - "description": "Whether emergency calling has been enabled on this number" + "description": "Whether emergency calling has been enabled on this number." }, "validated": { "type": "boolean", "nullable": true, - "description": "Whether the address has been validated to comply with local regulation" + "description": "Whether the address has been validated to comply with local regulation. In countries that require valid addresses, an invalid address will not be accepted. `true` indicates the Address has been validated. `false` indicate the country doesn't require validation or the Address is not valid." }, "verified": { "type": "boolean", "nullable": true, - "description": "Whether the address has been verified to comply with regulation" + "description": "Whether the address has been verified to comply with regulation. In countries that require valid addresses, an invalid address will not be accepted. `true` indicates the Address has been verified. `false` indicate the country doesn't require verified or the Address is not valid." }, "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." } } }, @@ -185,35 +185,35 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resource." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to start a new TwiML session" + "description": "The API version used to start a new TwiML session." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "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." }, "message_status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to send message status information to your application" + "description": "The URL we call using a POST method to send message status information to your application." }, "sid": { "type": "string", @@ -221,7 +221,7 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Application resource." }, "sms_fallback_method": { "type": "string", @@ -235,13 +235,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with sms_fallback_url" + "description": "The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`." }, "sms_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML" + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`." }, "sms_method": { "type": "string", @@ -255,25 +255,25 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method to use with sms_url" + "description": "The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`." }, "sms_status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to send status information to your application" + "description": "The URL we call using a POST method to send status information to your application about SMS messages that refer to the application." }, "sms_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives an incoming SMS message" + "description": "The URL we call when the phone number receives an incoming SMS message." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to send status information to your application" + "description": "The URL we call using the `status_callback_method` to send status information to your application." }, "status_callback_method": { "type": "string", @@ -287,17 +287,17 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call status_callback" + "description": "The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "voice_caller_id_lookup": { "type": "boolean", "nullable": true, - "description": "Whether to lookup the caller's name" + "description": "Whether we look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`." }, "voice_fallback_method": { "type": "string", @@ -311,13 +311,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with voice_fallback_url" + "description": "The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`." }, "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when a TwiML error occurs" + "description": "The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`." }, "voice_method": { "type": "string", @@ -331,13 +331,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with the voice_url" + "description": "The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`." }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives a call" + "description": "The URL we call when the phone number assigned to this application receives a call." } } }, @@ -350,28 +350,28 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AuthorizedConnectApp resource." }, "connect_app_company_name": { "type": "string", "nullable": true, - "description": "The company name set for the Connect App" + "description": "The company name set for the Connect App." }, "connect_app_description": { "type": "string", "nullable": true, - "description": "A detailed description of the app" + "description": "A detailed description of the Connect App." }, "connect_app_friendly_name": { "type": "string", "nullable": true, - "description": "The name of the Connect App" + "description": "The name of the Connect App." }, "connect_app_homepage_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The public URL for the Connect App" + "description": "The public URL for the Connect App." }, "connect_app_sid": { "type": "string", @@ -379,19 +379,19 @@ "maxLength": 34, "pattern": "^CN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID that we assigned to the Connect App" + "description": "The SID that we assigned to the Connect App." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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", @@ -400,12 +400,12 @@ "$ref": "#/components/schemas/authorized_connect_app_enum_permission" }, "nullable": true, - "description": "Permissions authorized to the app" + "description": "The set of permissions that you authorized for the Connect App. Can be: `get-all` or `post-all`." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -423,29 +423,29 @@ "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO-3166-1 country code of the country." + "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country." }, "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "uri": { "type": "string", "format": "uri", "nullable": true, - "description": "The URI of the Country resource, relative to `https://api.twilio.com`" + "description": "The URI of the Country resource, relative to `https://api.twilio.com`." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether all phone numbers available in the country are new to the Twilio platform." + "description": "Whether all phone numbers available in the country are new to the Twilio platform. `true` if they are and `false` if all numbers are not in the Twilio Phone Number Beta program." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related AvailablePhoneNumber resources identified by their URIs relative to `https://api.twilio.com`." } } }, @@ -456,64 +456,64 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "A formatted version of the phone number" + "description": "A formatted version of the phone number." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "lata": { "type": "string", "nullable": true, - "description": "The LATA of this phone number" + "description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada." }, "locality": { "type": "string", "nullable": true, - "description": "The locality or city of this phone number's location" + "description": "The locality or city of this phone number's location." }, "rate_center": { "type": "string", "nullable": true, - "description": "The rate center of this phone number" + "description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada." }, "latitude": { "type": "number", "nullable": true, - "description": "The latitude of this phone number's location" + "description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "longitude": { "type": "number", "nullable": true, - "description": "The longitude of this phone number's location" + "description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "region": { "type": "string", "nullable": true, - "description": "The two-letter state or province abbreviation of this phone number's location" + "description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada." }, "postal_code": { "type": "string", "nullable": true, - "description": "The postal or ZIP code of this phone number's location" + "description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code of this phone number" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number." }, "address_requirements": { "type": "string", "nullable": true, - "description": "The type of Address resource the phone number requires" + "description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", @@ -533,7 +533,7 @@ } }, "nullable": true, - "description": "Whether a phone number can receive calls or messages" + "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`." } } }, @@ -544,64 +544,64 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "A formatted version of the phone number" + "description": "A formatted version of the phone number." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "lata": { "type": "string", "nullable": true, - "description": "The LATA of this phone number" + "description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada." }, "locality": { "type": "string", "nullable": true, - "description": "The locality or city of this phone number's location" + "description": "The locality or city of this phone number's location." }, "rate_center": { "type": "string", "nullable": true, - "description": "The rate center of this phone number" + "description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada." }, "latitude": { "type": "number", "nullable": true, - "description": "The latitude of this phone number's location" + "description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "longitude": { "type": "number", "nullable": true, - "description": "The longitude of this phone number's location" + "description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "region": { "type": "string", "nullable": true, - "description": "The two-letter state or province abbreviation of this phone number's location" + "description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada." }, "postal_code": { "type": "string", "nullable": true, - "description": "The postal or ZIP code of this phone number's location" + "description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code of this phone number" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number." }, "address_requirements": { "type": "string", "nullable": true, - "description": "The type of Address resource the phone number requires" + "description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", @@ -621,7 +621,7 @@ } }, "nullable": true, - "description": "Whether a phone number can receive calls or messages" + "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`." } } }, @@ -632,64 +632,64 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "A formatted version of the phone number" + "description": "A formatted version of the phone number." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "lata": { "type": "string", "nullable": true, - "description": "The LATA of this phone number" + "description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada." }, "locality": { "type": "string", "nullable": true, - "description": "The locality or city of this phone number's location" + "description": "The locality or city of this phone number's location." }, "rate_center": { "type": "string", "nullable": true, - "description": "The rate center of this phone number" + "description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada." }, "latitude": { "type": "number", "nullable": true, - "description": "The latitude of this phone number's location" + "description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "longitude": { "type": "number", "nullable": true, - "description": "The longitude of this phone number's location" + "description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "region": { "type": "string", "nullable": true, - "description": "The two-letter state or province abbreviation of this phone number's location" + "description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada." }, "postal_code": { "type": "string", "nullable": true, - "description": "The postal or ZIP code of this phone number's location" + "description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code of this phone number" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number." }, "address_requirements": { "type": "string", "nullable": true, - "description": "The type of Address resource the phone number requires" + "description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", @@ -709,7 +709,7 @@ } }, "nullable": true, - "description": "Whether a phone number can receive calls or messages" + "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`." } } }, @@ -720,64 +720,64 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "A formatted version of the phone number" + "description": "A formatted version of the phone number." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "lata": { "type": "string", "nullable": true, - "description": "The LATA of this phone number" + "description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada." }, "locality": { "type": "string", "nullable": true, - "description": "The locality or city of this phone number's location" + "description": "The locality or city of this phone number's location." }, "rate_center": { "type": "string", "nullable": true, - "description": "The rate center of this phone number" + "description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada." }, "latitude": { "type": "number", "nullable": true, - "description": "The latitude of this phone number's location" + "description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "longitude": { "type": "number", "nullable": true, - "description": "The longitude of this phone number's location" + "description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "region": { "type": "string", "nullable": true, - "description": "The two-letter state or province abbreviation of this phone number's location" + "description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada." }, "postal_code": { "type": "string", "nullable": true, - "description": "The postal or ZIP code of this phone number's location" + "description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code of this phone number" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number." }, "address_requirements": { "type": "string", "nullable": true, - "description": "The type of Address resource the phone number requires" + "description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", @@ -797,7 +797,7 @@ } }, "nullable": true, - "description": "Whether a phone number can receive calls or messages" + "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`." } } }, @@ -808,64 +808,64 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "A formatted version of the phone number" + "description": "A formatted version of the phone number." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "lata": { "type": "string", "nullable": true, - "description": "The LATA of this phone number" + "description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada." }, "locality": { "type": "string", "nullable": true, - "description": "The locality or city of this phone number's location" + "description": "The locality or city of this phone number's location." }, "rate_center": { "type": "string", "nullable": true, - "description": "The rate center of this phone number" + "description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada." }, "latitude": { "type": "number", "nullable": true, - "description": "The latitude of this phone number's location" + "description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "longitude": { "type": "number", "nullable": true, - "description": "The longitude of this phone number's location" + "description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "region": { "type": "string", "nullable": true, - "description": "The two-letter state or province abbreviation of this phone number's location" + "description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada." }, "postal_code": { "type": "string", "nullable": true, - "description": "The postal or ZIP code of this phone number's location" + "description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code of this phone number" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number." }, "address_requirements": { "type": "string", "nullable": true, - "description": "The type of Address resource the phone number requires" + "description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", @@ -885,7 +885,7 @@ } }, "nullable": true, - "description": "Whether a phone number can receive calls or messages" + "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`." } } }, @@ -896,64 +896,64 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "A formatted version of the phone number" + "description": "A formatted version of the phone number." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "lata": { "type": "string", "nullable": true, - "description": "The LATA of this phone number" + "description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada." }, "locality": { "type": "string", "nullable": true, - "description": "The locality or city of this phone number's location" + "description": "The locality or city of this phone number's location." }, "rate_center": { "type": "string", "nullable": true, - "description": "The rate center of this phone number" + "description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada." }, "latitude": { "type": "number", "nullable": true, - "description": "The latitude of this phone number's location" + "description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "longitude": { "type": "number", "nullable": true, - "description": "The longitude of this phone number's location" + "description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "region": { "type": "string", "nullable": true, - "description": "The two-letter state or province abbreviation of this phone number's location" + "description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada." }, "postal_code": { "type": "string", "nullable": true, - "description": "The postal or ZIP code of this phone number's location" + "description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code of this phone number" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number." }, "address_requirements": { "type": "string", "nullable": true, - "description": "The type of Address resource the phone number requires" + "description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", @@ -973,7 +973,7 @@ } }, "nullable": true, - "description": "Whether a phone number can receive calls or messages" + "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`." } } }, @@ -984,64 +984,64 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "A formatted version of the phone number" + "description": "A formatted version of the phone number." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "lata": { "type": "string", "nullable": true, - "description": "The LATA of this phone number" + "description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada." }, "locality": { "type": "string", "nullable": true, - "description": "The locality or city of this phone number's location" + "description": "The locality or city of this phone number's location." }, "rate_center": { "type": "string", "nullable": true, - "description": "The rate center of this phone number" + "description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada." }, "latitude": { "type": "number", "nullable": true, - "description": "The latitude of this phone number's location" + "description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "longitude": { "type": "number", "nullable": true, - "description": "The longitude of this phone number's location" + "description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada." }, "region": { "type": "string", "nullable": true, - "description": "The two-letter state or province abbreviation of this phone number's location" + "description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada." }, "postal_code": { "type": "string", "nullable": true, - "description": "The postal or ZIP code of this phone number's location" + "description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code of this phone number" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number." }, "address_requirements": { "type": "string", "nullable": true, - "description": "The type of Address resource the phone number requires" + "description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", @@ -1061,7 +1061,7 @@ } }, "nullable": true, - "description": "Whether a phone number can receive calls or messages" + "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`." } } }, @@ -1074,17 +1074,17 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account Sid." + "description": "The unique SID identifier of the Account." }, "balance": { "type": "string", "nullable": true, - "description": "Account balance" + "description": "The balance of the Account, in units specified by the unit parameter. Balance changes may not be reflected immediately. Child accounts do not contain balance information" }, "currency": { "type": "string", "nullable": true, - "description": "Currency units" + "description": "The units of currency for the account balance" } } }, @@ -1097,19 +1097,19 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies this resource" + "description": "The unique string that we created to identify this Call resource." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that this resource was created" + "description": "The date and time in GMT that this 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 RFC 2822 date and time in GMT that this resource was last updated" + "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." }, "parent_call_sid": { "type": "string", @@ -1125,27 +1125,27 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created this resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Call resource." }, "to": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that received this call. 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, 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`." }, "to_formatted": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that received this call. Formatted for display." + "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)." }, "from": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that made this call. 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, 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`." }, "from_formatted": { "type": "string", "nullable": true, - "description": "The calling phone number, SIP address, or Client identifier formatted for display." + "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)." }, "phone_number_sid": { "type": "string", @@ -1159,24 +1159,24 @@ "type": "string", "$ref": "#/components/schemas/call_enum_status", "nullable": true, - "description": "The status of this call." + "description": "The status of this call. Can be: `queued`, `ringing`, `in-progress`, `canceled`, `completed`, `failed`, `busy` or `no-answer`. See [Call Status Values](https://www.twilio.com/docs/voice/api/call-resource#call-status-values) below for more information." }, "start_time": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The start time of the call. Null if the call has not yet been dialed." + "description": "The start time of the call, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format. Empty if the call has not yet been dialed." }, "end_time": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The end time of the call. Null if the call did not complete successfully." + "description": "The time the call ended, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format. Empty if the call did not complete successfully." }, "duration": { "type": "string", "nullable": true, - "description": "The length of the call in seconds." + "description": "The length of the call in seconds. This value is empty for busy, failed, unanswered, or ongoing calls." }, "price": { "type": "string", @@ -1187,12 +1187,12 @@ "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which `Price` is measured." + "description": "The currency in which `Price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g., `USD`, `EUR`, `JPY`). Always capitalized for calls." }, "direction": { "type": "string", "nullable": true, - "description": "A string describing the direction of the call. `inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `Dial` verb." + "description": "A string describing the direction of the call. Can be: `inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `` verb. Using [Elastic SIP Trunking](https://www.twilio.com/docs/sip-trunking), the values can be [`trunking-terminating`](https://www.twilio.com/docs/sip-trunking#termination) for outgoing calls from your communications infrastructure to the PSTN or [`trunking-originating`](https://www.twilio.com/docs/sip-trunking#origination) for incoming calls to your communications infrastructure from the PSTN." }, "answered_by": { "type": "string", @@ -1202,7 +1202,7 @@ "api_version": { "type": "string", "nullable": true, - "description": "The API Version used to create the call" + "description": "The API version used to create the call." }, "forwarded_from": { "type": "string", @@ -1233,18 +1233,18 @@ "maxLength": 34, "pattern": "^TK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The (optional) unique identifier of the trunk resource that was used for this call." + "description": "The unique identifier of the trunk resource that was used for this call. The field is empty if the call was not made using a SIP trunk or if the call is not terminated." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of this resource, relative to `https://api.twilio.com`" + "description": "The URI of this resource, relative to `https://api.twilio.com`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related subresources identified by their relative URIs" + "description": "A list of subresources available to this call, identified by their URIs relative to `https://api.twilio.com`." } } }, @@ -1282,11 +1282,11 @@ "properties": { "request": { "nullable": true, - "description": "Call Request." + "description": "Contains a dictionary representing the request of the call." }, "response": { "nullable": true, - "description": "Call Response with Events." + "description": "Contains a dictionary representing the call response, including a list of the call events." } } }, @@ -1299,19 +1299,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique sid that identifies this account" + "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 this resource was created" + "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 this resource was last updated" + "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", @@ -1320,12 +1320,12 @@ "$ref": "#/components/schemas/call_feedback_enum_issues" }, "nullable": true, - "description": "Issues experienced during the call" + "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" + "description": "`1` to `5` quality score where `1` represents imperfect experience and `5` represents a perfect call." }, "sid": { "type": "string", @@ -1333,7 +1333,7 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this feedback resource" + "description": "A 34 character string that uniquely identifies this resource." } } }, @@ -1359,61 +1359,61 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique sid that identifies this account" + "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" + "description": "The total number of calls." }, "call_feedback_count": { "type": "integer", "nullable": true, - "description": "The total number of calls with a feedback entry" + "description": "The total number of calls with a feedback entry." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date this resource was created" + "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 this resource was last updated" + "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 latest feedback entry date in the summary" + "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" + "description": "Whether the feedback summary includes subaccounts; `true` if it does, otherwise `false`." }, "issues": { "type": "array", "items": {}, "nullable": true, - "description": "Issues experienced during the call" + "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" + "description": "The average QualityScore of the feedback entries." }, "quality_score_median": { "type": "number", "nullable": true, - "description": "The median QualityScore of the feedback entries" + "description": "The median QualityScore of the feedback entries." }, "quality_score_standard_deviation": { "type": "number", "nullable": true, - "description": "The standard deviation of the quality scores" + "description": "The standard deviation of the quality scores." }, "sid": { "type": "string", @@ -1421,19 +1421,19 @@ "maxLength": 34, "pattern": "^FS[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this feedback entry" + "description": "A 34 character string that uniquely identifies this resource." }, "start_date": { "type": "string", "format": "date", "nullable": true, - "description": "The earliest feedback entry date in the summary" + "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" + "description": "The status of the feedback summary can be `queued`, `in-progress`, `completed`, or `failed`." } } }, @@ -1455,12 +1455,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call Notification resource." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the Call Notification resource" + "description": "The API version used to create the Call Notification resource." }, "call_sid": { "type": "string", @@ -1468,46 +1468,46 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Call Notification resource is associated with." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "error_code": { "type": "string", "nullable": true, - "description": "A unique error code corresponding to the notification" + "description": "A unique error code for the error condition that is described in our [Error Dictionary](https://www.twilio.com/docs/api/errors)." }, "log": { "type": "string", "nullable": true, - "description": "An integer log level" + "description": "An integer log level that corresponds to the type of notification: `0` is ERROR, `1` is WARNING." }, "message_date": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date the notification was generated" + "description": "The date the notification was actually generated in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. Message buffering can cause this value to differ from `date_created`." }, "message_text": { "type": "string", "nullable": true, - "description": "The text of the notification" + "description": "The text of the notification." }, "more_info": { "type": "string", "format": "uri", "nullable": true, - "description": "A URL for more information about the error code" + "description": "The URL for more information about the error condition. This value is a page in our [Error Dictionary](https://www.twilio.com/docs/api/errors)." }, "request_method": { "type": "string", @@ -1521,13 +1521,13 @@ "DELETE" ], "nullable": true, - "description": "HTTP method used with the request url" + "description": "The HTTP method used to generate the notification. If the notification was generated during a phone call, this is the HTTP Method used to request the resource on your server. If the notification was generated by your use of our REST API, this is the HTTP method used to call the resource on our servers." }, "request_url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of the resource that generated the notification" + "description": "The URL of the resource that generated the notification. If the notification was generated during a phone call, this is the URL of the resource on your server that caused the notification. If the notification was generated by your use of our REST API, this is the URL of the resource you called." }, "sid": { "type": "string", @@ -1535,12 +1535,12 @@ "maxLength": 34, "pattern": "^NO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Call Notification resource." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -1553,12 +1553,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call Notification resource." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the Call Notification resource" + "description": "The API version used to create the Call Notification resource." }, "call_sid": { "type": "string", @@ -1566,46 +1566,46 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Call Notification resource is associated with." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "error_code": { "type": "string", "nullable": true, - "description": "A unique error code corresponding to the notification" + "description": "A unique error code for the error condition that is described in our [Error Dictionary](https://www.twilio.com/docs/api/errors)." }, "log": { "type": "string", "nullable": true, - "description": "An integer log level" + "description": "An integer log level that corresponds to the type of notification: `0` is ERROR, `1` is WARNING." }, "message_date": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date the notification was generated" + "description": "The date the notification was actually generated in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. Message buffering can cause this value to differ from `date_created`." }, "message_text": { "type": "string", "nullable": true, - "description": "The text of the notification" + "description": "The text of the notification." }, "more_info": { "type": "string", "format": "uri", "nullable": true, - "description": "A URL for more information about the error code" + "description": "The URL for more information about the error condition. This value is a page in our [Error Dictionary](https://www.twilio.com/docs/api/errors)." }, "request_method": { "type": "string", @@ -1619,28 +1619,28 @@ "DELETE" ], "nullable": true, - "description": "HTTP method used with the request url" + "description": "The HTTP method used to generate the notification. If the notification was generated during a phone call, this is the HTTP Method used to request the resource on your server. If the notification was generated by your use of our REST API, this is the HTTP method used to call the resource on our servers." }, "request_url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of the resource that generated the notification" + "description": "The URL of the resource that generated the notification. If the notification was generated during a phone call, this is the URL of the resource on your server that caused the notification. If the notification was generated by your use of our REST API, this is the URL of the resource you called." }, "request_variables": { "type": "string", "nullable": true, - "description": "Twilio-generated HTTP variables sent to the server" + "description": "The HTTP GET or POST variables we sent to your server. However, if the notification was generated by our REST API, this contains the HTTP POST or PUT variables you sent to our API." }, "response_body": { "type": "string", "nullable": true, - "description": "The HTTP body returned by your server" + "description": "The HTTP body returned by your server." }, "response_headers": { "type": "string", "nullable": true, - "description": "The HTTP headers returned by your server" + "description": "The HTTP headers returned by your server." }, "sid": { "type": "string", @@ -1648,12 +1648,12 @@ "maxLength": 34, "pattern": "^NO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Call Notification resource." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -1666,12 +1666,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to make the recording" + "description": "The API version used to make the recording." }, "call_sid": { "type": "string", @@ -1679,7 +1679,7 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Recording resource is associated with." }, "conference_sid": { "type": "string", @@ -1687,30 +1687,30 @@ "maxLength": 34, "pattern": "^CF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The Conference SID that identifies the conference associated with the recording" + "description": "The Conference SID that identifies the conference associated with the recording, if a conference recording." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "start_time": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The start time of the recording, given in RFC 2822 format" + "description": "The start time of the recording in GMT and in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." }, "duration": { "type": "string", "nullable": true, - "description": "The length of the recording in seconds" + "description": "The length of the recording in seconds." }, "sid": { "type": "string", @@ -1718,49 +1718,49 @@ "maxLength": 34, "pattern": "^RE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Recording resource." }, "price": { "type": "number", "nullable": true, - "description": "The one-time cost of creating the recording." + "description": "The one-time cost of creating the recording in the `price_unit` currency." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "encryption_details": { "nullable": true, - "description": "How to decrypt the recording." + "description": "How to decrypt the recording if it was encrypted using [Call Recording Encryption](https://www.twilio.com/docs/voice/tutorials/voice-recording-encryption) feature." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency used in the price property." + "description": "The currency used in the `price` property. Example: `USD`." }, "status": { "type": "string", "$ref": "#/components/schemas/call_recording_enum_status", "nullable": true, - "description": "The status of the recording" + "description": "The status of the recording. Can be: `processing`, `completed` and `absent`. For more detailed statuses on in-progress recordings, check out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource)." }, "channels": { "type": "integer", "nullable": true, - "description": "The number of channels in the final recording file" + "description": "The number of channels in the final recording file. Can be: `1`, or `2`. Separating a two leg call into two separate channels of the recording file is supported in [Dial](https://www.twilio.com/docs/voice/twiml/dial#attributes-record) and [Outbound Rest API](https://www.twilio.com/docs/voice/make-calls) record options." }, "source": { "type": "string", "$ref": "#/components/schemas/call_recording_enum_source", "nullable": true, - "description": "How the recording was created" + "description": "How the recording was created. Can be: `DialVerb`, `Conference`, `OutboundAPI`, `Trunking`, `RecordVerb`, `StartCallRecordingAPI`, and `StartConferenceRecordingAPI`." }, "error_code": { "type": "integer", "nullable": true, - "description": "More information about why the recording is missing, if status is `absent`." + "description": "The error code that describes why the recording is `absent`. The error code is described in our [Error Dictionary](https://www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`." }, "track": { "type": "string", @@ -1801,34 +1801,34 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created this resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Conference resource." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that this resource was created" + "description": "The date and time in GMT that this 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 RFC 2822 date and time in GMT that this resource was last updated" + "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." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create this conference" + "description": "The API version used to create this conference." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A string that you assigned to describe this conference room" + "description": "A string that you assigned to describe this conference room." }, "region": { "type": "string", "nullable": true, - "description": "A string that represents the Twilio Region where the conference was mixed" + "description": "A string that represents the Twilio Region where the conference audio was mixed. May be `us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, and `jp1`. Basic conference audio will always be mixed in `us1`. Global Conference audio will be mixed nearest to the majority of participants." }, "sid": { "type": "string", @@ -1836,30 +1836,30 @@ "maxLength": 34, "pattern": "^CF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies this resource" + "description": "The unique string that that we created to identify this Conference resource." }, "status": { "type": "string", "$ref": "#/components/schemas/conference_enum_status", "nullable": true, - "description": "The status of this conference" + "description": "The status of this conference. Can be: `init`, `in-progress`, or `completed`." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of this resource, relative to `https://api.twilio.com`" + "description": "The URI of this resource, relative to `https://api.twilio.com`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their URIs relative to `https://api.twilio.com`." }, "reason_conference_ended": { "type": "string", "$ref": "#/components/schemas/conference_enum_reason_conference_ended", "nullable": true, - "description": "The reason why a conference ended." + "description": "The reason why a conference ended. When a conference is in progress, will be `null`. When conference is completed, can be: `conference-ended-via-api`, `participant-with-end-conference-on-exit-left`, `participant-with-end-conference-on-exit-kicked`, `last-participant-kicked`, or `last-participant-left`." }, "call_sid_ending_conference": { "type": "string", @@ -1867,7 +1867,7 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The call SID that caused the conference to end" + "description": "The call SID that caused the conference to end." } } }, @@ -1904,12 +1904,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resource." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the recording" + "description": "The API version used to create the recording." }, "call_sid": { "type": "string", @@ -1917,7 +1917,7 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Conference Recording resource is associated with." }, "conference_sid": { "type": "string", @@ -1925,30 +1925,30 @@ "maxLength": 34, "pattern": "^CF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The Conference SID that identifies the conference associated with the recording" + "description": "The Conference SID that identifies the conference associated with the recording." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "start_time": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The start time of the recording, given in RFC 2822 format" + "description": "The start time of the recording in GMT and in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." }, "duration": { "type": "string", "nullable": true, - "description": "The length of the recording in seconds" + "description": "The length of the recording in seconds." }, "sid": { "type": "string", @@ -1956,49 +1956,49 @@ "maxLength": 34, "pattern": "^RE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Conference Recording resource." }, "price": { "type": "string", "nullable": true, - "description": "The one-time cost of creating the recording." + "description": "The one-time cost of creating the recording in the `price_unit` currency." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency used in the price property." + "description": "The currency used in the `price` property. Example: `USD`." }, "status": { "type": "string", "$ref": "#/components/schemas/conference_recording_enum_status", "nullable": true, - "description": "The status of the recording" + "description": "The status of the recording. Can be: `processing`, `completed` and `absent`. For more detailed statuses on in-progress recordings, check out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource)." }, "channels": { "type": "integer", "nullable": true, - "description": "The number of channels in the final recording file as an integer" + "description": "The number of channels in the final recording file. Can be: `1`, or `2`. Separating a two leg call into two separate channels of the recording file is supported in [Dial](https://www.twilio.com/docs/voice/twiml/dial#attributes-record) and [Outbound Rest API](https://www.twilio.com/docs/voice/make-calls) record options." }, "source": { "type": "string", "$ref": "#/components/schemas/conference_recording_enum_source", "nullable": true, - "description": "How the recording was created" + "description": "How the recording was created. Can be: `DialVerb`, `Conference`, `OutboundAPI`, `Trunking`, `RecordVerb`, `StartCallRecordingAPI`, `StartConferenceRecordingAPI`." }, "error_code": { "type": "integer", "nullable": true, - "description": "More information about why the recording is missing, if status is `absent`." + "description": "The error code that describes why the recording is `absent`. The error code is described in our [Error Dictionary](https://www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`." }, "encryption_details": { "nullable": true, - "description": "How to decrypt the recording." + "description": "How to decrypt the recording if it was encrypted using [Call Recording Encryption](https://www.twilio.com/docs/voice/tutorials/voice-recording-encryption) feature." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -2034,18 +2034,18 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resource." }, "authorize_redirect_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to redirect the user to after authorization" + "description": "The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App." }, "company_name": { "type": "string", "nullable": true, - "description": "The company name set for the Connect App" + "description": "The company name set for the Connect App." }, "deauthorize_callback_method": { "type": "string", @@ -2059,29 +2059,29 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call deauthorize_callback_url" + "description": "The HTTP method we use to call `deauthorize_callback_url`." }, "deauthorize_callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call to de-authorize the Connect App" + "description": "The URL we call using the `deauthorize_callback_method` to de-authorize the Connect App." }, "description": { "type": "string", "nullable": true, - "description": "The description of the Connect App" + "description": "The description of the Connect App." }, "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." }, "homepage_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL users can obtain more information" + "description": "The public URL where users can obtain more information about this Connect App." }, "permissions": { "type": "array", @@ -2090,7 +2090,7 @@ "$ref": "#/components/schemas/connect_app_enum_permission" }, "nullable": true, - "description": "The set of permissions that your ConnectApp requests" + "description": "The set of permissions that your ConnectApp requests." }, "sid": { "type": "string", @@ -2098,12 +2098,12 @@ "maxLength": 34, "pattern": "^CN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the ConnectApp resource." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -2123,7 +2123,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the DependentPhoneNumber resource." }, "account_sid": { "type": "string", @@ -2131,25 +2131,25 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the DependentPhoneNumber resource." }, "friendly_name": { "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." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives a call" + "description": "The URL we call when the phone number receives a call. The `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` is set." }, "voice_method": { "type": "string", @@ -2163,7 +2163,7 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with the voice_url" + "description": "The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`." }, "voice_fallback_method": { "type": "string", @@ -2177,30 +2177,30 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with voice_fallback_url" + "description": "The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`." }, "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when an error occurs in TwiML" + "description": "The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`." }, "voice_caller_id_lookup": { "type": "boolean", "nullable": true, - "description": "Whether to lookup the caller's name" + "description": "Whether we look up the caller's caller-ID name from the CNAM database. Can be: `true` or `false`. Caller ID lookups can cost $0.01 each." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "sms_fallback_method": { "type": "string", @@ -2214,13 +2214,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with sms_fallback_url" + "description": "The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`." }, "sms_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML" + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`." }, "sms_method": { "type": "string", @@ -2234,29 +2234,29 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method to use with sms_url" + "description": "The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`." }, "sms_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives an incoming SMS message" + "description": "The URL we call when the phone number receives an incoming SMS message." }, "address_requirements": { "type": "string", "$ref": "#/components/schemas/dependent_phone_number_enum_address_requirement", "nullable": true, - "description": "Whether the phone number requires an Address registered with Twilio" + "description": "Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) registered with Twilio. Can be: `none`, `any`, `local`, or `foreign`." }, "capabilities": { "nullable": true, - "description": "Indicate if a phone can receive calls or messages" + "description": "The set of Boolean properties that indicates whether a phone number can receive calls or messages. Capabilities are `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to send status information to your application" + "description": "The URL we call using the `status_callback_method` to send status information to your application." }, "status_callback_method": { "type": "string", @@ -2270,12 +2270,12 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call status_callback" + "description": "The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to start a new TwiML session" + "description": "The API version used to start a new TwiML session." }, "sms_application_sid": { "type": "string", @@ -2283,7 +2283,7 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the application that handles SMS messages sent to the phone number" + "description": "The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application." }, "voice_application_sid": { "type": "string", @@ -2291,7 +2291,7 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the application that handles calls to the phone number" + "description": "The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa." }, "trunk_sid": { "type": "string", @@ -2299,13 +2299,13 @@ "maxLength": 34, "pattern": "^TK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Trunk that handles calls to the phone number" + "description": "The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa." }, "emergency_status": { "type": "string", "$ref": "#/components/schemas/dependent_phone_number_enum_emergency_status", "nullable": true, - "description": "Whether the phone number is enabled for emergency calling" + "description": "Whether the phone number is enabled for emergency calling." }, "emergency_address_sid": { "type": "string", @@ -2313,12 +2313,12 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The emergency address configuration to use for emergency calling" + "description": "The SID of the emergency address configuration that we use for emergency calling from the phone number." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -2347,7 +2347,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this IncomingPhoneNumber resource." }, "address_sid": { "type": "string", @@ -2355,23 +2355,23 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Address resource associated with the phone number" + "description": "The SID of the Address resource associated with the phone number." }, "address_requirements": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_enum_address_requirement", "nullable": true, - "description": "Whether the phone number requires an Address registered with Twilio." + "description": "Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) registered with Twilio. Can be: `none`, `any`, `local`, or `foreign`." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to start a new TwiML session" + "description": "The API version used to start a new TwiML session." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", @@ -2391,24 +2391,24 @@ } }, "nullable": true, - "description": "Indicate if a phone can receive calls or messages" + "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`." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "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." }, "identity_sid": { "type": "string", @@ -2416,18 +2416,18 @@ "maxLength": 34, "pattern": "^RI[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Identity resource associated with number" + "description": "The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "origin": { "type": "string", "nullable": true, - "description": "The phone number's origin. Can be twilio or hosted." + "description": "The phone number's origin. `twilio` identifies Twilio-owned phone numbers and `hosted` identifies hosted phone numbers." }, "sid": { "type": "string", @@ -2435,7 +2435,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify this IncomingPhoneNumber resource." }, "sms_application_sid": { "type": "string", @@ -2443,7 +2443,7 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the application that handles SMS messages sent to the phone number" + "description": "The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application." }, "sms_fallback_method": { "type": "string", @@ -2457,13 +2457,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with sms_fallback_url" + "description": "The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`." }, "sms_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML" + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`." }, "sms_method": { "type": "string", @@ -2477,19 +2477,19 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method to use with sms_url" + "description": "The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`." }, "sms_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives an incoming SMS message" + "description": "The URL we call when the phone number receives an incoming SMS message." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to send status information to your application" + "description": "The URL we call using the `status_callback_method` to send status information to your application." }, "status_callback_method": { "type": "string", @@ -2503,7 +2503,7 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call status_callback" + "description": "The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`." }, "trunk_sid": { "type": "string", @@ -2511,12 +2511,12 @@ "maxLength": 34, "pattern": "^TK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Trunk that handles calls to the phone number" + "description": "The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "voice_receive_mode": { "type": "string", @@ -2529,12 +2529,12 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the application that handles calls to the phone number" + "description": "The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa." }, "voice_caller_id_lookup": { "type": "boolean", "nullable": true, - "description": "Whether to lookup the caller's name" + "description": "Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: `true` or `false`." }, "voice_fallback_method": { "type": "string", @@ -2548,13 +2548,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with voice_fallback_url" + "description": "The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`." }, "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when an error occurs in TwiML" + "description": "The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`." }, "voice_method": { "type": "string", @@ -2568,19 +2568,19 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with the voice_url" + "description": "The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`." }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives a call" + "description": "The URL we call when the phone number receives a call. The `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` is set." }, "emergency_status": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_enum_emergency_status", "nullable": true, - "description": "Displays if emergency calling is enabled for this number." + "description": "The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country." }, "emergency_address_sid": { "type": "string", @@ -2588,13 +2588,13 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The emergency address configuration to use for emergency calling" + "description": "The SID of the emergency address configuration that we use for emergency calling from this phone number." }, "emergency_address_status": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_enum_emergency_address_status", "nullable": true, - "description": "State of the emergency address configuration for the phone number" + "description": "The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number." }, "bundle_sid": { "type": "string", @@ -2602,7 +2602,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Bundle resource associated with number" + "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations." }, "status": { "type": "string", @@ -2653,7 +2653,7 @@ "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the resource." }, "account_sid": { "type": "string", @@ -2661,7 +2661,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource." }, "resource_sid": { "type": "string", @@ -2669,49 +2669,49 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Phone Number that installed this Add-on" + "description": "The SID of the Phone Number to which the Add-on is assigned." }, "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." }, "description": { "type": "string", "nullable": true, - "description": "A short description of the Add-on functionality" + "description": "A short description of the functionality that the Add-on provides." }, "configuration": { "nullable": true, - "description": "A JSON string that represents the current configuration" + "description": "A JSON string that represents the current configuration of this Add-on installation." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their relative URIs." } } }, @@ -2724,7 +2724,7 @@ "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the resource." }, "account_sid": { "type": "string", @@ -2732,7 +2732,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource." }, "resource_sid": { "type": "string", @@ -2740,7 +2740,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Phone Number to which the Add-on is assigned" + "description": "The SID of the Phone Number to which the Add-on is assigned." }, "assigned_add_on_sid": { "type": "string", @@ -2748,32 +2748,32 @@ "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID that uniquely identifies the assigned Add-on installation" + "description": "The SID that uniquely identifies the assigned Add-on installation." }, "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", "nullable": true, - "description": "A string that you assigned to describe the Product this Extension is used within" + "description": "A string that you assigned to describe the Product this Extension is used within." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "enabled": { "type": "boolean", "nullable": true, - "description": "Whether the Extension will be invoked" + "description": "Whether the Extension will be invoked." } } }, @@ -2786,7 +2786,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource." }, "address_sid": { "type": "string", @@ -2794,23 +2794,23 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Address resource associated with the phone number" + "description": "The SID of the Address resource associated with the phone number." }, "address_requirements": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_local_enum_address_requirement", "nullable": true, - "description": "Whether the phone number requires an Address registered with Twilio." + "description": "Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) registered with Twilio. Can be: `none`, `any`, `local`, or `foreign`." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to start a new TwiML session" + "description": "The API version used to start a new TwiML session." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", @@ -2830,24 +2830,24 @@ } }, "nullable": true, - "description": "Indicate if a phone can receive calls or messages" + "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`." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "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." }, "identity_sid": { "type": "string", @@ -2855,18 +2855,18 @@ "maxLength": 34, "pattern": "^RI[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Identity resource associated with number" + "description": "The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "origin": { "type": "string", "nullable": true, - "description": "The phone number's origin. Can be twilio or hosted." + "description": "The phone number's origin. `twilio` identifies Twilio-owned phone numbers and `hosted` identifies hosted phone numbers." }, "sid": { "type": "string", @@ -2874,7 +2874,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the resource." }, "sms_application_sid": { "type": "string", @@ -2882,7 +2882,7 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Application resource to handle SMS messages" + "description": "The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application." }, "sms_fallback_method": { "type": "string", @@ -2896,13 +2896,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with sms_fallback_url" + "description": "The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`." }, "sms_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML" + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`." }, "sms_method": { "type": "string", @@ -2916,19 +2916,19 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method to use with sms_url" + "description": "The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`." }, "sms_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives an incoming SMS message" + "description": "The URL we call when the phone number receives an incoming SMS message." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to send status information to your application" + "description": "The URL we call using the `status_callback_method` to send status information to your application." }, "status_callback_method": { "type": "string", @@ -2942,7 +2942,7 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call status_callback" + "description": "The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`." }, "trunk_sid": { "type": "string", @@ -2950,12 +2950,12 @@ "maxLength": 34, "pattern": "^TK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Trunk that handles calls to the phone number" + "description": "The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "voice_receive_mode": { "type": "string", @@ -2968,12 +2968,12 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the application that handles calls to the phone number" + "description": "The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa." }, "voice_caller_id_lookup": { "type": "boolean", "nullable": true, - "description": "Whether to lookup the caller's name" + "description": "Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: `true` or `false`." }, "voice_fallback_method": { "type": "string", @@ -2987,13 +2987,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with voice_fallback_url" + "description": "The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`." }, "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when an error occurs in TwiML" + "description": "The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`." }, "voice_method": { "type": "string", @@ -3007,19 +3007,19 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with the voice_url" + "description": "The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`." }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when this phone number receives a call" + "description": "The URL we call when this phone number receives a call. The `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` is set." }, "emergency_status": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_local_enum_emergency_status", "nullable": true, - "description": "Displays if emergency calling is enabled for this number." + "description": "The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country." }, "emergency_address_sid": { "type": "string", @@ -3027,13 +3027,13 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The emergency address configuration to use for emergency calling" + "description": "The SID of the emergency address configuration that we use for emergency calling from this phone number." }, "emergency_address_status": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_local_enum_emergency_address_status", "nullable": true, - "description": "State of the emergency address configuration for the phone number" + "description": "The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number." }, "bundle_sid": { "type": "string", @@ -3041,7 +3041,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Bundle resource associated with number" + "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations." }, "status": { "type": "string", @@ -3092,7 +3092,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource." }, "address_sid": { "type": "string", @@ -3100,23 +3100,23 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Address resource associated with the phone number" + "description": "The SID of the Address resource associated with the phone number." }, "address_requirements": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_mobile_enum_address_requirement", "nullable": true, - "description": "Whether the phone number requires an Address registered with Twilio." + "description": "Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) registered with Twilio. Can be: `none`, `any`, `local`, or `foreign`." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to start a new TwiML session" + "description": "The API version used to start a new TwiML session." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", @@ -3136,24 +3136,24 @@ } }, "nullable": true, - "description": "Indicate if a phone can receive calls or messages" + "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`." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "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." }, "identity_sid": { "type": "string", @@ -3161,18 +3161,18 @@ "maxLength": 34, "pattern": "^RI[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Identity resource associated with number" + "description": "The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "origin": { "type": "string", "nullable": true, - "description": "The phone number's origin. Can be twilio or hosted." + "description": "The phone number's origin. `twilio` identifies Twilio-owned phone numbers and `hosted` identifies hosted phone numbers." }, "sid": { "type": "string", @@ -3180,7 +3180,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the resource." }, "sms_application_sid": { "type": "string", @@ -3188,7 +3188,7 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the application that handles SMS messages sent to the phone number" + "description": "The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application." }, "sms_fallback_method": { "type": "string", @@ -3202,13 +3202,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with sms_fallback_url" + "description": "The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`." }, "sms_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML" + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`." }, "sms_method": { "type": "string", @@ -3222,19 +3222,19 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method to use with sms_url" + "description": "The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`." }, "sms_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives an incoming SMS message" + "description": "The URL we call when the phone number receives an incoming SMS message." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to send status information to your application" + "description": "The URL we call using the `status_callback_method` to send status information to your application." }, "status_callback_method": { "type": "string", @@ -3248,7 +3248,7 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call status_callback" + "description": "The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`." }, "trunk_sid": { "type": "string", @@ -3256,12 +3256,12 @@ "maxLength": 34, "pattern": "^TK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Trunk that handles calls to the phone number" + "description": "The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "voice_receive_mode": { "type": "string", @@ -3274,12 +3274,12 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the application that handles calls to the phone number" + "description": "The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa." }, "voice_caller_id_lookup": { "type": "boolean", "nullable": true, - "description": "Whether to lookup the caller's name" + "description": "Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: `true` or `false`." }, "voice_fallback_method": { "type": "string", @@ -3293,13 +3293,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with voice_fallback_url" + "description": "The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`." }, "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when an error occurs in TwiML" + "description": "The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`." }, "voice_method": { "type": "string", @@ -3313,19 +3313,19 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with the voice_url" + "description": "The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`." }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives a call" + "description": "The URL we call when the phone number receives a call. The `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` is set." }, "emergency_status": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_mobile_enum_emergency_status", "nullable": true, - "description": "Displays if emergency calling is enabled for this number." + "description": "The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country." }, "emergency_address_sid": { "type": "string", @@ -3333,13 +3333,13 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The emergency address configuration to use for emergency calling" + "description": "The SID of the emergency address configuration that we use for emergency calling from this phone number." }, "emergency_address_status": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_mobile_enum_emergency_address_status", "nullable": true, - "description": "State of the emergency address configuration for the phone number" + "description": "The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number." }, "bundle_sid": { "type": "string", @@ -3347,7 +3347,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Bundle resource associated with number" + "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations." }, "status": { "type": "string", @@ -3398,7 +3398,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource." }, "address_sid": { "type": "string", @@ -3406,23 +3406,23 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Address resource associated with the phone number" + "description": "The SID of the Address resource associated with the phone number." }, "address_requirements": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_toll_free_enum_address_requirement", "nullable": true, - "description": "Whether the phone number requires an Address registered with Twilio." + "description": "Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) registered with Twilio. Can be: `none`, `any`, `local`, or `foreign`." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to start a new TwiML session" + "description": "The API version used to start a new TwiML session." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", @@ -3442,24 +3442,24 @@ } }, "nullable": true, - "description": "Indicate if a phone can receive calls or messages" + "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`." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "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." }, "identity_sid": { "type": "string", @@ -3467,18 +3467,18 @@ "maxLength": 34, "pattern": "^RI[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Identity resource associated with number" + "description": "The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "origin": { "type": "string", "nullable": true, - "description": "The phone number's origin. Can be twilio or hosted." + "description": "The phone number's origin. `twilio` identifies Twilio-owned phone numbers and `hosted` identifies hosted phone numbers." }, "sid": { "type": "string", @@ -3486,7 +3486,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the resource." }, "sms_application_sid": { "type": "string", @@ -3494,7 +3494,7 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the application that handles SMS messages sent to the phone number" + "description": "The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application." }, "sms_fallback_method": { "type": "string", @@ -3508,13 +3508,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with sms_fallback_url" + "description": "The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`." }, "sms_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML" + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`." }, "sms_method": { "type": "string", @@ -3528,19 +3528,19 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method to use with sms_url" + "description": "The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`." }, "sms_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives an incoming SMS message" + "description": "The URL we call when the phone number receives an incoming SMS message." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to send status information to your application" + "description": "The URL we call using the `status_callback_method` to send status information to your application." }, "status_callback_method": { "type": "string", @@ -3554,7 +3554,7 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call status_callback" + "description": "The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`." }, "trunk_sid": { "type": "string", @@ -3562,12 +3562,12 @@ "maxLength": 34, "pattern": "^TK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Trunk that handles calls to the phone number" + "description": "The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "voice_receive_mode": { "type": "string", @@ -3580,12 +3580,12 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the application that handles calls to the phone number" + "description": "The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa." }, "voice_caller_id_lookup": { "type": "boolean", "nullable": true, - "description": "Whether to lookup the caller's name" + "description": "Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: `true` or `false`." }, "voice_fallback_method": { "type": "string", @@ -3599,13 +3599,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with voice_fallback_url" + "description": "The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`." }, "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when an error occurs in TwiML" + "description": "The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`." }, "voice_method": { "type": "string", @@ -3619,19 +3619,19 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with the voice_url" + "description": "The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`." }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives a call" + "description": "The URL we call when the phone number receives a call. The `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` is set." }, "emergency_status": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_toll_free_enum_emergency_status", "nullable": true, - "description": "Displays if emergency calling is enabled for this number." + "description": "The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country." }, "emergency_address_sid": { "type": "string", @@ -3639,13 +3639,13 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The emergency address configuration to use for emergency calling" + "description": "The SID of the emergency address configuration that we use for emergency calling from this phone number." }, "emergency_address_status": { "type": "string", "$ref": "#/components/schemas/incoming_phone_number_toll_free_enum_emergency_address_status", "nullable": true, - "description": "State of the emergency address configuration for the phone number" + "description": "The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number." }, "bundle_sid": { "type": "string", @@ -3653,7 +3653,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Bundle resource associated with number" + "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations." }, "status": { "type": "string", @@ -3704,24 +3704,24 @@ "maxLength": 34, "pattern": "^SK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Key resource." }, "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." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." } } }, @@ -3734,24 +3734,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created this resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Media resource." }, "content_type": { "type": "string", "nullable": true, - "description": "The default mime-type of the media" + "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 RFC 2822 date and time in GMT that this resource was created" + "description": "The date and time in GMT that this 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 RFC 2822 date and time in GMT that this resource was last updated" + "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." }, "parent_sid": { "type": "string", @@ -3759,7 +3759,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 resource that created the media." }, "sid": { "type": "string", @@ -3767,12 +3767,12 @@ "maxLength": 34, "pattern": "^ME[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies this resource" + "description": "The unique string that that we created to identify 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 resource, relative to `https://api.twilio.com`." } } }, @@ -3785,13 +3785,13 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Member resource is associated with." }, "date_enqueued": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date the member was enqueued" + "description": "The date that the member was enqueued, given in RFC 2822 format." }, "position": { "type": "integer", @@ -3801,7 +3801,7 @@ "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "wait_time": { "type": "integer", @@ -3814,7 +3814,7 @@ "maxLength": 34, "pattern": "^QU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Queue the member is in" + "description": "The SID of the Queue the member is in." } } }, @@ -3824,50 +3824,50 @@ "body": { "type": "string", "nullable": true, - "description": "The message text" + "description": "The message text. Can be up to 1,600 characters long." }, "num_segments": { "type": "string", "nullable": true, - "description": "The number of messages used to deliver the message body" + "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." }, "direction": { "type": "string", "$ref": "#/components/schemas/message_enum_direction", "nullable": true, - "description": "The direction of the message" + "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." }, "from": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number that initiated the message" + "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." }, "to": { "type": "string", "nullable": true, - "description": "The phone number that received the message" + "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." }, "date_updated": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "price": { "type": "string", "nullable": true, - "description": "The amount billed for the message" + "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." }, "error_message": { "type": "string", "nullable": true, - "description": "The description of the error_code" + "description": "The description of the `error_code` if your message `status` is `failed` or `undelivered`. If the message was successful, this 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 resource, relative to `https://api.twilio.com`." }, "account_sid": { "type": "string", @@ -3875,18 +3875,18 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that sent the message that created the resource." }, "num_media": { "type": "string", "nullable": true, - "description": "The number of media files associated with the message" + "description": "The number of media files associated with the message. A message can send up to 10 media files." }, "status": { "type": "string", "$ref": "#/components/schemas/message_enum_status", "nullable": true, - "description": "The status of the message" + "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)." }, "messaging_service_sid": { "type": "string", @@ -3894,7 +3894,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Messaging Service used with the message." + "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." }, "sid": { "type": "string", @@ -3902,41 +3902,41 @@ "maxLength": 34, "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Message resource." }, "date_sent": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the message was sent" + "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. " }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." }, "error_code": { "type": "integer", "nullable": true, - "description": "The error code associated with the message" + "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." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which price is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)." }, "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 relative URIs" + "description": "A list of related resources identified by their URIs relative to `https://api.twilio.com`" } } }, @@ -4006,7 +4006,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the MessageFeedback resource." }, "message_sid": { "type": "string", @@ -4014,30 +4014,30 @@ "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 for which the feedback was provided." }, "outcome": { "type": "string", "$ref": "#/components/schemas/message_feedback_enum_outcome", "nullable": true, - "description": "Whether the feedback has arrived" + "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`." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -4057,29 +4057,29 @@ "maxLength": 34, "pattern": "^SK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the NewKey resource. You will use this as the basic-auth `user` when authenticating to the API." }, "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." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "description": "The date and time in GMT that the API Key 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 RFC 2822 date and time in GMT that the resource was last updated" + "description": "The date and time in GMT that the new API Key was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." }, "secret": { "type": "string", "nullable": true, - "description": "The secret your application uses to sign Access Tokens and to authenticate to the REST API." + "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.**" } } }, @@ -4092,29 +4092,29 @@ "maxLength": 34, "pattern": "^SK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the NewSigningKey resource." }, "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." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "secret": { "type": "string", "nullable": true, - "description": "The secret your application uses to sign Access Tokens and to authenticate to the REST API." + "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.**" } } }, @@ -4127,12 +4127,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resource." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to generate the notification" + "description": "The API version used to generate the notification. Can be empty for events that don't have a specific API version, such as incoming phone calls." }, "call_sid": { "type": "string", @@ -4140,46 +4140,46 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Notification resource is associated with." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "error_code": { "type": "string", "nullable": true, - "description": "A unique error code corresponding to the notification" + "description": "A unique error code for the error condition that is described in our [Error Dictionary](https://www.twilio.com/docs/api/errors)." }, "log": { "type": "string", "nullable": true, - "description": "An integer log level" + "description": "An integer log level that corresponds to the type of notification: `0` is ERROR, `1` is WARNING." }, "message_date": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date the notification was generated" + "description": "The date the notification was actually generated in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. Message buffering can cause this value to differ from `date_created`." }, "message_text": { "type": "string", "nullable": true, - "description": "The text of the notification" + "description": "The text of the notification." }, "more_info": { "type": "string", "format": "uri", "nullable": true, - "description": "A URL for more information about the error code" + "description": "The URL for more information about the error condition. This value is a page in our [Error Dictionary](https://www.twilio.com/docs/api/errors)." }, "request_method": { "type": "string", @@ -4193,13 +4193,13 @@ "DELETE" ], "nullable": true, - "description": "HTTP method used with the request url" + "description": "The HTTP method used to generate the notification. If the notification was generated during a phone call, this is the HTTP Method used to request the resource on your server. If the notification was generated by your use of our REST API, this is the HTTP method used to call the resource on our servers." }, "request_url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of the resource that generated the notification" + "description": "The URL of the resource that generated the notification. If the notification was generated during a phone call, this is the URL of the resource on your server that caused the notification. If the notification was generated by your use of our REST API, this is the URL of the resource you called." }, "sid": { "type": "string", @@ -4207,12 +4207,12 @@ "maxLength": 34, "pattern": "^NO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Notification resource." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -4225,12 +4225,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resource." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to generate the notification" + "description": "The API version used to generate the notification. Can be empty for events that don't have a specific API version, such as incoming phone calls." }, "call_sid": { "type": "string", @@ -4238,46 +4238,46 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Notification resource is associated with." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "error_code": { "type": "string", "nullable": true, - "description": "A unique error code corresponding to the notification" + "description": "A unique error code for the error condition that is described in our [Error Dictionary](https://www.twilio.com/docs/api/errors)." }, "log": { "type": "string", "nullable": true, - "description": "An integer log level" + "description": "An integer log level that corresponds to the type of notification: `0` is ERROR, `1` is WARNING." }, "message_date": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date the notification was generated" + "description": "The date the notification was actually generated in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. Message buffering can cause this value to differ from `date_created`." }, "message_text": { "type": "string", "nullable": true, - "description": "The text of the notification" + "description": "The text of the notification." }, "more_info": { "type": "string", "format": "uri", "nullable": true, - "description": "A URL for more information about the error code" + "description": "The URL for more information about the error condition. This value is a page in our [Error Dictionary](https://www.twilio.com/docs/api/errors)." }, "request_method": { "type": "string", @@ -4291,28 +4291,28 @@ "DELETE" ], "nullable": true, - "description": "HTTP method used with the request url" + "description": "The HTTP method used to generate the notification. If the notification was generated during a phone call, this is the HTTP Method used to request the resource on your server. If the notification was generated by your use of our REST API, this is the HTTP method used to call the resource on our servers." }, "request_url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of the resource that generated the notification" + "description": "The URL of the resource that generated the notification. If the notification was generated during a phone call, this is the URL of the resource on your server that caused the notification. If the notification was generated by your use of our REST API, this is the URL of the resource you called." }, "request_variables": { "type": "string", "nullable": true, - "description": "Twilio-generated HTTP variables sent to the server" + "description": "The HTTP GET or POST variables we sent to your server. However, if the notification was generated by our REST API, this contains the HTTP POST or PUT variables you sent to our API." }, "response_body": { "type": "string", "nullable": true, - "description": "The HTTP body returned by your server" + "description": "The HTTP body returned by your server." }, "response_headers": { "type": "string", "nullable": true, - "description": "The HTTP headers returned by your server" + "description": "The HTTP headers returned by your server." }, "sid": { "type": "string", @@ -4320,12 +4320,12 @@ "maxLength": 34, "pattern": "^NO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Notification resource." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -4338,24 +4338,24 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the OutgoingCallerId resource." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "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." }, "account_sid": { "type": "string", @@ -4363,18 +4363,18 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resource." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -4387,7 +4387,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resource." }, "call_sid": { "type": "string", @@ -4395,12 +4395,12 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Participant resource is associated with." }, "label": { "type": "string", "nullable": true, - "description": "The label of this participant" + "description": "The user-specified label of this participant, if one was given when the participant was created. This may be used to fetch, update or delete the participant." }, "call_sid_to_coach": { "type": "string", @@ -4408,12 +4408,12 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the participant who is being `coached`" + "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`." }, "coaching": { "type": "boolean", "nullable": true, - "description": "Indicates if the participant changed to coach" + "description": "Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined." }, "conference_sid": { "type": "string", @@ -4421,50 +4421,50 @@ "maxLength": 34, "pattern": "^CF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the conference the participant is in" + "description": "The SID of the conference the participant is in." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "end_conference_on_exit": { "type": "boolean", "nullable": true, - "description": "Whether the conference ends when the participant leaves" + "description": "Whether the conference ends when the participant leaves. Can be: `true` or `false` and the default is `false`. If `true`, the conference ends and all other participants drop out when the participant leaves." }, "muted": { "type": "boolean", "nullable": true, - "description": "Whether the participant is muted" + "description": "Whether the participant is muted. Can be `true` or `false`." }, "hold": { "type": "boolean", "nullable": true, - "description": "Whether the participant is on hold" + "description": "Whether the participant is on hold. Can be `true` or `false`." }, "start_conference_on_enter": { "type": "boolean", "nullable": true, - "description": "Whether the conference starts when the participant joins the conference" + "description": "Whether the conference starts when the participant joins the conference, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference." }, "status": { "type": "string", "$ref": "#/components/schemas/participant_enum_status", "nullable": true, - "description": "The status of the participant's call in a session" + "description": "The status of the participant's call in a session. Can be: `queued`, `connecting`, `ringing`, `connected`, `complete`, or `failed`." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -4488,7 +4488,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Payments resource." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Payments resource." }, "call_sid": { "type": "string", @@ -4496,7 +4496,7 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with." + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Payments resource is associated with. This will refer to the call sid that is producing the payment card (credit/ACH) information thru DTMF." }, "sid": { "type": "string", @@ -4510,18 +4510,18 @@ "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -4572,7 +4572,7 @@ "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that this resource was last updated" + "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." }, "current_size": { "type": "integer", @@ -4582,12 +4582,12 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A string that you assigned to describe this resource" + "description": "A string that you assigned to describe this resource." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of this resource, relative to `https://api.twilio.com`" + "description": "The URI of this resource, relative to `https://api.twilio.com`." }, "account_sid": { "type": "string", @@ -4595,12 +4595,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created this resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Queue resource." }, "average_wait_time": { "type": "integer", "nullable": true, - "description": "Average wait time of members in the queue" + "description": " The average wait time in seconds of the members in this queue. This is calculated at the time of the request." }, "sid": { "type": "string", @@ -4608,18 +4608,18 @@ "maxLength": 34, "pattern": "^QU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies this resource" + "description": "The unique string that that we created to identify this Queue resource." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that this resource was created" + "description": "The date and time in GMT that this resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." }, "max_size": { "type": "integer", "nullable": true, - "description": "The max number of calls allowed in the queue" + "description": " The maximum number of calls that can be in the queue. The default is 100 and the maximum is 5000." } } }, @@ -4632,7 +4632,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource." }, "api_version": { "type": "string", @@ -4645,7 +4645,7 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Recording resource is associated with. This will always refer to the parent leg of a two-leg call." }, "conference_sid": { "type": "string", @@ -4653,25 +4653,25 @@ "maxLength": 34, "pattern": "^CF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID for the conference associated with the recording." + "description": "The Conference SID that identifies the conference associated with the recording, if a conference recording." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "start_time": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The start time of the recording, given in RFC 2822 format" + "description": "The start time of the recording in GMT and in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." }, "duration": { "type": "string", @@ -4684,60 +4684,60 @@ "maxLength": 34, "pattern": "^RE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Recording resource." }, "price": { "type": "string", "nullable": true, - "description": "The one-time cost of creating the recording." + "description": "The one-time cost of creating the recording in the `price_unit` currency." }, "price_unit": { "type": "string", "nullable": true, - "description": "The currency used in the price property." + "description": "The currency used in the `price` property. Example: `USD`." }, "status": { "type": "string", "$ref": "#/components/schemas/recording_enum_status", "nullable": true, - "description": "The status of the recording." + "description": "The status of the recording. Can be: `processing`, `completed`, `absent` or `deleted`. For information about more detailed statuses on in-progress recordings, check out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource)." }, "channels": { "type": "integer", "nullable": true, - "description": "The number of channels in the final recording file as an integer." + "description": "The number of channels in the final recording file. Can be: `1` or `2`. You can split a call with two legs into two separate recording channels if you record using [TwiML Dial](https://www.twilio.com/docs/voice/twiml/dial#record) or the [Outbound Rest API](https://www.twilio.com/docs/voice/make-calls#manage-your-outbound-call)." }, "source": { "type": "string", "$ref": "#/components/schemas/recording_enum_source", "nullable": true, - "description": "How the recording was created" + "description": "How the recording was created. Can be: `DialVerb`, `Conference`, `OutboundAPI`, `Trunking`, `RecordVerb`, `StartCallRecordingAPI`, and `StartConferenceRecordingAPI`." }, "error_code": { "type": "integer", "nullable": true, - "description": "More information about why the recording is missing, if status is `absent`." + "description": "The error code that describes why the recording is `absent`. The error code is described in our [Error Dictionary](https://www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "encryption_details": { "nullable": true, - "description": "How to decrypt the recording." + "description": "How to decrypt the recording if it was encrypted using [Call Recording Encryption](https://www.twilio.com/docs/voice/tutorials/voice-recording-encryption) feature." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their relative URIs." }, "media_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the media file." + "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." } } }, @@ -4774,7 +4774,7 @@ "maxLength": 34, "pattern": "^XR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Recording AddOnResult resource." }, "account_sid": { "type": "string", @@ -4782,13 +4782,13 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resource." }, "status": { "type": "string", "$ref": "#/components/schemas/recording_add_on_result_enum_status", "nullable": true, - "description": "The status of the result" + "description": "The status of the result. Can be: `canceled`, `completed`, `deleted`, `failed`, `in-progress`, `init`, `processing`, `queued`." }, "add_on_sid": { "type": "string", @@ -4796,7 +4796,7 @@ "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Add-on to which the result belongs" + "description": "The SID of the Add-on to which the result belongs." }, "add_on_configuration_sid": { "type": "string", @@ -4804,25 +4804,25 @@ "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Add-on configuration" + "description": "The SID of the Add-on configuration." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "date_completed": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date and time in GMT that the result was completed" + "description": "The date and time in GMT that the result was completed specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." }, "reference_sid": { "type": "string", @@ -4830,13 +4830,13 @@ "maxLength": 34, "pattern": "^RE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the recording to which the AddOnResult resource belongs" + "description": "The SID of the recording to which the AddOnResult resource belongs." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their relative URIs." } } }, @@ -4862,7 +4862,7 @@ "maxLength": 34, "pattern": "^XH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Recording AddOnResult Payload resource." }, "add_on_result_sid": { "type": "string", @@ -4870,7 +4870,7 @@ "maxLength": 34, "pattern": "^XR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the AddOnResult to which the payload belongs" + "description": "The SID of the AddOnResult to which the payload belongs." }, "account_sid": { "type": "string", @@ -4878,12 +4878,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resource." }, "label": { "type": "string", "nullable": true, - "description": "The string that describes the payload" + "description": "The string provided by the vendor that describes the payload." }, "add_on_sid": { "type": "string", @@ -4891,7 +4891,7 @@ "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Add-on to which the result belongs" + "description": "The SID of the Add-on to which the result belongs." }, "add_on_configuration_sid": { "type": "string", @@ -4899,24 +4899,24 @@ "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Add-on configuration" + "description": "The SID of the Add-on configuration." }, "content_type": { "type": "string", "nullable": true, - "description": "The MIME type of the payload" + "description": "The MIME type of the payload." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "reference_sid": { "type": "string", @@ -4924,13 +4924,13 @@ "maxLength": 34, "pattern": "^RE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the recording to which the AddOnResult resource that contains the payload belongs" + "description": "The SID of the recording to which the AddOnResult resource that contains the payload belongs." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their relative URIs." } } }, @@ -4943,24 +4943,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resource." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the transcription" + "description": "The API version used to create the transcription." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "duration": { "type": "string", @@ -4970,13 +4970,13 @@ "price": { "type": "number", "nullable": true, - "description": "The charge for the transcription" + "description": "The charge for the transcript in the currency associated with the account. This value is populated after the transcript is complete so it may not be available immediately." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which price is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)." }, "recording_sid": { "type": "string", @@ -4984,7 +4984,7 @@ "maxLength": 34, "pattern": "^RE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID that identifies the transcription's recording" + "description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) from which the transcription was created." }, "sid": { "type": "string", @@ -4992,13 +4992,13 @@ "maxLength": 34, "pattern": "^TR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Transcription resource." }, "status": { "type": "string", "$ref": "#/components/schemas/recording_transcription_enum_status", "nullable": true, - "description": "The status of the transcription" + "description": "The status of the transcription. Can be: `in-progress`, `completed`, `failed`." }, "transcription_text": { "type": "string", @@ -5008,12 +5008,12 @@ "type": { "type": "string", "nullable": true, - "description": "The transcription type" + "description": "The transcription type." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -5034,29 +5034,29 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created this resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this ShortCode resource." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to start a new TwiML session" + "description": "The API version used to start a new TwiML session when an SMS message is sent to this short code." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that this resource was created" + "description": "The date and time in GMT that this 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 RFC 2822 date and time in GMT that this resource was last updated" + "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." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A string that you assigned to describe this resource" + "description": "A string that you assigned to describe this resource. By default, the `FriendlyName` is the short code." }, "short_code": { "type": "string", @@ -5069,7 +5069,7 @@ "maxLength": 34, "pattern": "^SC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies this resource" + "description": "The unique string that that we created to identify this ShortCode resource." }, "sms_fallback_method": { "type": "string", @@ -5083,13 +5083,13 @@ "DELETE" ], "nullable": true, - "description": "HTTP method we use to call the sms_fallback_url" + "description": "The HTTP method we use to call the `sms_fallback_url`. Can be: `GET` or `POST`." }, "sms_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL Twilio will request if an error occurs in executing TwiML" + "description": "The URL that we call if an error occurs while retrieving or executing the TwiML from `sms_url`." }, "sms_method": { "type": "string", @@ -5103,18 +5103,18 @@ "DELETE" ], "nullable": true, - "description": "HTTP method to use when requesting the sms url" + "description": "The HTTP method we use to call the `sms_url`. Can be: `GET` or `POST`." }, "sms_url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL we call when receiving an incoming SMS message to this short code" + "description": "The URL we call when receiving an incoming SMS message to this short code." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of this resource, relative to `https://api.twilio.com`" + "description": "The URI of this resource, relative to `https://api.twilio.com`." } } }, @@ -5165,24 +5165,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resource." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "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." }, "sid": { "type": "string", @@ -5190,7 +5190,7 @@ "maxLength": 34, "pattern": "^CL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the CredentialListMapping resource." } } }, @@ -5203,24 +5203,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IpAccessControlListMapping resource." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "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." }, "sid": { "type": "string", @@ -5228,7 +5228,7 @@ "maxLength": 34, "pattern": "^AL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the IpAccessControlListMapping resource." } } }, @@ -5245,24 +5245,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resource." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "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." }, "sid": { "type": "string", @@ -5270,7 +5270,7 @@ "maxLength": 34, "pattern": "^CL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the CredentialListMapping resource." } } }, @@ -5299,7 +5299,7 @@ "maxLength": 34, "pattern": "^CL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique id that identifies the credential list that includes this credential" + "description": "The unique id that identifies the credential list that includes this credential." }, "username": { "type": "string", @@ -5310,18 +5310,18 @@ "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date that this resource was created, given as GMT in RFC 2822 format." + "description": "The date that this resource was created, given as GMT 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 as GMT in RFC 2822 format." + "description": "The date that this resource was last updated, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." }, "uri": { "type": "string", "nullable": true, - "description": "The URI for this resource, relative to https://api.twilio.com" + "description": "The URI for this resource, relative to `https://api.twilio.com`" } } }, @@ -5334,24 +5334,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique sid that identifies this account" + "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) that owns this resource." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date this resource was created" + "description": "The date that this resource was created, given as GMT 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 this resource was last updated" + "description": "The date that this resource was last updated, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." }, "friendly_name": { "type": "string", "nullable": true, - "description": "Human readable descriptive text" + "description": "A human readable descriptive text that describes the CredentialList, up to 64 characters long." }, "sid": { "type": "string", @@ -5359,18 +5359,18 @@ "maxLength": 34, "pattern": "^CL[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this credential" + "description": "A 34 character string that uniquely identifies this resource." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The list of credentials associated with this credential list." + "description": "A list of credentials associated with this credential list." }, "uri": { "type": "string", "nullable": true, - "description": "The URI for this resource" + "description": "The URI for this resource, relative to `https://api.twilio.com`." } } }, @@ -5389,13 +5389,13 @@ "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date that this resource was created, given as GMT in RFC 2822 format." + "description": "The date that this resource was created, given as GMT 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 as GMT in RFC 2822 format." + "description": "The date that this resource was last updated, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." }, "domain_sid": { "type": "string", @@ -5403,7 +5403,7 @@ "maxLength": 34, "pattern": "^SD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the SipDomain resource." + "description": "The unique string that is created to identify the SipDomain resource." }, "friendly_name": { "type": "string", @@ -5421,7 +5421,7 @@ "uri": { "type": "string", "nullable": true, - "description": "The URI for this resource, relative to https://api.twilio.com" + "description": "The URI for this resource, relative to `https://api.twilio.com`" } } }, @@ -5434,39 +5434,39 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resource." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to process the call" + "description": "The API version used to process the call." }, "auth_type": { "type": "string", "nullable": true, - "description": "The types of authentication mapped to the domain" + "description": "The types of authentication you have mapped to your domain. Can be: `IP_ACL` and `CREDENTIAL_LIST`. If you have both defined for your domain, both will be returned in a comma delimited string. If `auth_type` is not defined, the domain will not be able to receive any traffic." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "domain_name": { "type": "string", "nullable": true, - "description": "The unique address on Twilio to route SIP traffic" + "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \"-\" and must end with `sip.twilio.com`." }, "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." }, "sid": { "type": "string", @@ -5474,12 +5474,12 @@ "maxLength": 34, "pattern": "^SD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the SipDomain resource." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "voice_fallback_method": { "type": "string", @@ -5493,13 +5493,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with voice_fallback_url" + "description": "The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`." }, "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when an error occurs while executing TwiML" + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`." }, "voice_method": { "type": "string", @@ -5513,7 +5513,7 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method to use with voice_url" + "description": "The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`." }, "voice_status_callback_method": { "type": "string", @@ -5527,40 +5527,40 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call voice_status_callback_url" + "description": "The HTTP method we use to call `voice_status_callback_url`. Either `GET` or `POST`." }, "voice_status_callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call with status updates" + "description": "The URL that we call to pass status parameters (such as call ended) to your application." }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when receiving a call" + "description": "The URL we call using the `voice_method` when the domain receives a call." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list mapping resources associated with the SIP Domain resource" + "description": "A list of mapping resources associated with the SIP Domain resource identified by their relative URIs." }, "sip_registration": { "type": "boolean", "nullable": true, - "description": "Whether SIP registration is allowed" + "description": "Whether to allow SIP Endpoints to register with the domain to receive calls." }, "emergency_calling_enabled": { "type": "boolean", "nullable": true, - "description": "Whether emergency calling is enabled for the domain." + "description": "Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses." }, "secure": { "type": "boolean", "nullable": true, - "description": "Whether secure SIP is enabled for the domain" + "description": "Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain." }, "byoc_trunk_sid": { "type": "string", @@ -5568,7 +5568,7 @@ "maxLength": 34, "pattern": "^BY[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the BYOC Trunk resource." + "description": "The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with." }, "emergency_caller_sid": { "type": "string", @@ -5576,7 +5576,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "Whether an emergency caller sid is configured for the domain." + "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." } } }, @@ -5589,7 +5589,7 @@ "maxLength": 34, "pattern": "^AL[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this resource" + "description": "A 34 character string that uniquely identifies this resource." }, "account_sid": { "type": "string", @@ -5597,35 +5597,35 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique sid that identifies this account" + "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) that owns this resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this resource" + "description": "A human readable descriptive text, up to 255 characters long." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date this resource was created" + "description": "The date that this resource was created, given as GMT 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 this resource was last updated" + "description": "The date that this resource was last updated, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The IP addresses associated with this resource." + "description": "A list of the IpAddress resources associated with this IP access control list resource." }, "uri": { "type": "string", "nullable": true, - "description": "The URI for this resource" + "description": "The URI for this resource, relative to `https://api.twilio.com`" } } }, @@ -5644,13 +5644,13 @@ "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date that this resource was created, given as GMT in RFC 2822 format." + "description": "The date that this resource was created, given as GMT 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 as GMT in RFC 2822 format." + "description": "The date that this resource was last updated, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." }, "domain_sid": { "type": "string", @@ -5658,7 +5658,7 @@ "maxLength": 34, "pattern": "^SD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the SipDomain resource." + "description": "The unique string that is created to identify the SipDomain resource." }, "friendly_name": { "type": "string", @@ -5676,7 +5676,7 @@ "uri": { "type": "string", "nullable": true, - "description": "The URI for this resource, relative to https://api.twilio.com" + "description": "The URI for this resource, relative to `https://api.twilio.com`" } } }, @@ -5726,18 +5726,18 @@ "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date that this resource was created, given as GMT in RFC 2822 format." + "description": "The date that this resource was created, given as GMT 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 as GMT in RFC 2822 format." + "description": "The date that this resource was last updated, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format." }, "uri": { "type": "string", "nullable": true, - "description": "The URI for this resource, relative to https://api.twilio.com" + "description": "The URI for this resource, relative to `https://api.twilio.com`" } } }, @@ -5758,7 +5758,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created this resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Siprec resource." }, "call_sid": { "type": "string", @@ -5766,12 +5766,12 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Siprec resource is associated with." }, "name": { "type": "string", "nullable": true, - "description": "The name of this resource" + "description": "The user-specified name of this Siprec, if one was given when the Siprec was created. This may be used to stop the Siprec." }, "status": { "type": "string", @@ -5783,12 +5783,12 @@ "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that this resource was last updated" + "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." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -5830,7 +5830,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created this resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Stream resource." }, "call_sid": { "type": "string", @@ -5838,12 +5838,12 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Stream resource is associated with." }, "name": { "type": "string", "nullable": true, - "description": "The name of this resource" + "description": "The user-specified name of this Stream, if one was given when the Stream was created. This may be used to stop the Stream." }, "status": { "type": "string", @@ -5855,12 +5855,12 @@ "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that this resource was last updated" + "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." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -5894,19 +5894,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Token resource." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "ice_servers": { "type": "array", @@ -5929,22 +5929,22 @@ } }, "nullable": true, - "description": "An array representing the ephemeral credentials" + "description": "An array representing the ephemeral credentials and the STUN and TURN server URIs." }, "password": { "type": "string", "nullable": true, - "description": "The temporary password used for authenticating" + "description": "The temporary password that the username will use when authenticating with Twilio." }, "ttl": { "type": "string", "nullable": true, - "description": "The duration in seconds the credentials are valid" + "description": "The duration in seconds for which the username and password are valid." }, "username": { "type": "string", "nullable": true, - "description": "The temporary username that uniquely identifies a Token" + "description": "The temporary username that uniquely identifies a Token." } } }, @@ -5957,24 +5957,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resource." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the transcription" + "description": "The API version used to create the transcription." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "duration": { "type": "string", @@ -5984,13 +5984,13 @@ "price": { "type": "number", "nullable": true, - "description": "The charge for the transcription" + "description": "The charge for the transcript in the currency associated with the account. This value is populated after the transcript is complete so it may not be available immediately." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which price is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)." }, "recording_sid": { "type": "string", @@ -5998,7 +5998,7 @@ "maxLength": 34, "pattern": "^RE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID that identifies the transcription's recording" + "description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) from which the transcription was created." }, "sid": { "type": "string", @@ -6006,13 +6006,13 @@ "maxLength": 34, "pattern": "^TR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Transcription resource." }, "status": { "type": "string", "$ref": "#/components/schemas/transcription_enum_status", "nullable": true, - "description": "The status of the transcription" + "description": "The status of the transcription. Can be: `in-progress`, `completed`, `failed`." }, "transcription_text": { "type": "string", @@ -6022,12 +6022,12 @@ "type": { "type": "string", "nullable": true, - "description": "The transcription type" + "description": "The transcription type. Can only be: `fast`." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." } } }, @@ -6052,82 +6052,82 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account accrued the usage" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that accrued the usage." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the resource" + "description": "The API version used to create the resource." }, "as_of": { "type": "string", "nullable": true, - "description": "Usage records up to date as of this timestamp" + "description": "Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT" }, "category": { "type": "string", "$ref": "#/components/schemas/usage_record_enum_category", "nullable": true, - "description": "The category of usage" + "description": "The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories)." }, "count": { "type": "string", "nullable": true, - "description": "The number of usage events" + "description": "The number of usage events, such as the number of calls." }, "count_unit": { "type": "string", "nullable": true, - "description": "The units in which count is measured" + "description": "The units in which `count` is measured, such as `calls` for calls or `messages` for SMS." }, "description": { "type": "string", "nullable": true, - "description": "A plain-language description of the usage category" + "description": "A plain-language description of the usage category." }, "end_date": { "type": "string", "format": "date", "nullable": true, - "description": "The last date for which usage is included in the UsageRecord" + "description": "The last date for which usage is included in the UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "price": { "type": "number", "nullable": true, - "description": "The total price of the usage" + "description": "The total price of the usage in the currency specified in `price_unit` and associated with the account." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which `price` is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format, such as `usd`, `eur`, and `jpy`." }, "start_date": { "type": "string", "format": "date", "nullable": true, - "description": "The first date for which usage is included in this UsageRecord" + "description": "The first date for which usage is included in this UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their URIs. For more information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources)." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "usage": { "type": "string", "nullable": true, - "description": "The amount of usage" + "description": "The amount used to bill usage and measured in units described in `usage_unit`." }, "usage_unit": { "type": "string", "nullable": true, - "description": "The units in which usage is measured" + "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } } }, @@ -6390,82 +6390,82 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account accrued the usage" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that accrued the usage." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the resource" + "description": "The API version used to create the resource." }, "as_of": { "type": "string", "nullable": true, - "description": "Usage records up to date as of this timestamp" + "description": "Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT" }, "category": { "type": "string", "$ref": "#/components/schemas/usage_record_all_time_enum_category", "nullable": true, - "description": "The category of usage" + "description": "The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories)." }, "count": { "type": "string", "nullable": true, - "description": "The number of usage events" + "description": "The number of usage events, such as the number of calls." }, "count_unit": { "type": "string", "nullable": true, - "description": "The units in which count is measured" + "description": "The units in which `count` is measured, such as `calls` for calls or `messages` for SMS." }, "description": { "type": "string", "nullable": true, - "description": "A plain-language description of the usage category" + "description": "A plain-language description of the usage category." }, "end_date": { "type": "string", "format": "date", "nullable": true, - "description": "The last date for which usage is included in the UsageRecord" + "description": "The last date for which usage is included in the UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "price": { "type": "number", "nullable": true, - "description": "The total price of the usage" + "description": "The total price of the usage in the currency specified in `price_unit` and associated with the account." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which `price` is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format, such as `usd`, `eur`, and `jpy`." }, "start_date": { "type": "string", "format": "date", "nullable": true, - "description": "The first date for which usage is included in this UsageRecord" + "description": "The first date for which usage is included in this UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their URIs. For more information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources)." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "usage": { "type": "string", "nullable": true, - "description": "The amount of usage" + "description": "The amount used to bill usage and measured in units described in `usage_unit`." }, "usage_unit": { "type": "string", "nullable": true, - "description": "The units in which usage is measured" + "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } } }, @@ -6728,82 +6728,82 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account accrued the usage" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that accrued the usage." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the resource" + "description": "The API version used to create the resource." }, "as_of": { "type": "string", "nullable": true, - "description": "Usage records up to date as of this timestamp" + "description": "Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT" }, "category": { "type": "string", "$ref": "#/components/schemas/usage_record_daily_enum_category", "nullable": true, - "description": "The category of usage" + "description": "The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories)." }, "count": { "type": "string", "nullable": true, - "description": "The number of usage events" + "description": "The number of usage events, such as the number of calls." }, "count_unit": { "type": "string", "nullable": true, - "description": "The units in which count is measured" + "description": "The units in which `count` is measured, such as `calls` for calls or `messages` for SMS." }, "description": { "type": "string", "nullable": true, - "description": "A plain-language description of the usage category" + "description": "A plain-language description of the usage category." }, "end_date": { "type": "string", "format": "date", "nullable": true, - "description": "The last date for which usage is included in the UsageRecord" + "description": "The last date for which usage is included in the UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "price": { "type": "number", "nullable": true, - "description": "The total price of the usage" + "description": "The total price of the usage in the currency specified in `price_unit` and associated with the account." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which `price` is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format, such as `usd`, `eur`, and `jpy`." }, "start_date": { "type": "string", "format": "date", "nullable": true, - "description": "The first date for which usage is included in this UsageRecord" + "description": "The first date for which usage is included in this UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their URIs. For more information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources)." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "usage": { "type": "string", "nullable": true, - "description": "The amount of usage" + "description": "The amount used to bill usage and measured in units described in `usage_unit`." }, "usage_unit": { "type": "string", "nullable": true, - "description": "The units in which usage is measured" + "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } } }, @@ -7066,82 +7066,82 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account accrued the usage" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that accrued the usage." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the resource" + "description": "The API version used to create the resource." }, "as_of": { "type": "string", "nullable": true, - "description": "Usage records up to date as of this timestamp" + "description": "Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT" }, "category": { "type": "string", "$ref": "#/components/schemas/usage_record_last_month_enum_category", "nullable": true, - "description": "The category of usage" + "description": "The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories)." }, "count": { "type": "string", "nullable": true, - "description": "The number of usage events" + "description": "The number of usage events, such as the number of calls." }, "count_unit": { "type": "string", "nullable": true, - "description": "The units in which count is measured" + "description": "The units in which `count` is measured, such as `calls` for calls or `messages` for SMS." }, "description": { "type": "string", "nullable": true, - "description": "A plain-language description of the usage category" + "description": "A plain-language description of the usage category." }, "end_date": { "type": "string", "format": "date", "nullable": true, - "description": "The last date for which usage is included in the UsageRecord" + "description": "The last date for which usage is included in the UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "price": { "type": "number", "nullable": true, - "description": "The total price of the usage" + "description": "The total price of the usage in the currency specified in `price_unit` and associated with the account." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which `price` is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format, such as `usd`, `eur`, and `jpy`." }, "start_date": { "type": "string", "format": "date", "nullable": true, - "description": "The first date for which usage is included in this UsageRecord" + "description": "The first date for which usage is included in this UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their URIs. For more information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources)." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "usage": { "type": "string", "nullable": true, - "description": "The amount of usage" + "description": "The amount used to bill usage and measured in units described in `usage_unit`." }, "usage_unit": { "type": "string", "nullable": true, - "description": "The units in which usage is measured" + "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } } }, @@ -7404,82 +7404,82 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account accrued the usage" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that accrued the usage." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the resource" + "description": "The API version used to create the resource." }, "as_of": { "type": "string", "nullable": true, - "description": "Usage records up to date as of this timestamp" + "description": "Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT" }, "category": { "type": "string", "$ref": "#/components/schemas/usage_record_monthly_enum_category", "nullable": true, - "description": "The category of usage" + "description": "The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories)." }, "count": { "type": "string", "nullable": true, - "description": "The number of usage events" + "description": "The number of usage events, such as the number of calls." }, "count_unit": { "type": "string", "nullable": true, - "description": "The units in which count is measured" + "description": "The units in which `count` is measured, such as `calls` for calls or `messages` for SMS." }, "description": { "type": "string", "nullable": true, - "description": "A plain-language description of the usage category" + "description": "A plain-language description of the usage category." }, "end_date": { "type": "string", "format": "date", "nullable": true, - "description": "The last date for which usage is included in the UsageRecord" + "description": "The last date for which usage is included in the UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "price": { "type": "number", "nullable": true, - "description": "The total price of the usage" + "description": "The total price of the usage in the currency specified in `price_unit` and associated with the account." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which `price` is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format, such as `usd`, `eur`, and `jpy`." }, "start_date": { "type": "string", "format": "date", "nullable": true, - "description": "The first date for which usage is included in this UsageRecord" + "description": "The first date for which usage is included in this UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their URIs. For more information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources)." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "usage": { "type": "string", "nullable": true, - "description": "The amount of usage" + "description": "The amount used to bill usage and measured in units described in `usage_unit`." }, "usage_unit": { "type": "string", "nullable": true, - "description": "The units in which usage is measured" + "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } } }, @@ -7742,82 +7742,82 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account accrued the usage" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that accrued the usage." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the resource" + "description": "The API version used to create the resource." }, "as_of": { "type": "string", "nullable": true, - "description": "Usage records up to date as of this timestamp" + "description": "Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT" }, "category": { "type": "string", "$ref": "#/components/schemas/usage_record_this_month_enum_category", "nullable": true, - "description": "The category of usage" + "description": "The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories)." }, "count": { "type": "string", "nullable": true, - "description": "The number of usage events" + "description": "The number of usage events, such as the number of calls." }, "count_unit": { "type": "string", "nullable": true, - "description": "The units in which count is measured" + "description": "The units in which `count` is measured, such as `calls` for calls or `messages` for SMS." }, "description": { "type": "string", "nullable": true, - "description": "A plain-language description of the usage category" + "description": "A plain-language description of the usage category." }, "end_date": { "type": "string", "format": "date", "nullable": true, - "description": "The last date for which usage is included in the UsageRecord" + "description": "The last date for which usage is included in the UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "price": { "type": "number", "nullable": true, - "description": "The total price of the usage" + "description": "The total price of the usage in the currency specified in `price_unit` and associated with the account." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which `price` is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format, such as `usd`, `eur`, and `jpy`." }, "start_date": { "type": "string", "format": "date", "nullable": true, - "description": "The first date for which usage is included in this UsageRecord" + "description": "The first date for which usage is included in this UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their URIs. For more information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources)." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "usage": { "type": "string", "nullable": true, - "description": "The amount of usage" + "description": "The amount used to bill usage and measured in units described in `usage_unit`." }, "usage_unit": { "type": "string", "nullable": true, - "description": "The units in which usage is measured" + "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } } }, @@ -8080,82 +8080,82 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account accrued the usage" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that accrued the usage." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the resource" + "description": "The API version used to create the resource." }, "as_of": { "type": "string", "nullable": true, - "description": "Usage records up to date as of this timestamp" + "description": "Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT" }, "category": { "type": "string", "$ref": "#/components/schemas/usage_record_today_enum_category", "nullable": true, - "description": "The category of usage" + "description": "The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories)." }, "count": { "type": "string", "nullable": true, - "description": "The number of usage events" + "description": "The number of usage events, such as the number of calls." }, "count_unit": { "type": "string", "nullable": true, - "description": "The units in which count is measured" + "description": "The units in which `count` is measured, such as `calls` for calls or `messages` for SMS." }, "description": { "type": "string", "nullable": true, - "description": "A plain-language description of the usage category" + "description": "A plain-language description of the usage category." }, "end_date": { "type": "string", "format": "date", "nullable": true, - "description": "The last date for which usage is included in the UsageRecord" + "description": "The last date for which usage is included in the UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "price": { "type": "number", "nullable": true, - "description": "The total price of the usage" + "description": "The total price of the usage in the currency specified in `price_unit` and associated with the account." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which `price` is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format, such as `usd`, `eur`, and `jpy`." }, "start_date": { "type": "string", "format": "date", "nullable": true, - "description": "The first date for which usage is included in this UsageRecord" + "description": "The first date for which usage is included in this UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their URIs. For more information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources)." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "usage": { "type": "string", "nullable": true, - "description": "The amount of usage" + "description": "The amount used to bill usage and measured in units described in `usage_unit`." }, "usage_unit": { "type": "string", "nullable": true, - "description": "The units in which usage is measured" + "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } } }, @@ -8418,82 +8418,82 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account accrued the usage" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that accrued the usage." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the resource" + "description": "The API version used to create the resource." }, "as_of": { "type": "string", "nullable": true, - "description": "Usage records up to date as of this timestamp" + "description": "Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT" }, "category": { "type": "string", "$ref": "#/components/schemas/usage_record_yearly_enum_category", "nullable": true, - "description": "The category of usage" + "description": "The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories)." }, "count": { "type": "string", "nullable": true, - "description": "The number of usage events" + "description": "The number of usage events, such as the number of calls." }, "count_unit": { "type": "string", "nullable": true, - "description": "The units in which count is measured" + "description": "The units in which `count` is measured, such as `calls` for calls or `messages` for SMS." }, "description": { "type": "string", "nullable": true, - "description": "A plain-language description of the usage category" + "description": "A plain-language description of the usage category." }, "end_date": { "type": "string", "format": "date", "nullable": true, - "description": "The last date for which usage is included in the UsageRecord" + "description": "The last date for which usage is included in the UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "price": { "type": "number", "nullable": true, - "description": "The total price of the usage" + "description": "The total price of the usage in the currency specified in `price_unit` and associated with the account." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which `price` is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format, such as `usd`, `eur`, and `jpy`." }, "start_date": { "type": "string", "format": "date", "nullable": true, - "description": "The first date for which usage is included in this UsageRecord" + "description": "The first date for which usage is included in this UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their URIs. For more information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources)." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "usage": { "type": "string", "nullable": true, - "description": "The amount of usage" + "description": "The amount used to bill usage and measured in units described in `usage_unit`." }, "usage_unit": { "type": "string", "nullable": true, - "description": "The units in which usage is measured" + "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } } }, @@ -8756,82 +8756,82 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account accrued the usage" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that accrued the usage." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the resource" + "description": "The API version used to create the resource." }, "as_of": { "type": "string", "nullable": true, - "description": "Usage records up to date as of this timestamp" + "description": "Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT" }, "category": { "type": "string", "$ref": "#/components/schemas/usage_record_yesterday_enum_category", "nullable": true, - "description": "The category of usage" + "description": "The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories)." }, "count": { "type": "string", "nullable": true, - "description": "The number of usage events" + "description": "The number of usage events, such as the number of calls." }, "count_unit": { "type": "string", "nullable": true, - "description": "The units in which count is measured" + "description": "The units in which `count` is measured, such as `calls` for calls or `messages` for SMS." }, "description": { "type": "string", "nullable": true, - "description": "A plain-language description of the usage category" + "description": "A plain-language description of the usage category." }, "end_date": { "type": "string", "format": "date", "nullable": true, - "description": "The last date for which usage is included in the UsageRecord" + "description": "The last date for which usage is included in the UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "price": { "type": "number", "nullable": true, - "description": "The total price of the usage" + "description": "The total price of the usage in the currency specified in `price_unit` and associated with the account." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which `price` is measured" + "description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format, such as `usd`, `eur`, and `jpy`." }, "start_date": { "type": "string", "format": "date", "nullable": true, - "description": "The first date for which usage is included in this UsageRecord" + "description": "The first date for which usage is included in this UsageRecord. The date is specified in GMT and formatted as `YYYY-MM-DD`." }, "subresource_uris": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of related resources identified by their relative URIs" + "description": "A list of related resources identified by their URIs. For more information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources)." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "usage": { "type": "string", "nullable": true, - "description": "The amount of usage" + "description": "The amount used to bill usage and measured in units described in `usage_unit`." }, "usage_unit": { "type": "string", "nullable": true, - "description": "The units in which usage is measured" + "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } } }, @@ -9094,12 +9094,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that this trigger monitors" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the trigger monitors." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to create the resource" + "description": "The API version used to create the resource." }, "callback_method": { "type": "string", @@ -9113,47 +9113,47 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call callback_url" + "description": "The HTTP method we use to call `callback_url`. Can be: `GET` or `POST`." }, "callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "he URL we call when the trigger fires" + "description": "The URL we call using the `callback_method` when the trigger fires." }, "current_value": { "type": "string", "nullable": true, - "description": "The current value of the field the trigger is watching" + "description": "The current value of the field the trigger is watching." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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_fired": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the trigger was last fired" + "description": "The date and time in GMT that the trigger was last fired 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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the trigger" + "description": "The string that you assigned to describe the trigger." }, "recurring": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_recurring", "nullable": true, - "description": "The frequency of a recurring UsageTrigger" + "description": "The frequency of a recurring UsageTrigger. Can be: `daily`, `monthly`, or `yearly` for recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT." }, "sid": { "type": "string", @@ -9161,34 +9161,34 @@ "maxLength": 34, "pattern": "^UT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the UsageTrigger resource." }, "trigger_by": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_trigger_field", "nullable": true, - "description": "The field in the UsageRecord resource that fires the trigger" + "description": "The field in the [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource that fires the trigger. Can be: `count`, `usage`, or `price`, as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price)." }, "trigger_value": { "type": "string", "nullable": true, - "description": "The value at which the trigger will fire" + "description": "The value at which the trigger will fire. Must be a positive, numeric value." }, "uri": { "type": "string", "nullable": true, - "description": "The URI of the resource, relative to `https://api.twilio.com`" + "description": "The URI of the resource, relative to `https://api.twilio.com`." }, "usage_category": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_usage_category", "nullable": true, - "description": "The usage category the trigger watches" + "description": "The usage category the trigger watches. Must be one of the supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories)." }, "usage_record_uri": { "type": "string", "nullable": true, - "description": "The URI of the UsageRecord resource this trigger watches" + "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`." } } }, @@ -9468,7 +9468,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account SID." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created User Defined Message." }, "call_sid": { "type": "string", @@ -9476,7 +9476,7 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Call SID." + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the User Defined Message is associated with." }, "sid": { "type": "string", @@ -9484,13 +9484,13 @@ "maxLength": 34, "pattern": "^KX[0-9a-fA-F]{32}$", "nullable": true, - "description": "User Defined Message SID." + "description": "The SID that uniquely identifies this User Defined Message." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date this User Defined Message was created." + "description": "The date that this User Defined Message was created, given in RFC 2822 format." } } }, @@ -9503,7 +9503,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account SID." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that subscribed to the User Defined Messages." }, "call_sid": { "type": "string", @@ -9511,7 +9511,7 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Call SID." + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the User Defined Message Subscription is associated with. This refers to the Call SID that is producing the User Defined Messages." }, "sid": { "type": "string", @@ -9519,13 +9519,13 @@ "maxLength": 34, "pattern": "^ZY[0-9a-fA-F]{32}$", "nullable": true, - "description": "User Defined Message Subscription SID." + "description": "The SID that uniquely identifies this User Defined Message Subscription." }, "date_created": { "type": "string", "format": "date-time-rfc-2822", "nullable": true, - "description": "The date this User Defined Message Subscription was created." + "description": "The date that this User Defined Message Subscription was created, given in RFC 2822 format." }, "uri": { "type": "string", @@ -9543,7 +9543,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for the Caller ID." }, "call_sid": { "type": "string", @@ -9551,23 +9551,23 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Call the resource is associated with" + "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Caller ID is associated with." }, "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." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number to verify in E.164 format" + "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." }, "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" + "description": "The 6 digit validation code that someone must enter to validate the Caller ID when `phone_number` is called." } } } diff --git a/spec/json/twilio_autopilot_v1.json b/spec/json/twilio_autopilot_v1.json index fef9091e..1c8a5d3d 100644 --- a/spec/json/twilio_autopilot_v1.json +++ b/spec/json/twilio_autopilot_v1.json @@ -10,24 +10,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "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 RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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" + "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", @@ -35,18 +35,18 @@ "maxLength": 34, "pattern": "^UG[0-9a-fA-F]{32}$", "nullable": true, - "description": "Reserved" + "description": "Reserved." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of the URLs of the Assistant's related resources" + "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" + "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", @@ -56,7 +56,7 @@ "needs_model_build": { "type": "boolean", "nullable": true, - "description": "Whether model needs to be rebuilt" + "description": "Whether model needs to be rebuilt." }, "sid": { "type": "string", @@ -64,29 +64,29 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "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" + "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" + "description": "The absolute URL of the Assistant resource." }, "callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "Reserved" + "description": "Reserved." }, "callback_events": { "type": "string", "nullable": true, - "description": "Reserved" + "description": "Reserved." } } }, @@ -99,7 +99,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Defaults resource." }, "assistant_sid": { "type": "string", @@ -107,17 +107,17 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the resource" + "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" + "description": "The absolute URL of the Defaults resource." }, "data": { "nullable": true, - "description": "The JSON string that describes the default task links" + "description": "The JSON string that describes the default task links for the `assistant_initiation`, `collect`, and `fallback` situations." } } }, @@ -130,7 +130,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Dialogue resource." }, "assistant_sid": { "type": "string", @@ -138,7 +138,7 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the resource" + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." }, "sid": { "type": "string", @@ -146,17 +146,17 @@ "maxLength": 34, "pattern": "^UK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "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" + "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" + "description": "The absolute URL of the Dialogue resource." } } }, @@ -169,24 +169,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "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 RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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" + "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", @@ -194,7 +194,7 @@ "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" + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with this Field." }, "assistant_sid": { "type": "string", @@ -202,7 +202,7 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the Task associated with the resource" + "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", @@ -210,18 +210,18 @@ "maxLength": 34, "pattern": "^UE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "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" + "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" + "description": "The absolute URL of the Field resource." } } }, @@ -234,30 +234,30 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "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 RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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" + "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" + "description": "A list of the URLs of related resources." }, "assistant_sid": { "type": "string", @@ -265,7 +265,7 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the resource" + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." }, "sid": { "type": "string", @@ -273,18 +273,18 @@ "maxLength": 34, "pattern": "^UB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "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" + "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" + "description": "The absolute URL of the FieldType resource." } } }, @@ -297,19 +297,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "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 RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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", @@ -317,12 +317,12 @@ "maxLength": 34, "pattern": "^UB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Field Type associated with the Field Value" + "description": "The SID of the Field Type associated with the Field Value." }, "language": { "type": "string", "nullable": true, - "description": "The ISO language-country tag that identifies the language of the value" + "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", @@ -330,7 +330,7 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the FieldType associated with the resource" + "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", @@ -338,18 +338,18 @@ "maxLength": 34, "pattern": "^UC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the FieldValue resource." }, "value": { "type": "string", "nullable": true, - "description": "The Field Value data" + "description": "The Field Value data." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the FieldValue resource" + "description": "The absolute URL of the FieldValue resource." }, "synonym_of": { "type": "string", @@ -357,7 +357,7 @@ "maxLength": 34, "pattern": "^UC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The word for which the field value is a synonym of" + "description": "The word for which the field value is a synonym of." } } }, @@ -370,19 +370,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "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 RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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", @@ -390,7 +390,7 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the resource" + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." }, "sid": { "type": "string", @@ -398,34 +398,34 @@ "maxLength": 34, "pattern": "^UG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "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" + "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" + "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" + "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" + "description": "The time in seconds it took to build the model." }, "error_code": { "type": "integer", "nullable": true, - "description": "More information about why the model build failed, if `status` is `failed`" + "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." } } }, @@ -448,28 +448,28 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "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 RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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 recognized and a list of identified Fields" + "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 string that specifies the language used by the 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. For example: `en-US`." }, "model_build_sid": { "type": "string", @@ -477,12 +477,12 @@ "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" + "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" + "description": "The end-user's natural language input." }, "sample_sid": { "type": "string", @@ -490,7 +490,7 @@ "maxLength": 34, "pattern": "^UF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of an optional reference to the Sample created from the query" + "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", @@ -498,7 +498,7 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the resource" + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." }, "sid": { "type": "string", @@ -506,23 +506,23 @@ "maxLength": 34, "pattern": "^UH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Query resource." }, "status": { "type": "string", "nullable": true, - "description": "The status of the Query" + "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" + "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" + "description": "The communication channel from where the end-user input came." }, "dialogue_sid": { "type": "string", @@ -543,7 +543,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Assistant resource." }, "sid": { "type": "string", @@ -551,34 +551,34 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Assistant resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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" + "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" + "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" + "description": "Whether model needs to be rebuilt." }, "latest_model_build_sid": { "type": "string", @@ -586,12 +586,12 @@ "maxLength": 34, "pattern": "^UG[0-9a-fA-F]{32}$", "nullable": true, - "description": "Reserved" + "description": "Reserved." }, "log_queries": { "type": "boolean", "nullable": true, - "description": "Whether queries should be logged and kept after training" + "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", @@ -602,12 +602,12 @@ "type": "string", "format": "uri", "nullable": true, - "description": "Reserved" + "description": "Reserved." }, "callback_events": { "type": "string", "nullable": true, - "description": "Reserved" + "description": "Reserved." } } }, @@ -620,19 +620,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "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 RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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", @@ -640,12 +640,12 @@ "maxLength": 34, "pattern": "^UD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Task associated with the resource" + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the resource." }, "language": { "type": "string", "nullable": true, - "description": "An ISO language-country string that specifies the language used for the sample" + "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", @@ -653,7 +653,7 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the Task associated with the resource" + "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", @@ -661,23 +661,23 @@ "maxLength": 34, "pattern": "^UF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "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" + "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" + "description": "The absolute URL of the Sample resource." }, "source_channel": { "type": "string", "nullable": true, - "description": "The communication channel from which the sample was captured" + "description": "The communication channel from which the sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included." } } }, @@ -690,7 +690,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the StyleSheet resource." }, "assistant_sid": { "type": "string", @@ -698,17 +698,17 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the resource" + "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" + "description": "The absolute URL of the StyleSheet resource." }, "data": { "nullable": true, - "description": "The JSON string that describes the style sheet object" + "description": "The JSON string that describes the style sheet object." } } }, @@ -721,30 +721,30 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "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 RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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" + "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" + "description": "A list of the URLs of related resources." }, "assistant_sid": { "type": "string", @@ -752,7 +752,7 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the resource" + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." }, "sid": { "type": "string", @@ -760,24 +760,24 @@ "maxLength": 34, "pattern": "^UD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "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" + "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" + "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" + "description": "The absolute URL of the Task resource." } } }, @@ -790,7 +790,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskActions resource." }, "assistant_sid": { "type": "string", @@ -798,7 +798,7 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the Task associated with the resource" + "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", @@ -806,17 +806,17 @@ "maxLength": 34, "pattern": "^UD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Task associated with the resource" + "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" + "description": "The absolute URL of the TaskActions resource." }, "data": { "nullable": true, - "description": "The JSON string that specifies the actions that instruct the Assistant on how to perform the task" + "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." } } }, @@ -829,7 +829,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskStatistics resource." }, "assistant_sid": { "type": "string", @@ -837,7 +837,7 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the Task associated with the resource" + "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", @@ -845,23 +845,23 @@ "maxLength": 34, "pattern": "^UD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Task for which the statistics were collected" + "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 associated with the Task" + "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 associated with the Task" + "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" + "description": "The absolute URL of the TaskStatistics resource." } } }, @@ -872,7 +872,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Webhook resource" + "description": "The absolute URL of the Webhook resource." }, "account_sid": { "type": "string", @@ -880,19 +880,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "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 RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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", @@ -900,7 +900,7 @@ "maxLength": 34, "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Assistant that is the parent of the resource" + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." }, "sid": { "type": "string", @@ -908,12 +908,12 @@ "maxLength": 34, "pattern": "^UM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "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" + "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", diff --git a/spec/json/twilio_bulkexports_v1.json b/spec/json/twilio_bulkexports_v1.json index b64fe985..ebd5ada7 100644 --- a/spec/json/twilio_bulkexports_v1.json +++ b/spec/json/twilio_bulkexports_v1.json @@ -7,17 +7,17 @@ "day": { "type": "string", "nullable": true, - "description": "The date of the data in the file" + "description": "The ISO 8601 format date of the resources in the file, for a UTC day" }, "size": { "type": "integer", "nullable": true, - "description": "Size of the file in bytes" + "description": "The size of the day's data file in bytes" }, "create_date": { "type": "string", "nullable": true, - "description": "The date when resource is created" + "description": "The ISO 8601 format date when resources is created" }, "friendly_name": { "type": "string", @@ -59,7 +59,7 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs." + "description": "Contains a dictionary of URL links to nested resources of this Export." } } }, @@ -69,18 +69,18 @@ "enabled": { "type": "boolean", "nullable": true, - "description": "Whether files are automatically generated" + "description": "If true, Twilio will automatically generate every day's file when the day is over." }, "webhook_url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL targeted at export" + "description": "Stores the URL destination for the method specified in webhook_method." }, "webhook_method": { "type": "string", "nullable": true, - "description": "Whether to GET or POST to the webhook url" + "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" }, "resource_type": { "type": "string", @@ -111,22 +111,22 @@ "start_day": { "type": "string", "nullable": true, - "description": "The start day for the custom export specified as a string in the format of yyyy-MM-dd" + "description": "The start day for the custom export specified when creating the job" }, "end_day": { "type": "string", "nullable": true, - "description": "The end day for the custom export specified as a string in the format of yyyy-MM-dd. This will be the last day exported. For instance, to export a single day, choose the same day for start and end day. To export the first 4 days of July, you would set the start date to 2020-07-01 and the end date to 2020-07-04. The end date must be the UTC day before yesterday." + "description": "The end day for the export specified when creating the job" }, "webhook_url": { "type": "string", "nullable": true, - "description": "The optional webhook url called on completion" + "description": "The optional webhook url called on completion of the job. If this is supplied, `WebhookMethod` must also be supplied." }, "webhook_method": { "type": "string", "nullable": true, - "description": "This is the method used to call the webhook" + "description": "This is the method used to call the webhook on completion of the job. If this is supplied, `WebhookUrl` must also be supplied." }, "email": { "type": "string", @@ -139,11 +139,11 @@ "maxLength": 34, "pattern": "^JS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique job_sid returned when the custom export was created. This can be used to look up the status of the job." + "description": "The unique job_sid returned when the custom export was created" }, "details": { "nullable": true, - "description": "The details of a job state which is an object that contains a `status` string, a day count integer, and list of days in the job" + "description": "The details of a job which is an object that contains an array of status grouped by `status` state. Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days." }, "job_queue_position": { "type": "string", @@ -185,7 +185,7 @@ }, "details": { "nullable": true, - "description": "The details of a job state which is an object that contains a `status` string, a day count integer, and list of days in the job" + "description": "The details of a job which is an object that contains an array of status grouped by `status` state. Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days." }, "start_day": { "type": "string", diff --git a/spec/json/twilio_chat_v1.json b/spec/json/twilio_chat_v1.json index 2f7dcaf5..c4988f02 100644 --- a/spec/json/twilio_chat_v1.json +++ b/spec/json/twilio_chat_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Channel resource." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the Channel resource." }, "service_sid": { "type": "string", @@ -26,67 +26,67 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is associated with." }, "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." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource" + "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." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data" + "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." }, "type": { "type": "string", "$ref": "#/components/schemas/channel_enum_channel_type", "nullable": true, - "description": "The visibility of the channel. Can be: `public` or `private`" + "description": "The visibility of the channel. Can be: `public` or `private`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "created_by": { "type": "string", "nullable": true, - "description": "The identity of the User that created the channel" + "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`." }, "members_count": { "type": "integer", "nullable": true, - "description": "The number of Members in the Channel" + "description": "The number of Members in the Channel." }, "messages_count": { "type": "integer", "nullable": true, - "description": "The number of Messages in the Channel" + "description": "The number of Messages in the Channel." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Channel resource" + "description": "The absolute URL of the Channel resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel" + "description": "The absolute URLs of the [Members](https://www.twilio.com/docs/chat/api/members), [Messages](https://www.twilio.com/docs/chat/api/messages) , [Invites](https://www.twilio.com/docs/chat/api/invites) and, if it exists, the last [Message](https://www.twilio.com/docs/chat/api/messages) for the Channel." } } }, @@ -106,7 +106,7 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Credential resource." }, "account_sid": { "type": "string", @@ -114,41 +114,41 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the Credential resource." }, "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." }, "type": { "type": "string", "$ref": "#/components/schemas/credential_enum_push_service", "nullable": true, - "description": "The type of push-notification service the credential is for" + "description": "The type of push-notification service the credential is for. Can be: `gcm`, `fcm`, or `apn`." }, "sandbox": { "type": "string", "nullable": true, - "description": "[APN only] Whether to send the credential to sandbox APNs" + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Credential resource" + "description": "The absolute URL of the Credential resource." } } }, @@ -169,7 +169,7 @@ "maxLength": 34, "pattern": "^IN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Invite resource." }, "account_sid": { "type": "string", @@ -177,7 +177,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the Invite resource." }, "channel_sid": { "type": "string", @@ -185,7 +185,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Channel the new resource belongs to" + "description": "The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource belongs to." }, "service_sid": { "type": "string", @@ -193,24 +193,24 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is associated with." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "role_sid": { "type": "string", @@ -218,18 +218,18 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Role assigned to the member" + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the resource." }, "created_by": { "type": "string", "nullable": true, - "description": "The identity of the User that created the invite" + "description": "The `identity` of the User that created the invite." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Invite resource" + "description": "The absolute URL of the Invite resource." } } }, @@ -242,7 +242,7 @@ "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Member resource." }, "account_sid": { "type": "string", @@ -250,7 +250,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the Member resource." }, "channel_sid": { "type": "string", @@ -258,7 +258,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Channel for the member" + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) for the member." }, "service_sid": { "type": "string", @@ -266,24 +266,24 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is associated with." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "role_sid": { "type": "string", @@ -291,24 +291,24 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Role assigned to the member" + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the member." }, "last_consumed_message_index": { "type": "integer", "nullable": true, - "description": "The index of the last Message that the Member has read within the Channel" + "description": "The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) in the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) that the Member has read." }, "last_consumption_timestamp": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 based timestamp string that represents the date-time of the last Message read event for the Member within the Channel" + "description": "The ISO 8601 timestamp string that represents the date-time of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) read event for the Member within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Member resource" + "description": "The absolute URL of the Member resource." } } }, @@ -321,7 +321,7 @@ "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Message resource." }, "account_sid": { "type": "string", @@ -329,12 +329,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the Message resource." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data" + "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." }, "service_sid": { "type": "string", @@ -342,7 +342,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is associated with." }, "to": { "type": "string", @@ -350,7 +350,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Channel that the message was sent to" + "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/api/channels) that the message was sent to." }, "channel_sid": { "type": "string", @@ -358,45 +358,45 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Channel the Message resource belongs to" + "description": "The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the Message resource belongs to." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "was_edited": { "type": "boolean", "nullable": true, - "description": "Whether the message has been edited since it was created" + "description": "Whether the message has been edited since it was created." }, "from": { "type": "string", "nullable": true, - "description": "The identity of the message's author" + "description": "The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the message's author. The default value is `system`." }, "body": { "type": "string", "nullable": true, - "description": "The content of the message" + "description": "The content of the message." }, "index": { "type": "integer", "nullable": true, - "description": "The index of the message within the Channel" + "description": "The index of the message within the [Channel](https://www.twilio.com/docs/chat/api/channels)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Message resource" + "description": "The absolute URL of the Message resource." } } }, @@ -416,7 +416,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Role resource." }, "account_sid": { "type": "string", @@ -424,7 +424,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the Role resource." }, "service_sid": { "type": "string", @@ -432,18 +432,18 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is associated with." }, "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." }, "type": { "type": "string", "$ref": "#/components/schemas/role_enum_role_type", "nullable": true, - "description": "The type of role" + "description": "The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/api/channels) roles or `deployment` for [Service](https://www.twilio.com/docs/chat/api/services) roles." }, "permissions": { "type": "array", @@ -451,25 +451,25 @@ "type": "string" }, "nullable": true, - "description": "An array of the permissions the role has been granted" + "description": "An array of the permissions the role has been granted, formatted as a JSON string." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Role resource" + "description": "The absolute URL of the Role resource." } } }, @@ -489,7 +489,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Service resource." }, "account_sid": { "type": "string", @@ -497,24 +497,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the Service resource." }, "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "default_service_role_sid": { "type": "string", @@ -522,7 +522,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The service role assigned to users when they are added to the service" + "description": "The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details." }, "default_channel_role_sid": { "type": "string", @@ -530,7 +530,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The channel role assigned to users when they are added to a channel" + "description": "The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details." }, "default_channel_creator_role_sid": { "type": "string", @@ -538,50 +538,50 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The channel role assigned to a channel creator when they join a new channel" + "description": "The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details." }, "read_status_enabled": { "type": "boolean", "nullable": true, - "description": "Whether the Message Consumption Horizon feature is enabled" + "description": "Whether the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature is enabled. The default is `true`." }, "reachability_enabled": { "type": "boolean", "nullable": true, - "description": "Whether the Reachability Indicator feature is enabled for this Service instance" + "description": "Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) is enabled for this Service instance. The default is `false`." }, "typing_indicator_timeout": { "type": "integer", "nullable": true, - "description": "How long in seconds to wait before assuming the user is no longer typing" + "description": "How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds." }, "consumption_report_interval": { "type": "integer", "nullable": true, - "description": "DEPRECATED" + "description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints." }, "limits": { "nullable": true, - "description": "An object that describes the limits of the service instance" + "description": "An object that describes the limits of the service instance. The `limits` object contains `channel_members` to describe the members/channel limit and `user_channels` to describe the channels/user limit. `channel_members` can be 1,000 or less, with a default of 250. `user_channels` can be 1,000 or less, with a default value of 100." }, "webhooks": { "nullable": true, - "description": "An object that contains information about the webhooks configured for this service" + "description": "An object that contains information about the webhooks configured for this service." }, "pre_webhook_url": { "type": "string", "nullable": true, - "description": "The webhook URL for pre-event webhooks" + "description": "The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details." }, "post_webhook_url": { "type": "string", "nullable": true, - "description": "The URL for post-event webhooks" + "description": "The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details." }, "webhook_method": { "type": "string", "nullable": true, - "description": "The HTTP method to use for both PRE and POST webhooks" + "description": "The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details." }, "webhook_filters": { "type": "array", @@ -589,23 +589,23 @@ "type": "string" }, "nullable": true, - "description": "The list of WebHook events that are enabled for this Service instance" + "description": "The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details." }, "notifications": { "nullable": true, - "description": "The notification configuration for the Service instance" + "description": "The notification configuration for the Service instance. See [Push Notification Configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more information." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Service resource" + "description": "The absolute URL of the Service resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The absolute URLs of the Service's Channels, Roles, and Users" + "description": "The absolute URLs of the Service's [Channels](https://www.twilio.com/docs/chat/api/channels), [Roles](https://www.twilio.com/docs/chat/api/roles), and [Users](https://www.twilio.com/docs/chat/api/users)." } } }, @@ -618,7 +618,7 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the User resource." }, "account_sid": { "type": "string", @@ -626,7 +626,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the User resource." }, "service_sid": { "type": "string", @@ -634,17 +634,17 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is associated with." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data" + "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." }, "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." }, "role_sid": { "type": "string", @@ -652,51 +652,51 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the assigned to the user" + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the user." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "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." }, "is_online": { "type": "boolean", "nullable": true, - "description": "Whether the User is actively connected to the Service instance and online" + "description": "Whether the User is actively connected to the Service instance and online. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, if the User has never been online for the Service instance, even if the Service's `reachability_enabled` is `true`." }, "is_notifiable": { "type": "boolean", "nullable": true, - "description": "Whether the User has a potentially valid Push Notification registration for the Service instance" + "description": "Whether the User has a potentially valid Push Notification registration (APN or GCM) for the Service instance. If at least one registration exists, `true`; otherwise `false`. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, and if the User has never had a notification registration, even if the Service's `reachability_enabled` is `true`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "joined_channels_count": { "type": "integer", "nullable": true, - "description": "The number of Channels this User is a Member of" + "description": "The number of Channels this User is a Member of." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The absolute URLs of the Channel and Binding resources related to the user" + "description": "The absolute URLs of the [Channel](https://www.twilio.com/docs/chat/api/channels) and [Binding](https://www.twilio.com/docs/chat/rest/bindings-resource) resources related to the user." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the User resource" + "description": "The absolute URL of the User resource." } } }, @@ -709,7 +709,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the User Channel resource." }, "service_sid": { "type": "string", @@ -717,7 +717,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is associated with." }, "channel_sid": { "type": "string", @@ -725,7 +725,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Channel the resource belongs to" + "description": "The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource belongs to." }, "member_sid": { "type": "string", @@ -733,29 +733,29 @@ "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the User as a Member in the Channel" + "description": "The SID of a [Member](https://www.twilio.com/docs/api/chat/rest/members) that represents the User on the Channel." }, "status": { "type": "string", "$ref": "#/components/schemas/user_channel_enum_channel_status", "nullable": true, - "description": "The status of the User on the Channel" + "description": "The status of the User on the Channel. Can be: `joined`, `invited`, or `not_participating`." }, "last_consumed_message_index": { "type": "integer", "nullable": true, - "description": "The index of the last Message in the Channel the Member has read" + "description": "The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) in the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) that the Member has read." }, "unread_messages_count": { "type": "integer", "nullable": true, - "description": "The number of unread Messages in the Channel for the User" + "description": "The number of unread Messages in the Channel for the User. Note that retrieving messages on a client endpoint does not mean that messages are consumed or read. See [Consumption Horizon feature](/docs/api/chat/guides/consumption-horizon) to learn how to mark messages as consumed." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel" + "description": "The absolute URLs of the [Members](https://www.twilio.com/docs/chat/api/members), [Messages](https://www.twilio.com/docs/chat/api/messages) , [Invites](https://www.twilio.com/docs/chat/api/invites) and, if it exists, the last [Message](https://www.twilio.com/docs/chat/api/messages) for the Channel." } } }, diff --git a/spec/json/twilio_chat_v2.json b/spec/json/twilio_chat_v2.json index 877d1504..94a6841b 100644 --- a/spec/json/twilio_chat_v2.json +++ b/spec/json/twilio_chat_v2.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^BS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Binding resource." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Binding resource." }, "service_sid": { "type": "string", @@ -26,29 +26,29 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Binding resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding resource is associated with." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the Binding" + "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "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." }, "credential_sid": { "type": "string", @@ -56,13 +56,13 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Credential for the binding" + "description": "The SID of the [Credential](https://www.twilio.com/docs/chat/rest/credential-resource) for the binding. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info." }, "binding_type": { "type": "string", "$ref": "#/components/schemas/binding_enum_binding_type", "nullable": true, - "description": "The push technology to use for the binding" + "description": "The push technology to use for the Binding. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info." }, "message_types": { "type": "array", @@ -70,19 +70,19 @@ "type": "string" }, "nullable": true, - "description": "The Programmable Chat message types the binding is subscribed to" + "description": "The [Programmable Chat message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Binding resource" + "description": "The absolute URL of the Binding resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The absolute URLs of the Binding's User" + "description": "The absolute URLs of the Binding's [User](https://www.twilio.com/docs/chat/rest/user-resource)." } } }, @@ -103,7 +103,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Channel resource." }, "account_sid": { "type": "string", @@ -111,7 +111,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Channel resource." }, "service_sid": { "type": "string", @@ -119,67 +119,67 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel resource is associated with." }, "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." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource" + "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." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data" + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." }, "type": { "type": "string", "$ref": "#/components/schemas/channel_enum_channel_type", "nullable": true, - "description": "The visibility of the channel. Can be: `public` or `private`" + "description": "The visibility of the channel. Can be: `public` or `private`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "created_by": { "type": "string", "nullable": true, - "description": "The identity of the User that created the channel" + "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`." }, "members_count": { "type": "integer", "nullable": true, - "description": "The number of Members in the Channel" + "description": "The number of Members in the Channel." }, "messages_count": { "type": "integer", "nullable": true, - "description": "The number of Messages that have been passed in the Channel" + "description": "The number of Messages that have been passed in the Channel." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Channel resource" + "description": "The absolute URL of the Channel resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel" + "description": "The absolute URLs of the [Members](https://www.twilio.com/docs/chat/rest/member-resource), [Messages](https://www.twilio.com/docs/chat/rest/message-resource), [Invites](https://www.twilio.com/docs/chat/rest/invite-resource), Webhooks and, if it exists, the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) for the Channel." } } }, @@ -206,7 +206,7 @@ "maxLength": 34, "pattern": "^WH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Channel Webhook resource." }, "account_sid": { "type": "string", @@ -214,7 +214,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Channel Webhook resource." }, "service_sid": { "type": "string", @@ -222,7 +222,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Channel Webhook resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel Webhook resource is associated with." }, "channel_sid": { "type": "string", @@ -230,34 +230,34 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Channel the Channel Webhook resource belongs to" + "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resource belongs to." }, "type": { "type": "string", "nullable": true, - "description": "The type of webhook" + "description": "The type of webhook. Can be: `webhook`, `studio`, or `trigger`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Channel Webhook resource" + "description": "The absolute URL of the Channel Webhook resource." }, "configuration": { "nullable": true, - "description": "The JSON string that describes the configuration object for the channel webhook" + "description": "The JSON string that describes how the channel webhook is configured. The configuration object contains the `url`, `method`, `filters`, and `retry_count` values that are configured by the create and update actions." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." } } }, @@ -285,7 +285,7 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Credential resource." }, "account_sid": { "type": "string", @@ -293,41 +293,41 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Credential resource." }, "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." }, "type": { "type": "string", "$ref": "#/components/schemas/credential_enum_push_service", "nullable": true, - "description": "The type of push-notification service the credential is for" + "description": "The type of push-notification service the credential is for. Can be: `gcm`, `fcm`, or `apn`." }, "sandbox": { "type": "string", "nullable": true, - "description": "[APN only] Whether to send the credential to sandbox APNs" + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 Credential resource" + "description": "The absolute URL of the Credential resource." } } }, @@ -348,7 +348,7 @@ "maxLength": 34, "pattern": "^IN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Invite resource." }, "account_sid": { "type": "string", @@ -356,7 +356,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Invite resource." }, "channel_sid": { "type": "string", @@ -364,7 +364,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Channel the new resource belongs to" + "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource belongs to." }, "service_sid": { "type": "string", @@ -372,24 +372,24 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Invite resource is associated with." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "role_sid": { "type": "string", @@ -397,18 +397,18 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Role assigned to the member" + "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the resource." }, "created_by": { "type": "string", "nullable": true, - "description": "The identity of the User that created the invite" + "description": "The `identity` of the User that created the invite." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Invite resource" + "description": "The absolute URL of the Invite resource." } } }, @@ -421,7 +421,7 @@ "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Member resource." }, "account_sid": { "type": "string", @@ -429,7 +429,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource." }, "channel_sid": { "type": "string", @@ -437,7 +437,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Channel for the member" + "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource belongs to." }, "service_sid": { "type": "string", @@ -445,24 +445,24 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Member resource is associated with." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "role_sid": { "type": "string", @@ -470,29 +470,29 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Role assigned to the member" + "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the member." }, "last_consumed_message_index": { "type": "integer", "nullable": true, - "description": "The index of the last Message that the Member has read within the Channel" + "description": "The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read." }, "last_consumption_timestamp": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 based timestamp string that represents the datetime of the last Message read event for the Member within the Channel" + "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)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Member resource" + "description": "The absolute URL of the Member resource." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data" + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." } } }, @@ -512,7 +512,7 @@ "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Message resource." }, "account_sid": { "type": "string", @@ -520,12 +520,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resource." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data" + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." }, "service_sid": { "type": "string", @@ -533,7 +533,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Message resource is associated with." }, "to": { "type": "string", @@ -541,7 +541,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Channel that the message was sent to" + "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) that the message was sent to." }, "channel_sid": { "type": "string", @@ -549,59 +549,59 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Channel the Message resource belongs to" + "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Message resource belongs to." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "last_updated_by": { "type": "string", "nullable": true, - "description": "The Identity of the User who last updated the Message" + "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable." }, "was_edited": { "type": "boolean", "nullable": true, - "description": "Whether the message has been edited since it was created" + "description": "Whether the message has been edited since it was created." }, "from": { "type": "string", "nullable": true, - "description": "The Identity of the message's author" + "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. The default value is `system`." }, "body": { "type": "string", "nullable": true, - "description": "The content of the message" + "description": "The content of the message." }, "index": { "type": "integer", "nullable": true, - "description": "The index of the message within the Channel" + "description": "The index of the message within the [Channel](https://www.twilio.com/docs/chat/channels). Indices may skip numbers, but will always be in order of when the message was received." }, "type": { "type": "string", "nullable": true, - "description": "The Message type" + "description": "The Message type. Can be: `text` or `media`." }, "media": { "nullable": true, - "description": "A Media object that describes the Message's media if attached; otherwise, 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`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Message resource" + "description": "The absolute URL of the Message resource." } } }, @@ -628,7 +628,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Role resource." }, "account_sid": { "type": "string", @@ -636,7 +636,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Role resource." }, "service_sid": { "type": "string", @@ -644,18 +644,18 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Role resource is associated with." }, "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." }, "type": { "type": "string", "$ref": "#/components/schemas/role_enum_role_type", "nullable": true, - "description": "The type of role" + "description": "The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/channels) roles or `deployment` for [Service](https://www.twilio.com/docs/chat/rest/service-resource) roles." }, "permissions": { "type": "array", @@ -663,25 +663,25 @@ "type": "string" }, "nullable": true, - "description": "An array of the permissions the role has been granted" + "description": "An array of the permissions the role has been granted." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 Role resource" + "description": "The absolute URL of the Role resource." } } }, @@ -701,7 +701,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Service resource." }, "account_sid": { "type": "string", @@ -709,24 +709,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource." }, "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "default_service_role_sid": { "type": "string", @@ -734,7 +734,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The service role assigned to users when they are added to the service" + "description": "The service role assigned to users when they are added to the service. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles." }, "default_channel_role_sid": { "type": "string", @@ -742,7 +742,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The channel role assigned to users when they are added to a channel" + "description": "The channel role assigned to users when they are added to a channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles." }, "default_channel_creator_role_sid": { "type": "string", @@ -750,46 +750,46 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The channel role assigned to a channel creator when they join a new channel" + "description": "The channel role assigned to a channel creator when they join a new channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles." }, "read_status_enabled": { "type": "boolean", "nullable": true, - "description": "Whether the Message Consumption Horizon feature is enabled" + "description": "Whether the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature is enabled. The default is `true`." }, "reachability_enabled": { "type": "boolean", "nullable": true, - "description": "Whether the Reachability Indicator feature is enabled for this Service instance" + "description": "Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) is enabled for this Service instance. The default is `false`." }, "typing_indicator_timeout": { "type": "integer", "nullable": true, - "description": "How long in seconds to wait before assuming the user is no longer typing" + "description": "How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds." }, "consumption_report_interval": { "type": "integer", "nullable": true, - "description": "DEPRECATED" + "description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints." }, "limits": { "nullable": true, - "description": "An object that describes the limits of the service instance" + "description": "An object that describes the limits of the service instance. The `limits` object contains `channel_members` to describe the members/channel limit and `user_channels` to describe the channels/user limit. `channel_members` can be 1,000 or less, with a default of 250. `user_channels` can be 1,000 or less, with a default value of 100." }, "pre_webhook_url": { "type": "string", "nullable": true, - "description": "The webhook URL for pre-event webhooks" + "description": "The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details." }, "post_webhook_url": { "type": "string", "nullable": true, - "description": "The URL for post-event webhooks" + "description": "The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details." }, "webhook_method": { "type": "string", "nullable": true, - "description": "The HTTP method to use for both PRE and POST webhooks" + "description": "The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details." }, "webhook_filters": { "type": "array", @@ -797,37 +797,37 @@ "type": "string" }, "nullable": true, - "description": "The list of webhook events that are enabled for this Service instance" + "description": "The list of webhook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details." }, "pre_webhook_retry_count": { "type": "integer", "nullable": true, - "description": "Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses" + "description": "The number of times to retry a call to the `pre_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried." }, "post_webhook_retry_count": { "type": "integer", "nullable": true, - "description": "The number of times calls to the `post_webhook_url` will be retried" + "description": "The number of times to retry a call to the `post_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried." }, "notifications": { "nullable": true, - "description": "The notification configuration for the Service instance" + "description": "The notification configuration for the Service instance. See [Push Notification Configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info." }, "media": { "nullable": true, - "description": "The properties of the media that the service supports" + "description": "An object that describes the properties of media that the service supports. The object contains the `size_limit_mb` property, which describes the size of the largest media file in MB; and the `compatibility_message` property, which contains the message text to send when a media message does not have any text." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Service resource" + "description": "The absolute URL of the Service resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The absolute URLs of the Service's Channels, Roles, and Users" + "description": "The absolute URLs of the Service's [Channels](https://www.twilio.com/docs/chat/channels), [Roles](https://www.twilio.com/docs/chat/rest/role-resource), [Bindings](https://www.twilio.com/docs/chat/rest/binding-resource), and [Users](https://www.twilio.com/docs/chat/rest/user-resource)." } } }, @@ -840,7 +840,7 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the User resource." }, "account_sid": { "type": "string", @@ -848,7 +848,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User resource." }, "service_sid": { "type": "string", @@ -856,17 +856,17 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User resource is associated with." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data" + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." }, "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." }, "role_sid": { "type": "string", @@ -874,51 +874,51 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Role assigned to the user" + "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the user." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "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." }, "is_online": { "type": "boolean", "nullable": true, - "description": "Whether the User is actively connected to the Service instance and online" + "description": "Whether the User is actively connected to the Service instance and online. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, if the User has never been online for the Service instance, even if the Service's `reachability_enabled` is `true`." }, "is_notifiable": { "type": "boolean", "nullable": true, - "description": "Whether the User has a potentially valid Push Notification registration for the Service instance" + "description": "Whether the User has a potentially valid Push Notification registration (APN or GCM) for the Service instance. If at least one registration exists, `true`; otherwise `false`. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, and if the User has never had a notification registration, even if the Service's `reachability_enabled` is `true`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "joined_channels_count": { "type": "integer", "nullable": true, - "description": "The number of Channels the User is a Member of" + "description": "The number of Channels the User is a Member of." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The absolute URLs of the Channel and Binding resources related to the user" + "description": "The absolute URLs of the [Channel](https://www.twilio.com/docs/chat/channels) and [Binding](https://www.twilio.com/docs/chat/rest/binding-resource) resources related to the user." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the User resource" + "description": "The absolute URL of the User resource." } } }, @@ -938,7 +938,7 @@ "maxLength": 34, "pattern": "^BS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the User Binding resource." }, "account_sid": { "type": "string", @@ -946,7 +946,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User Binding resource." }, "service_sid": { "type": "string", @@ -954,29 +954,29 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User Binding resource is associated with." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the User Binding" + "description": "The unique endpoint identifier for the User Binding. The format of the value depends on the `binding_type`." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "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." }, "user_sid": { "type": "string", @@ -984,7 +984,7 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the User with the binding" + "description": "The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User Binding resource. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info." }, "credential_sid": { "type": "string", @@ -992,13 +992,13 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Credential for the binding" + "description": "The SID of the [Credential](https://www.twilio.com/docs/chat/rest/credential-resource) for the binding. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info." }, "binding_type": { "type": "string", "$ref": "#/components/schemas/user_binding_enum_binding_type", "nullable": true, - "description": "The push technology to use for the binding" + "description": "The push technology to use for the User Binding. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info." }, "message_types": { "type": "array", @@ -1006,13 +1006,13 @@ "type": "string" }, "nullable": true, - "description": "The Programmable Chat message types the binding is subscribed to" + "description": "The [Programmable Chat message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the User Binding resource" + "description": "The absolute URL of the User Binding resource." } } }, @@ -1033,7 +1033,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User Channel resource." }, "service_sid": { "type": "string", @@ -1041,7 +1041,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User Channel resource is associated with." }, "channel_sid": { "type": "string", @@ -1049,7 +1049,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Channel the resource belongs to" + "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the User Channel resource belongs to." }, "user_sid": { "type": "string", @@ -1057,7 +1057,7 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the User the User Channel belongs to" + "description": "The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) the User Channel belongs to." }, "member_sid": { "type": "string", @@ -1065,41 +1065,41 @@ "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the User as a Member in the Channel" + "description": "The SID of a [Member](https://www.twilio.com/docs/chat/rest/member-resource) that represents the User on the Channel." }, "status": { "type": "string", "$ref": "#/components/schemas/user_channel_enum_channel_status", "nullable": true, - "description": "The status of the User on the Channel" + "description": "The status of the User on the Channel. Can be: `joined`, `invited`, or `not_participating`." }, "last_consumed_message_index": { "type": "integer", "nullable": true, - "description": "The index of the last Message in the Channel the Member has read" + "description": "The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read." }, "unread_messages_count": { "type": "integer", "nullable": true, - "description": "The number of unread Messages in the Channel for the User" + "description": "The number of unread Messages in the Channel for the User. Note that retrieving messages on a client endpoint does not mean that messages are consumed or read. See [Consumption Horizon feature](https://www.twilio.com/docs/chat/consumption-horizon) to learn how to mark messages as consumed." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel" + "description": "The absolute URLs of the [Members](https://www.twilio.com/docs/chat/rest/member-resource), [Messages](https://www.twilio.com/docs/chat/rest/message-resource) , [Invites](https://www.twilio.com/docs/chat/rest/invite-resource) and, if it exists, the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) for the Channel." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the User Channel resource." }, "notification_level": { "type": "string", "$ref": "#/components/schemas/user_channel_enum_notification_level", "nullable": true, - "description": "The push notification level of the User for the Channel" + "description": "The push notification level of the User for the Channel. Can be: `default` or `muted`." } } }, diff --git a/spec/json/twilio_chat_v3.json b/spec/json/twilio_chat_v3.json index d6a842a7..9ed39f64 100644 --- a/spec/json/twilio_chat_v3.json +++ b/spec/json/twilio_chat_v3.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Channel resource." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Channel resource." }, "service_sid": { "type": "string", @@ -26,55 +26,55 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel resource is associated with." }, "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." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource" + "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." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data" + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." }, "type": { "type": "string", "$ref": "#/components/schemas/channel_enum_channel_type", "nullable": true, - "description": "The visibility of the channel. Can be: `public` or `private`" + "description": "The visibility of the channel. Can be: `public` or `private`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "created_by": { "type": "string", "nullable": true, - "description": "The identity of the User that created the channel" + "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`." }, "members_count": { "type": "integer", "nullable": true, - "description": "The number of Members in the Channel" + "description": "The number of Members in the Channel." }, "messages_count": { "type": "integer", "nullable": true, - "description": "The number of Messages that have been passed in the Channel" + "description": "The number of Messages that have been passed in the Channel." }, "messaging_service_sid": { "type": "string", @@ -82,13 +82,13 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Messaging Service this channel belongs to." + "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this channel belongs to." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Channel resource" + "description": "The absolute URL of the Channel resource." } } }, diff --git a/spec/json/twilio_content_v1.json b/spec/json/twilio_content_v1.json index 0ab76fe9..d62a6046 100644 --- a/spec/json/twilio_content_v1.json +++ b/spec/json/twilio_content_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Content resource" + "description": "The unique string that that we created to identify the Content resource." }, "account_sid": { "type": "string", @@ -18,17 +18,17 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Content resource" + "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" + "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`" + "description": "The URL of the resource, relative to `https://content.twilio.com`." } } }, @@ -39,13 +39,13 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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", @@ -53,7 +53,7 @@ "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the Content resource." }, "account_sid": { "type": "string", @@ -61,37 +61,37 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "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" + "description": "A string name used to describe the Content resource. Not visible to the end recipient." }, "language": { "type": "string", "nullable": true, - "description": "Two-letter language code identifying the language the Content resource is in." + "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" + "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 (e.g. twilio/text) for this Content resource" + "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`" + "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" + "description": "A list of links related to the Content resource, such as approval_fetch and approval_create" } } } diff --git a/spec/json/twilio_conversations_v1.json b/spec/json/twilio_conversations_v1.json index a0c0a7a7..40ebe084 100644 --- a/spec/json/twilio_conversations_v1.json +++ b/spec/json/twilio_conversations_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account responsible for this configuration." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this configuration." }, "default_chat_service_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the default Conversation Service that every new conversation is associated with." + "description": "The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) used when creating a conversation." }, "default_messaging_service_sid": { "type": "string", @@ -26,29 +26,29 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the default Messaging Service that every new conversation is associated with." + "description": "The SID of the default [Messaging Service](https://www.twilio.com/docs/sms/services/api) used when creating a conversation." }, "default_inactive_timer": { "type": "string", "nullable": true, - "description": "Default ISO8601 duration when conversation will be switched to `inactive` state." + "description": "Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute." }, "default_closed_timer": { "type": "string", "nullable": true, - "description": "Default ISO8601 duration when conversation will be switched to `closed` state." + "description": "Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this global configuration." + "description": "An absolute API resource URL for this global configuration." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the webhook and default service configurations." + "description": "Contains absolute API resource URLs to access the webhook and default service configurations." } } }, @@ -69,22 +69,22 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account the address belongs to." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) the address belongs to" }, "type": { "type": "string", "nullable": true, - "description": "Type of Address." + "description": "Type of Address, value can be `whatsapp` or `sms`." }, "address": { "type": "string", "nullable": true, - "description": "The unique address to be configured." + "description": "The unique address to be configured. The address can be a whatsapp address or phone number" }, "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this configuration." + "description": "The human-readable name of this configuration, limited to 256 characters. Optional." }, "auto_creation": { "nullable": true, @@ -106,7 +106,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this address configuration." + "description": "An absolute API resource URL for this address configuration." } } }, @@ -143,7 +143,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this conversation." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation." }, "method": { "type": "string", @@ -157,7 +157,7 @@ "type": "string" }, "nullable": true, - "description": "The list of webhook event triggers that are enabled for this Service." + "description": "The list of webhook event triggers that are enabled for this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`" }, "pre_webhook_url": { "type": "string", @@ -173,13 +173,13 @@ "type": "string", "$ref": "#/components/schemas/configuration_webhook_enum_target", "nullable": true, - "description": "The routing target of the webhook." + "description": "The routing target of the webhook. Can be ordinary or route internally to Flex" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this webhook." + "description": "An absolute API resource API resource URL for this webhook." } } }, @@ -206,7 +206,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this conversation." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation." }, "chat_service_sid": { "type": "string", @@ -214,7 +214,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation Service this conversation belongs to." + "description": "The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to." }, "messaging_service_sid": { "type": "string", @@ -222,7 +222,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Messaging Service this conversation belongs to." + "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to." }, "sid": { "type": "string", @@ -235,23 +235,23 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource" + "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." }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish." + "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." }, "state": { "type": "string", "$ref": "#/components/schemas/conversation_enum_state", "nullable": true, - "description": "Current state of this conversation." + "description": "Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active`" }, "date_created": { "type": "string", @@ -267,19 +267,19 @@ }, "timers": { "nullable": true, - "description": "Timer date values for this conversation." + "description": "Timer date values representing state update for this conversation." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this conversation." + "description": "An absolute API resource URL for this conversation." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the participants, messages and webhooks of this conversation." + "description": "Contains absolute URLs to access the [participants](https://www.twilio.com/docs/conversations/api/conversation-participant-resource), [messages](https://www.twilio.com/docs/conversations/api/conversation-message-resource) and [webhooks](https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource) of this conversation." }, "bindings": { "nullable": true @@ -310,7 +310,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this message." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this message." }, "conversation_sid": { "type": "string", @@ -318,7 +318,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation for this message." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message." }, "sid": { "type": "string", @@ -331,28 +331,28 @@ "index": { "type": "integer", "nullable": true, - "description": "The index of the message within the Conversation." + "description": "The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource). Indices may skip numbers, but will always be in order of when the message was received." }, "author": { "type": "string", "nullable": true, - "description": "The channel specific identifier of the message's author." + "description": "The channel specific identifier of the message's author. Defaults to `system`." }, "body": { "type": "string", "nullable": true, - "description": "The content of the message." + "description": "The content of the message, can be up to 1,600 characters long." }, "media": { "type": "array", "items": {}, "nullable": true, - "description": "An array of objects that describe the Message's media if attached, otherwise, 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`." }, "attributes": { "type": "string", "nullable": true, - "description": "A string metadata field you can use to store any data you wish." + "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." }, "participant_sid": { "type": "string", @@ -360,7 +360,7 @@ "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of messages's author participant." + "description": "The unique ID of messages's author participant. Null in case of `system` sent message." }, "date_created": { "type": "string", @@ -372,13 +372,13 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this resource was last updated." + "description": "The date that this resource was last updated. `null` if the message has not been edited." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute API URL for this message." + "description": "An absolute API resource API URL for this message." }, "delivery": { "nullable": true, @@ -388,7 +388,7 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URL to access the receipts of this message." + "description": "Contains an absolute API resource URL to access the delivery & read receipts of this message." }, "content_sid": { "type": "string", @@ -396,7 +396,7 @@ "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the multi-channel Rich Content template." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template." } } }, @@ -423,7 +423,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this participant." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant." }, "conversation_sid": { "type": "string", @@ -431,7 +431,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation for this message." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message." }, "sid": { "type": "string", @@ -447,7 +447,7 @@ "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the message the delivery receipt belongs to" + "description": "The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to" }, "channel_message_sid": { "type": "string", @@ -455,7 +455,7 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "A messaging channel-specific identifier for the message delivered to participant" + "description": "A messaging channel-specific identifier for the message delivered to participant e.g. `SMxx` for SMS, `WAxx` for Whatsapp etc. " }, "participant_sid": { "type": "string", @@ -469,12 +469,12 @@ "type": "string", "$ref": "#/components/schemas/conversation_message_receipt_enum_delivery_status", "nullable": true, - "description": "The message delivery status" + "description": "The message delivery status, can be `read`, `failed`, `delivered`, `undelivered`, `sent` or null." }, "error_code": { "type": "integer", "nullable": true, - "description": "The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status" + "description": "The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, " }, "date_created": { "type": "string", @@ -486,13 +486,13 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this resource was last updated." + "description": "The date that this resource was last updated. `null` if the delivery receipt has not been updated." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this delivery receipt." + "description": "An absolute API resource URL for this delivery receipt." } } }, @@ -515,7 +515,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this participant." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant." }, "conversation_sid": { "type": "string", @@ -523,7 +523,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation for this participant." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant." }, "sid": { "type": "string", @@ -536,16 +536,16 @@ "identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as Conversation User." + "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." }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish." + "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." }, "messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." }, "role_sid": { "type": "string", @@ -553,7 +553,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of a conversation-level Role to assign to the participant" + "description": "The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant." }, "date_created": { "type": "string", @@ -571,17 +571,17 @@ "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this participant." + "description": "An absolute API resource URL for this participant." }, "last_read_message_index": { "type": "integer", "nullable": true, - "description": "Index of last \u201cread\u201d message in the Conversation for the Participant." + "description": "Index of last \u201cread\u201d message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant." }, "last_read_timestamp": { "type": "string", "nullable": true, - "description": "Timestamp of last \u201cread\u201d message in the Conversation for the Participant." + "description": "Timestamp of last \u201cread\u201d message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant." } } }, @@ -609,7 +609,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this conversation." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation." }, "conversation_sid": { "type": "string", @@ -617,22 +617,22 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation for this webhook." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook." }, "target": { "type": "string", "nullable": true, - "description": "The target of this webhook." + "description": "The target of this webhook: `webhook`, `studio`, `trigger`" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this webhook." + "description": "An absolute API resource URL for this webhook." }, "configuration": { "nullable": true, - "description": "The configuration of this webhook." + "description": "The configuration of this webhook. Is defined based on target." }, "date_created": { "type": "string", @@ -680,23 +680,23 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this credential." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this credential." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this credential." + "description": "The human-readable name of this credential, limited to 64 characters. Optional." }, "type": { "type": "string", "$ref": "#/components/schemas/credential_enum_push_type", "nullable": true, - "description": "The type of push-notification service the credential is for." + "description": "The type of push-notification service the credential is for. Can be: `fcm`, `gcm`, or `apn`." }, "sandbox": { "type": "string", "nullable": true, - "description": "[APN only] Whether to send the credential to sandbox APNs." + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production." }, "date_created": { "type": "string", @@ -714,7 +714,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this credential." + "description": "An absolute API resource URL for this credential." } } }, @@ -735,7 +735,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this conversation." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation." }, "chat_service_sid": { "type": "string", @@ -743,7 +743,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation Service this conversation belongs to." + "description": "The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to." }, "participant_sid": { "type": "string", @@ -751,7 +751,7 @@ "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Participant." + "description": "The unique ID of the [Participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource)." }, "participant_user_sid": { "type": "string", @@ -759,16 +759,16 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID for the conversation participant as Conversation User." + "description": "The unique string that identifies the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource)." }, "participant_identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as Conversation User." + "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." }, "participant_messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." }, "conversation_sid": { "type": "string", @@ -776,55 +776,55 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation this Participant belongs to." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) this Participant belongs to." }, "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." }, "conversation_friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional." }, "conversation_attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish." + "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." }, "conversation_date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this conversation was created." + "description": "The date that this conversation was created, given in ISO 8601 format." }, "conversation_date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this conversation was last updated." + "description": "The date that this conversation was last updated, given in ISO 8601 format." }, "conversation_created_by": { "type": "string", "nullable": true, - "description": "Creator of this conversation." + "description": "Identity of the creator of this Conversation." }, "conversation_state": { "type": "string", "$ref": "#/components/schemas/participant_conversation_enum_state", "nullable": true, - "description": "The current state of this User Conversation" + "description": "The current state of this User Conversation. One of `inactive`, `active` or `closed`." }, "conversation_timers": { "nullable": true, - "description": "Timer date values for this conversation." + "description": "Timer date values representing state update for this conversation." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the participant and conversation of this Participant Conversation." + "description": "Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) of this conversation." } } }, @@ -845,7 +845,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Role resource." }, "account_sid": { "type": "string", @@ -853,7 +853,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Role resource." }, "chat_service_sid": { "type": "string", @@ -861,18 +861,18 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Conversation Service that the resource is associated with" + "description": "The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Role resource is associated with." }, "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." }, "type": { "type": "string", "$ref": "#/components/schemas/role_enum_role_type", "nullable": true, - "description": "The type of role" + "description": "The type of role. Can be: `conversation` for [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) roles or `service` for [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) roles." }, "permissions": { "type": "array", @@ -880,25 +880,25 @@ "type": "string" }, "nullable": true, - "description": "An array of the permissions the role has been granted" + "description": "An array of the permissions the role has been granted." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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": "An absolute URL for this user role." + "description": "An absolute API resource URL for this user role." } } }, @@ -918,7 +918,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this service." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this service." }, "sid": { "type": "string", @@ -931,7 +931,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this service." + "description": "The human-readable name of this service, limited to 256 characters. Optional." }, "date_created": { "type": "string", @@ -949,13 +949,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this service." + "description": "An absolute API resource URL for this service." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the conversations, users, roles, bindings and configuration of this service." + "description": "Contains absolute API resource URLs to access conversations, users, roles, bindings and configuration of this service." } } }, @@ -976,7 +976,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this binding." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this binding." }, "chat_service_sid": { "type": "string", @@ -984,7 +984,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Conversation Service that the resource is associated with." + "description": "The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with." }, "credential_sid": { "type": "string", @@ -992,7 +992,7 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Credential for the binding." + "description": "The SID of the [Credential](https://www.twilio.com/docs/conversations/api/credential-resource) for the binding. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info." }, "date_created": { "type": "string", @@ -1009,18 +1009,18 @@ "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the Binding." + "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`." }, "identity": { "type": "string", "nullable": true, - "description": "The identity of Conversation User associated with this binding." + "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." }, "binding_type": { "type": "string", "$ref": "#/components/schemas/service_binding_enum_binding_type", "nullable": true, - "description": "The push technology to use for the binding." + "description": "The push technology to use for the Binding. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info." }, "message_types": { "type": "array", @@ -1028,13 +1028,13 @@ "type": "string" }, "nullable": true, - "description": "The Conversation message types the binding is subscribed to." + "description": "The [Conversation message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this binding." + "description": "An absolute API resource URL for this binding." } } }, @@ -1055,7 +1055,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Service configuration resource." }, "default_conversation_creator_role_sid": { "type": "string", @@ -1063,7 +1063,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The role assigned to a conversation creator user when they join a new conversation" + "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." }, "default_conversation_role_sid": { "type": "string", @@ -1071,7 +1071,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The role assigned to users when they are added to a conversation" + "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." }, "default_chat_service_role_sid": { "type": "string", @@ -1079,24 +1079,24 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The service role assigned to users when they are added to the service" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this service configuration." + "description": "An absolute API resource URL for this service configuration." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URL to access the push notifications configuration of this service." + "description": "Contains an absolute API resource URL to access the push notifications configuration of this service." }, "reachability_enabled": { "type": "boolean", "nullable": true, - "description": "Whether the Reachability Indicator feature is enabled for this Conversations Service" + "description": "Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) is enabled for this Conversations Service. The default is `false`." } } }, @@ -1109,7 +1109,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this conversation." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation." }, "chat_service_sid": { "type": "string", @@ -1117,7 +1117,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation Service this conversation belongs to." + "description": "The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to." }, "messaging_service_sid": { "type": "string", @@ -1125,7 +1125,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Messaging Service this conversation belongs to." + "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to." }, "sid": { "type": "string", @@ -1138,23 +1138,23 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource" + "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." }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish." + "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." }, "state": { "type": "string", "$ref": "#/components/schemas/service_conversation_enum_state", "nullable": true, - "description": "Current state of this conversation." + "description": "Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active`" }, "date_created": { "type": "string", @@ -1170,19 +1170,19 @@ }, "timers": { "nullable": true, - "description": "Timer date values for this conversation." + "description": "Timer date values representing state update for this conversation." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this conversation." + "description": "An absolute API resource URL for this conversation." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the participants, messages and webhooks of this conversation." + "description": "Contains absolute URLs to access the [participants](https://www.twilio.com/docs/conversations/api/conversation-participant-resource), [messages](https://www.twilio.com/docs/conversations/api/conversation-message-resource) and [webhooks](https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource) of this conversation." }, "bindings": { "nullable": true @@ -1213,7 +1213,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this message." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this message." }, "chat_service_sid": { "type": "string", @@ -1221,7 +1221,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Conversation Service that the resource is associated with." + "description": "The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with." }, "conversation_sid": { "type": "string", @@ -1229,7 +1229,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation for this message." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message." }, "sid": { "type": "string", @@ -1242,28 +1242,28 @@ "index": { "type": "integer", "nullable": true, - "description": "The index of the message within the Conversation." + "description": "The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)." }, "author": { "type": "string", "nullable": true, - "description": "The channel specific identifier of the message's author." + "description": "The channel specific identifier of the message's author. Defaults to `system`." }, "body": { "type": "string", "nullable": true, - "description": "The content of the message." + "description": "The content of the message, can be up to 1,600 characters long." }, "media": { "type": "array", "items": {}, "nullable": true, - "description": "An array of objects that describe the Message's media if attached, otherwise, 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`." }, "attributes": { "type": "string", "nullable": true, - "description": "A string metadata field you can use to store any data you wish." + "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." }, "participant_sid": { "type": "string", @@ -1271,7 +1271,7 @@ "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of messages's author participant." + "description": "The unique ID of messages's author participant. Null in case of `system` sent message." }, "date_created": { "type": "string", @@ -1283,7 +1283,7 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this resource was last updated." + "description": "The date that this resource was last updated. `null` if the message has not been edited." }, "delivery": { "nullable": true, @@ -1293,13 +1293,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this message." + "description": "An absolute API resource URL for this message." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URL to access the receipts of this message." + "description": "Contains an absolute API resource URL to access the delivery & read receipts of this message." }, "content_sid": { "type": "string", @@ -1307,7 +1307,7 @@ "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the multi-channel Rich Content template." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template." } } }, @@ -1334,7 +1334,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this participant." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant." }, "chat_service_sid": { "type": "string", @@ -1342,7 +1342,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Conversation Service that the resource is associated with." + "description": "The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with." }, "conversation_sid": { "type": "string", @@ -1350,7 +1350,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation for this message." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message." }, "message_sid": { "type": "string", @@ -1358,7 +1358,7 @@ "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the message the delivery receipt belongs to" + "description": "The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to" }, "sid": { "type": "string", @@ -1374,7 +1374,7 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "A messaging channel-specific identifier for the message delivered to participant" + "description": "A messaging channel-specific identifier for the message delivered to participant e.g. `SMxx` for SMS, `WAxx` for Whatsapp etc. " }, "participant_sid": { "type": "string", @@ -1388,12 +1388,12 @@ "type": "string", "$ref": "#/components/schemas/service_conversation_message_receipt_enum_delivery_status", "nullable": true, - "description": "The message delivery status" + "description": "The message delivery status, can be `read`, `failed`, `delivered`, `undelivered`, `sent` or null." }, "error_code": { "type": "integer", "nullable": true, - "description": "The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status" + "description": "The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, " }, "date_created": { "type": "string", @@ -1405,13 +1405,13 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this resource was last updated." + "description": "The date that this resource was last updated. `null` if the delivery receipt has not been updated." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this delivery receipt." + "description": "An absolute API resource URL for this delivery receipt." } } }, @@ -1434,7 +1434,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this participant." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant." }, "chat_service_sid": { "type": "string", @@ -1442,7 +1442,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Conversation Service that the resource is associated with." + "description": "The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with." }, "conversation_sid": { "type": "string", @@ -1450,7 +1450,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation for this participant." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant." }, "sid": { "type": "string", @@ -1463,16 +1463,16 @@ "identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as Conversation User." + "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." }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish." + "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." }, "messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." }, "role_sid": { "type": "string", @@ -1480,7 +1480,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of a conversation-level Role to assign to the participant" + "description": "The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant." }, "date_created": { "type": "string", @@ -1498,17 +1498,17 @@ "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this participant." + "description": "An absolute API resource URL for this participant." }, "last_read_message_index": { "type": "integer", "nullable": true, - "description": "Index of last \u201cread\u201d message in the Conversation for the Participant." + "description": "Index of last \u201cread\u201d message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant." }, "last_read_timestamp": { "type": "string", "nullable": true, - "description": "Timestamp of last \u201cread\u201d message in the Conversation for the Participant." + "description": "Timestamp of last \u201cread\u201d message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant." } } }, @@ -1536,7 +1536,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this conversation." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation." }, "chat_service_sid": { "type": "string", @@ -1544,7 +1544,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Conversation Service that the resource is associated with." + "description": "The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with." }, "conversation_sid": { "type": "string", @@ -1552,22 +1552,22 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation for this webhook." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook." }, "target": { "type": "string", "nullable": true, - "description": "The target of this webhook." + "description": "The target of this webhook: `webhook`, `studio`, `trigger`" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this webhook." + "description": "An absolute API resource URL for this webhook." }, "configuration": { "nullable": true, - "description": "The configuration of this webhook." + "description": "The configuration of this webhook. Is defined based on target." }, "date_created": { "type": "string", @@ -1607,7 +1607,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this configuration." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this configuration." }, "chat_service_sid": { "type": "string", @@ -1615,7 +1615,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Conversation Service that the Configuration applies to." + "description": "The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to." }, "new_message": { "nullable": true, @@ -1638,7 +1638,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this configuration." + "description": "An absolute API resource URL for this configuration." } } }, @@ -1651,7 +1651,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this conversation." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation." }, "chat_service_sid": { "type": "string", @@ -1659,7 +1659,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation Service this conversation belongs to." + "description": "The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to." }, "participant_sid": { "type": "string", @@ -1667,7 +1667,7 @@ "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Participant." + "description": "The unique ID of the [Participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource)." }, "participant_user_sid": { "type": "string", @@ -1675,16 +1675,16 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID for the conversation participant as Conversation User." + "description": "The unique string that identifies the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource)." }, "participant_identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as Conversation User." + "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." }, "participant_messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." }, "conversation_sid": { "type": "string", @@ -1692,7 +1692,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation this Participant belongs to." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) this Participant belongs to." }, "conversation_unique_name": { "type": "string", @@ -1702,45 +1702,45 @@ "conversation_friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional." }, "conversation_attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish." + "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." }, "conversation_date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this conversation was created." + "description": "The date that this conversation was created, given in ISO 8601 format." }, "conversation_date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this conversation was last updated." + "description": "The date that this conversation was last updated, given in ISO 8601 format." }, "conversation_created_by": { "type": "string", "nullable": true, - "description": "Creator of this conversation." + "description": "Identity of the creator of this Conversation." }, "conversation_state": { "type": "string", "$ref": "#/components/schemas/service_participant_conversation_enum_state", "nullable": true, - "description": "The current state of this User Conversation" + "description": "The current state of this User Conversation. One of `inactive`, `active` or `closed`." }, "conversation_timers": { "nullable": true, - "description": "Timer date values for this conversation." + "description": "Timer date values representing state update for this conversation." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the participant and conversation of this Participant Conversation." + "description": "Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) of this conversation." } } }, @@ -1761,7 +1761,7 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Role resource." }, "account_sid": { "type": "string", @@ -1769,7 +1769,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Role resource." }, "chat_service_sid": { "type": "string", @@ -1777,18 +1777,18 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Conversation Service that the resource is associated with" + "description": "The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Role resource is associated with." }, "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." }, "type": { "type": "string", "$ref": "#/components/schemas/service_role_enum_role_type", "nullable": true, - "description": "The type of role" + "description": "The type of role. Can be: `conversation` for [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) roles or `service` for [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) roles." }, "permissions": { "type": "array", @@ -1796,25 +1796,25 @@ "type": "string" }, "nullable": true, - "description": "An array of the permissions the role has been granted" + "description": "An array of the permissions the role has been granted." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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": "An absolute URL for this user role." + "description": "An absolute API resource URL for this user role." } } }, @@ -1834,7 +1834,7 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the User resource." }, "account_sid": { "type": "string", @@ -1842,7 +1842,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User resource." }, "chat_service_sid": { "type": "string", @@ -1850,7 +1850,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Conversation Service that the resource is associated with" + "description": "The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with." }, "role_sid": { "type": "string", @@ -1858,50 +1858,50 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of a service-level Role assigned to the user" + "description": "The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) assigned to the user." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "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." }, "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." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON Object string that stores application-specific data" + "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned." }, "is_online": { "type": "boolean", "nullable": true, - "description": "Whether the User is actively connected to this Conversations Service and online" + "description": "Whether the User is actively connected to this Conversations Service and online. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, if the User has never been online for this Conversations Service, even if the Service's `reachability_enabled` is `true`." }, "is_notifiable": { "type": "boolean", "nullable": true, - "description": "Whether the User has a potentially valid Push Notification registration for this Conversations Service" + "description": "Whether the User has a potentially valid Push Notification registration (APN or GCM) for this Conversations Service. If at least one registration exists, `true`; otherwise `false`. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, and if the User has never had a notification registration, even if the Service's `reachability_enabled` is `true`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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": "An absolute URL for this user." + "description": "An absolute API resource URL for this user." }, "links": { "type": "object", @@ -1926,7 +1926,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this conversation." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation." }, "chat_service_sid": { "type": "string", @@ -1934,7 +1934,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation Service this conversation belongs to." + "description": "The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to." }, "conversation_sid": { "type": "string", @@ -1942,17 +1942,17 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation for this User Conversation." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this User Conversation." }, "unread_messages_count": { "type": "integer", "nullable": true, - "description": "The number of unread Messages in the Conversation." + "description": "The number of unread Messages in the Conversation for the Participant." }, "last_read_message_index": { "type": "integer", "nullable": true, - "description": "The index of the last read Message ." + "description": "The index of the last Message in the Conversation that the Participant has read." }, "participant_sid": { "type": "string", @@ -1960,7 +1960,7 @@ "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true, - "description": "Participant Sid." + "description": "The unique ID of the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) the user conversation belongs to." }, "user_sid": { "type": "string", @@ -1968,55 +1968,55 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID for the User." + "description": "The unique string that identifies the [User resource](https://www.twilio.com/docs/conversations/api/user-resource)." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional." }, "conversation_state": { "type": "string", "$ref": "#/components/schemas/service_user_conversation_enum_state", "nullable": true, - "description": "The current state of this User Conversation" + "description": "The current state of this User Conversation. One of `inactive`, `active` or `closed`." }, "timers": { "nullable": true, - "description": "Timer date values for this conversation." + "description": "Timer date values representing state update for this conversation." }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish." + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this conversation was created." + "description": "The date that this conversation was created, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this conversation was last updated." + "description": "The date that this conversation was last updated, given in ISO 8601 format." }, "created_by": { "type": "string", "nullable": true, - "description": "Creator of this conversation." + "description": "Identity of the creator of this Conversation." }, "notification_level": { "type": "string", "$ref": "#/components/schemas/service_user_conversation_enum_notification_level", "nullable": true, - "description": "The Notification Level of this User Conversation." + "description": "The Notification Level of this User Conversation. One of `default` or `muted`." }, "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. It can be used to address the resource in place of the resource's `conversation_sid` in the URL." }, "url": { "type": "string", @@ -2027,7 +2027,7 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the participant and conversation of this user conversation." + "description": "Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) of this conversation." } } }, @@ -2055,7 +2055,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this service." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this service." }, "chat_service_sid": { "type": "string", @@ -2083,19 +2083,19 @@ "type": "string" }, "nullable": true, - "description": "The list of events that your configured webhook targets will receive. Events not configured here will not fire." + "description": "The list of events that your configured webhook targets will receive. Events not configured here will not fire. Possible values are `onParticipantAdd`, `onParticipantAdded`, `onDeliveryUpdated`, `onConversationUpdated`, `onConversationRemove`, `onParticipantRemove`, `onConversationUpdate`, `onMessageAdd`, `onMessageRemoved`, `onParticipantUpdated`, `onConversationAdded`, `onMessageAdded`, `onConversationAdd`, `onConversationRemoved`, `onParticipantUpdate`, `onMessageRemove`, `onMessageUpdated`, `onParticipantRemoved`, `onMessageUpdate` or `onConversationStateUpdated`." }, "method": { "type": "string", "$ref": "#/components/schemas/service_webhook_configuration_enum_method", "nullable": true, - "description": "The HTTP method to be used when sending a webhook request" + "description": "The HTTP method to be used when sending a webhook request. One of `GET` or `POST`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this webhook." + "description": "An absolute API resource URL for this webhook." } } }, @@ -2115,7 +2115,7 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the User resource." }, "account_sid": { "type": "string", @@ -2123,7 +2123,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User resource." }, "chat_service_sid": { "type": "string", @@ -2131,7 +2131,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Conversation Service that the resource is associated with" + "description": "The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with." }, "role_sid": { "type": "string", @@ -2139,50 +2139,50 @@ "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of a service-level Role assigned to the user" + "description": "The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) assigned to the user." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "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." }, "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." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON Object string that stores application-specific data" + "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned." }, "is_online": { "type": "boolean", "nullable": true, - "description": "Whether the User is actively connected to this Conversations Service and online" + "description": "Whether the User is actively connected to this Conversations Service and online. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, if the User has never been online for this Conversations Service, even if the Service's `reachability_enabled` is `true`." }, "is_notifiable": { "type": "boolean", "nullable": true, - "description": "Whether the User has a potentially valid Push Notification registration for this Conversations Service" + "description": "Whether the User has a potentially valid Push Notification registration (APN or GCM) for this Conversations Service. If at least one registration exists, `true`; otherwise `false`. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, and if the User has never had a notification registration, even if the Service's `reachability_enabled` is `true`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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": "An absolute URL for this user." + "description": "An absolute API resource URL for this user." }, "links": { "type": "object", @@ -2207,7 +2207,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Account responsible for this conversation." + "description": "The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation." }, "chat_service_sid": { "type": "string", @@ -2215,7 +2215,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation Service this conversation belongs to." + "description": "The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to." }, "conversation_sid": { "type": "string", @@ -2223,17 +2223,17 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Conversation for this User Conversation." + "description": "The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this User Conversation." }, "unread_messages_count": { "type": "integer", "nullable": true, - "description": "The number of unread Messages in the Conversation." + "description": "The number of unread Messages in the Conversation for the Participant." }, "last_read_message_index": { "type": "integer", "nullable": true, - "description": "The index of the last read Message ." + "description": "The index of the last Message in the Conversation that the Participant has read." }, "participant_sid": { "type": "string", @@ -2241,7 +2241,7 @@ "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true, - "description": "Participant Sid." + "description": "The unique ID of the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) the user conversation belongs to." }, "user_sid": { "type": "string", @@ -2249,55 +2249,55 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID for the User." + "description": "The unique string that identifies the [User resource](https://www.twilio.com/docs/conversations/api/user-resource)." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional." }, "conversation_state": { "type": "string", "$ref": "#/components/schemas/user_conversation_enum_state", "nullable": true, - "description": "The current state of this User Conversation" + "description": "The current state of this User Conversation. One of `inactive`, `active` or `closed`." }, "timers": { "nullable": true, - "description": "Timer date values for this conversation." + "description": "Timer date values representing state update for this conversation." }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish." + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this conversation was created." + "description": "The date that this conversation was created, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this conversation was last updated." + "description": "The date that this conversation was last updated, given in ISO 8601 format." }, "created_by": { "type": "string", "nullable": true, - "description": "Creator of this conversation." + "description": "Identity of the creator of this Conversation." }, "notification_level": { "type": "string", "$ref": "#/components/schemas/user_conversation_enum_notification_level", "nullable": true, - "description": "The Notification Level of this User Conversation." + "description": "The Notification Level of this User Conversation. One of `default` or `muted`." }, "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. It can be used to address the resource in place of the resource's `conversation_sid` in the URL." }, "url": { "type": "string", @@ -2308,7 +2308,7 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "Absolute URLs to access the participant and conversation of this user conversation." + "description": "Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) of this conversation." } } }, diff --git a/spec/json/twilio_events_v1.json b/spec/json/twilio_events_v1.json index 2a77f57f..a6b98704 100644 --- a/spec/json/twilio_events_v1.json +++ b/spec/json/twilio_events_v1.json @@ -7,29 +7,29 @@ "type": { "type": "string", "nullable": true, - "description": "The Event Type identifier." + "description": "A string that uniquely identifies this Event Type." }, "schema_id": { "type": "string", "nullable": true, - "description": "The Schema identifier for this Event Type." + "description": "A string that uniquely identifies the Schema this Event Type adheres to." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Event Type was created." + "description": "The date that this Event Type was created, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Event Type was updated." + "description": "The date that this Event Type was updated, given in ISO 8601 format." }, "description": { "type": "string", "nullable": true, - "description": "Event Type description." + "description": "A human readable description for this Event Type." }, "url": { "type": "string", @@ -50,7 +50,7 @@ "id": { "type": "string", "nullable": true, - "description": "Schema Identifier." + "description": "The unique identifier of the schema. Each schema can have multiple versions, that share the same id." }, "url": { "type": "string", @@ -62,18 +62,18 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs." + "description": "Contains a dictionary of URL links to nested resources of this schema." }, "latest_version_date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that the latest schema version was created." + "description": "The date that the latest schema version was created, given in ISO 8601 format." }, "latest_version": { "type": "integer", "nullable": true, - "description": "Latest schema version." + "description": "The latest version published of this schema." } } }, @@ -83,7 +83,7 @@ "id": { "type": "string", "nullable": true, - "description": "The unique identifier of the schema." + "description": "The unique identifier of the schema. Each schema can have multiple versions, that share the same id." }, "schema_version": { "type": "integer", @@ -94,7 +94,7 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The date the schema version was created." + "description": "The date the schema version was created, given in ISO 8601 format." }, "url": { "type": "string", @@ -116,18 +116,18 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Sink was created" + "description": "The date that this Sink was created, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Sink was updated" + "description": "The date that this Sink was updated, given in ISO 8601 format." }, "description": { "type": "string", "nullable": true, - "description": "Sink Description" + "description": "A human readable description for the Sink" }, "sid": { "type": "string", @@ -135,23 +135,23 @@ "maxLength": 34, "pattern": "^DG[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Sink." + "description": "A 34 character string that uniquely identifies this Sink." }, "sink_configuration": { "nullable": true, - "description": "JSON Sink configuration." + "description": "The information required for Twilio to connect to the provided Sink encoded as JSON." }, "sink_type": { "type": "string", "$ref": "#/components/schemas/sink_enum_sink_type", "nullable": true, - "description": "Sink type." + "description": "The Sink type. Can only be \"kinesis\" or \"webhook\" currently." }, "status": { "type": "string", "$ref": "#/components/schemas/sink_enum_status", "nullable": true, - "description": "The Status of this Sink" + "description": "The Status of this Sink. One of `initialized`, `validating`, `active` or `failed`." }, "url": { "type": "string", @@ -163,7 +163,7 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs." + "description": "Contains a dictionary of URL links to nested resources of this Sink." } } }, @@ -213,7 +213,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account SID." + "description": "The unique SID identifier of the Account." }, "type": { "type": "string", @@ -231,7 +231,7 @@ "maxLength": 34, "pattern": "^DF[0-9a-fA-F]{32}$", "nullable": true, - "description": "Subscription SID." + "description": "The unique SID identifier of the Subscription." }, "url": { "type": "string", @@ -250,7 +250,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account SID." + "description": "The unique SID identifier of the Account." }, "sid": { "type": "string", @@ -258,24 +258,24 @@ "maxLength": 34, "pattern": "^DF[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Subscription." + "description": "A 34 character string that uniquely identifies this Subscription." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Subscription was created" + "description": "The date that this Subscription was created, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Subscription was updated" + "description": "The date that this Subscription was updated, given in ISO 8601 format." }, "description": { "type": "string", "nullable": true, - "description": "Subscription description" + "description": "A human readable description for the Subscription" }, "sink_sid": { "type": "string", @@ -283,7 +283,7 @@ "maxLength": 34, "pattern": "^DG[0-9a-fA-F]{32}$", "nullable": true, - "description": "Sink SID." + "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." }, "url": { "type": "string", @@ -295,7 +295,7 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs." + "description": "Contains a dictionary of URL links to nested resources of this Subscription." } } } diff --git a/spec/json/twilio_flex_v1.json b/spec/json/twilio_flex_v1.json index 3e16f62d..8e0d718c 100644 --- a/spec/json/twilio_flex_v1.json +++ b/spec/json/twilio_flex_v1.json @@ -21,7 +21,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource and owns this Workflow" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Channel resource and owns this Workflow." }, "flex_flow_sid": { "type": "string", @@ -29,7 +29,7 @@ "maxLength": 34, "pattern": "^FO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flex Flow" + "description": "The SID of the Flex Flow." }, "sid": { "type": "string", @@ -37,7 +37,7 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Channel resource." }, "user_sid": { "type": "string", @@ -45,7 +45,7 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the chat user" + "description": "The SID of the chat user." }, "task_sid": { "type": "string", @@ -53,25 +53,25 @@ "maxLength": 34, "pattern": "^WT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the TaskRouter Task" + "description": "The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external`" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Flex chat channel resource" + "description": "The absolute URL of the Flex chat channel resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Flex chat channel was created" + "description": "The date and time in GMT when the Flex chat channel 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 ISO 8601 date and time in GMT when the Flex chat channel was last updated" + "description": "The date and time in GMT when the Flex chat channel was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." } } }, @@ -84,29 +84,29 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Configuration resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Configuration resource was created" + "description": "The date and time in GMT when the Configuration 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 ISO 8601 date and time in GMT when the Configuration resource was last updated" + "description": "The date and time in GMT when the Configuration resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "attributes": { "nullable": true, - "description": "An object that contains application-specific data" + "description": "An object that contains application-specific data." }, "status": { "type": "string", "$ref": "#/components/schemas/configuration_enum_status", "nullable": true, - "description": "The status of the Flex onboarding" + "description": "The status of the Flex onboarding. Can be: `ok`, `inprogress`,`notstarted`." }, "taskrouter_workspace_sid": { "type": "string", @@ -114,7 +114,7 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the TaskRouter Workspace" + "description": "The SID of the TaskRouter Workspace." }, "taskrouter_target_workflow_sid": { "type": "string", @@ -122,7 +122,7 @@ "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the TaskRouter target Workflow" + "description": "The SID of the TaskRouter target Workflow." }, "taskrouter_target_taskqueue_sid": { "type": "string", @@ -130,27 +130,27 @@ "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the TaskRouter Target TaskQueue" + "description": "The SID of the TaskRouter Target TaskQueue." }, "taskrouter_taskqueues": { "type": "array", "items": {}, "nullable": true, - "description": "The list of TaskRouter TaskQueues" + "description": "The list of TaskRouter TaskQueues." }, "taskrouter_skills": { "type": "array", "items": {}, "nullable": true, - "description": "The Skill description for TaskRouter workers" + "description": "The Skill description for TaskRouter workers." }, "taskrouter_worker_channels": { "nullable": true, - "description": "The TaskRouter default channel capacities and availability for workers" + "description": "The TaskRouter default channel capacities and availability for workers." }, "taskrouter_worker_attributes": { "nullable": true, - "description": "The TaskRouter Worker attributes" + "description": "The TaskRouter Worker attributes." }, "taskrouter_offline_activity_sid": { "type": "string", @@ -158,13 +158,13 @@ "maxLength": 34, "pattern": "^WA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The TaskRouter SID of the offline activity" + "description": "The TaskRouter SID of the offline activity." }, "runtime_domain": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL where the Flex instance is hosted" + "description": "The URL where the Flex instance is hosted." }, "messaging_service_instance_sid": { "type": "string", @@ -172,7 +172,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Messaging service instance" + "description": "The SID of the Messaging service instance." }, "chat_service_instance_sid": { "type": "string", @@ -180,7 +180,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the chat service this user belongs to" + "description": "The SID of the chat service this user belongs to." }, "flex_service_instance_sid": { "type": "string", @@ -188,90 +188,90 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flex service instance" + "description": "The SID of the Flex service instance." }, "ui_language": { "type": "string", "nullable": true, - "description": "The primary language of the Flex UI" + "description": "The primary language of the Flex UI." }, "ui_attributes": { "nullable": true, - "description": "The object that describes Flex UI characteristics and settings" + "description": "The object that describes Flex UI characteristics and settings." }, "ui_dependencies": { "nullable": true, - "description": "The object that defines the NPM packages and versions to be used in Hosted Flex" + "description": "The object that defines the NPM packages and versions to be used in Hosted Flex." }, "ui_version": { "type": "string", "nullable": true, - "description": "The Pinned UI version" + "description": "The Pinned UI version." }, "service_version": { "type": "string", "nullable": true, - "description": "The Flex Service version" + "description": "The Flex Service version." }, "call_recording_enabled": { "type": "boolean", "nullable": true, - "description": "Whether call recording is enabled" + "description": "Whether call recording is enabled." }, "call_recording_webhook_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The call recording webhook URL" + "description": "The call recording webhook URL." }, "crm_enabled": { "type": "boolean", "nullable": true, - "description": "Whether CRM is present for Flex" + "description": "Whether CRM is present for Flex." }, "crm_type": { "type": "string", "nullable": true, - "description": "The CRM Type" + "description": "The CRM type." }, "crm_callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The CRM Callback URL" + "description": "The CRM Callback URL." }, "crm_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The CRM Fallback URL" + "description": "The CRM Fallback URL." }, "crm_attributes": { "nullable": true, - "description": "An object that contains the CRM attributes" + "description": "An object that contains the CRM attributes." }, "public_attributes": { "nullable": true, - "description": "The list of public attributes" + "description": "The list of public attributes, which are visible to unauthenticated clients." }, "plugin_service_enabled": { "type": "boolean", "nullable": true, - "description": "Whether the plugin service enabled" + "description": "Whether the plugin service enabled." }, "plugin_service_attributes": { "nullable": true, - "description": "The plugin service attributes" + "description": "The plugin service attributes." }, "integrations": { "type": "array", "items": {}, "nullable": true, - "description": "A list of objects that contain the configurations for the Integrations supported in this configuration" + "description": "A list of objects that contain the configurations for the Integrations supported in this configuration." }, "outbound_call_flows": { "nullable": true, - "description": "The list of outbound call flows" + "description": "The list of outbound call flows." }, "serverless_service_sids": { "type": "array", @@ -282,34 +282,34 @@ "pattern": "^ZS[0-9a-fA-F]{32}$" }, "nullable": true, - "description": "The list of serverless service SIDs" + "description": "The list of serverless service SIDs." }, "queue_stats_configuration": { "nullable": true, - "description": "Configurable parameters for Queues Statistics" + "description": "Configurable parameters for Queues Statistics." }, "notifications": { "nullable": true, - "description": "Configurable parameters for Notifications" + "description": "Configurable parameters for Notifications." }, "markdown": { "nullable": true, - "description": "Configurable parameters for Markdown" + "description": "Configurable parameters for Markdown." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Configuration resource" + "description": "The absolute URL of the Configuration resource." }, "flex_insights_hr": { "nullable": true, - "description": "Object that controls workspace reporting" + "description": "Object with enabled/disabled flag with list of workspaces." }, "flex_insights_drilldown": { "type": "boolean", "nullable": true, - "description": "Setting to enable Flex UI redirection" + "description": "Setting this to true will redirect Flex UI to the URL set in flex_url" }, "flex_url": { "type": "string", @@ -321,15 +321,15 @@ "type": "array", "items": {}, "nullable": true, - "description": "Flex Conversations channels' attachments configurations" + "description": "Settings for different limits for Flex Conversations channels attachments." }, "debugger_integration": { "nullable": true, - "description": "Configurable parameters for Debugger Integration" + "description": "Configurable parameters for Debugger Integration." }, "flex_ui_status_report": { "nullable": true, - "description": "Configurable parameters for Flex UI Status report" + "description": "Configurable parameters for Flex UI Status report." } } }, @@ -350,19 +350,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Flow resource and owns this Workflow." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "sid": { "type": "string", @@ -370,12 +370,12 @@ "maxLength": 34, "pattern": "^FO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Flex Flow resource." }, "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." }, "chat_service_sid": { "type": "string", @@ -383,49 +383,49 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the chat service" + "description": "The SID of the chat service." }, "channel_type": { "type": "string", "$ref": "#/components/schemas/flex_flow_enum_channel_type", "nullable": true, - "description": "The 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." }, "contact_identity": { "type": "string", "nullable": true, - "description": "The channel contact's Identity" + "description": "The channel contact's Identity." }, "enabled": { "type": "boolean", "nullable": true, - "description": "Whether the Flex Flow is enabled" + "description": "Whether the Flex Flow is enabled." }, "integration_type": { "type": "string", "$ref": "#/components/schemas/flex_flow_enum_integration_type", "nullable": true, - "description": "The software that will handle inbound messages." + "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": { "nullable": true, - "description": "An object that contains specific parameters for the integration" + "description": "An object that contains specific parameters for the integration." }, "long_lived": { "type": "boolean", "nullable": true, - "description": "Re-use this chat channel for future interactions with a contact" + "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`." }, "janitor_enabled": { "type": "boolean", "nullable": true, - "description": "Remove active Proxy sessions if the corresponding Task is deleted." + "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`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Flex Flow resource" + "description": "The absolute URL of the Flex Flow resource." } } }, @@ -459,17 +459,17 @@ "session_expiry": { "type": "string", "nullable": true, - "description": "The session expiry date and time" + "description": "The session expiry date and time, given in ISO 8601 format." }, "session_id": { "type": "string", "nullable": true, - "description": "Unique session ID" + "description": "The unique ID for the session" }, "base_url": { "type": "string", "nullable": true, - "description": "Base URL to fetch reports and dashboards" + "description": "The base URL to fetch reports and dashboards" }, "url": { "type": "string", @@ -488,15 +488,15 @@ "maxLength": 34, "pattern": "^KD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD." }, "channel": { "nullable": true, - "description": "The Interaction's channel" + "description": "A JSON object that defines the Interaction\u2019s communication channel and includes details about the channel. See the [Outbound SMS](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) and [inbound (API-initiated)](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#api-initiated-contact) Channel object examples." }, "routing": { "nullable": true, - "description": "A JSON Object representing the routing rules for the Interaction Channel" + "description": "A JSON Object representing the routing rules for the Interaction Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality. \n All attributes in the Routing object on your Interaction request body are added \u201cas is\u201d to the task. For a list of known attributes consumed by the Flex UI and/or Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes)." }, "url": { "type": "string", @@ -519,7 +519,7 @@ "maxLength": 34, "pattern": "^UO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO." }, "interaction_sid": { "type": "string", @@ -527,13 +527,13 @@ "maxLength": 34, "pattern": "^KD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource." + "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD." }, "type": { "type": "string", "$ref": "#/components/schemas/interaction_channel_enum_type", "nullable": true, - "description": "The Interaction Channel's type." + "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" }, "status": { "type": "string", @@ -601,7 +601,7 @@ "maxLength": 34, "pattern": "^KG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string created by Twilio to identify an Interaction Channel Invite resource." }, "interaction_sid": { "type": "string", @@ -609,7 +609,7 @@ "maxLength": 34, "pattern": "^KD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The Interaction SID for this Channel" + "description": "The Interaction SID for this Channel." }, "channel_sid": { "type": "string", @@ -617,11 +617,11 @@ "maxLength": 34, "pattern": "^UO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The Channel SID for this Invite" + "description": "The Channel SID for this Invite." }, "routing": { "nullable": true, - "description": "A JSON object representing the routing rules for the Interaction Channel" + "description": "A JSON object representing the routing rules for the Interaction Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality. \n All attributes in the Routing object on your Interaction request body are added \u201cas is\u201d to the task. For a list of known attributes consumed by the Flex UI and/or Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes)." }, "url": { "type": "string", @@ -652,13 +652,13 @@ "maxLength": 34, "pattern": "^UT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string created by Twilio to identify an Interaction Channel Participant resource." }, "type": { "type": "string", "$ref": "#/components/schemas/interaction_channel_participant_enum_type", "nullable": true, - "description": "Participant type." + "description": "Participant type. Can be: `agent`, `customer`, `supervisor`, `external`, `unknown`" }, "interaction_sid": { "type": "string", @@ -727,7 +727,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource and owns this Workflow" + "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", @@ -735,7 +735,7 @@ "maxLength": 34, "pattern": "^FO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flex Flow" + "description": "The SID of the Flex Flow." }, "sid": { "type": "string", @@ -743,25 +743,25 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the WebChannel resource" + "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" + "description": "The absolute URL of the WebChannel resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." } } }, diff --git a/spec/json/twilio_flex_v2.json b/spec/json/twilio_flex_v2.json index 214ec10a..e9a318ea 100644 --- a/spec/json/twilio_flex_v2.json +++ b/spec/json/twilio_flex_v2.json @@ -10,12 +10,12 @@ "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string representing the Conversation resource created" + "description": "The unique string representing the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource) created." }, "identity": { "type": "string", "nullable": true, - "description": "The unique string representing the User created" + "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)." } } } diff --git a/spec/json/twilio_frontline_v1.json b/spec/json/twilio_frontline_v1.json index 046269f2..72af52fd 100644 --- a/spec/json/twilio_frontline_v1.json +++ b/spec/json/twilio_frontline_v1.json @@ -10,39 +10,39 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the User resource." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "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." }, "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." }, "avatar": { "type": "string", "nullable": true, - "description": "The avatar URL which will be shown in Frontline application" + "description": "The avatar URL which will be shown in Frontline application." }, "state": { "type": "string", "$ref": "#/components/schemas/user_enum_state_type", "nullable": true, - "description": "Current state of this user" + "description": "Current state of this user. Can be either `active` or `deactivated` and defaults to `active`" }, "is_available": { "type": "boolean", "nullable": true, - "description": "Whether the User is available for new conversations" + "description": "Whether the User is available for new conversations. Defaults to `false` for new users." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "An absolute URL for this user." + "description": "An absolute API resource URL for this user." } } }, diff --git a/spec/json/twilio_insights_v1.json b/spec/json/twilio_insights_v1.json index 5482abb3..ad565237 100644 --- a/spec/json/twilio_insights_v1.json +++ b/spec/json/twilio_insights_v1.json @@ -35,7 +35,7 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Call SID." + "description": "The unique SID identifier of the Call." }, "account_sid": { "type": "string", @@ -43,19 +43,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account SID." + "description": "The unique SID identifier of the Account." }, "answered_by": { "type": "string", "$ref": "#/components/schemas/annotation_enum_answered_by", "nullable": true, - "description": "Indicates the answering entity as determined by Answering Machine Detection." + "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." }, "connectivity_issue": { "type": "string", "$ref": "#/components/schemas/annotation_enum_connectivity_issue", "nullable": true, - "description": "Indicates if the call had any 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." }, "quality_issues": { "type": "array", @@ -63,27 +63,27 @@ "type": "string" }, "nullable": true, - "description": "Indicates if the call had audio quality issues." + "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", "nullable": true, - "description": "Call spam indicator" + "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." }, "call_score": { "type": "integer", "nullable": true, - "description": "Call Score" + "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]." }, "comment": { "type": "string", "nullable": true, - "description": "User comments" + "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." }, "incident": { "type": "string", "nullable": true, - "description": "Call tag for incidents or support ticket" + "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." }, "url": { "type": "string", @@ -325,7 +325,7 @@ "maxLength": 34, "pattern": "^CF[0-9a-fA-F]{32}$", "nullable": true, - "description": "Conference SID." + "description": "The unique SID identifier of the Conference." }, "account_sid": { "type": "string", @@ -333,30 +333,30 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account SID." + "description": "The unique SID identifier of the Account." }, "friendly_name": { "type": "string", "nullable": true, - "description": "Custom label for the conference." + "description": "Custom label for the conference resource, up to 64 characters." }, "create_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "Conference creation date/time." + "description": "Conference creation date and time in ISO 8601 format." }, "start_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "Timestamp in ISO 8601 format when the conference started." + "description": "Timestamp in ISO 8601 format when the conference started. Conferences do not start until at least two participants join, at least one of whom has startConferenceOnEnter=true." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "Conference end date/time." + "description": "Conference end date and time in ISO 8601 format." }, "duration_seconds": { "type": "integer", @@ -366,34 +366,34 @@ "connect_duration_seconds": { "type": "integer", "nullable": true, - "description": "Duration of the conference in seconds." + "description": "Duration of the between conference start event and conference end event in seconds." }, "status": { "type": "string", "$ref": "#/components/schemas/conference_enum_conference_status", "nullable": true, - "description": "Status of conference" + "description": "Status of this Conference; `in_progress`, `not_started`, `completed` or `summary_timeout`. if Twilio don't receive `last_participant_left` event, summary will be timeout after 24 hours" }, "max_participants": { "type": "integer", "nullable": true, - "description": "Max participants specified in config." + "description": "Maximum number of concurrent participants as specified by the configuration." }, "max_concurrent_participants": { "type": "integer", "nullable": true, - "description": "Actual maximum concurrent participants." + "description": "Actual maximum number of concurrent participants in the conference." }, "unique_participants": { "type": "integer", "nullable": true, - "description": "Unique conference participants." + "description": "Unique conference participants based on caller ID." }, "end_reason": { "type": "string", "$ref": "#/components/schemas/conference_enum_conference_end_reason", "nullable": true, - "description": "Conference end reason." + "description": "Conference end reason; e.g. last participant left, modified by API, etc." }, "ended_by": { "type": "string", @@ -401,28 +401,28 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Call SID that ended the conference." + "description": "Call SID of the participant whose actions ended the conference." }, "mixer_region": { "type": "string", "$ref": "#/components/schemas/conference_enum_region", "nullable": true, - "description": "Region where the conference was mixed." + "description": "Twilio region where the conference media was mixed." }, "mixer_region_requested": { "type": "string", "$ref": "#/components/schemas/conference_enum_region", "nullable": true, - "description": "Configuration-requested conference mixer region." + "description": "Twilio region where conference mixed was specified to be mixed in configuration." }, "recording_enabled": { "type": "boolean", "nullable": true, - "description": "Boolean. Indicates whether recording was enabled." + "description": "Boolean. Indicates whether recording was enabled at the conference mixer." }, "detected_issues": { "nullable": true, - "description": "Potential issues detected during the conference." + "description": "Potential issues detected by Twilio during the conference." }, "tags": { "type": "array", @@ -431,17 +431,17 @@ "$ref": "#/components/schemas/conference_enum_tag" }, "nullable": true, - "description": "Tags for detected conference conditions and participant behaviors." + "description": "Tags for detected conference conditions and participant behaviors which may be of interest." }, "tag_info": { "nullable": true, - "description": "Object. Contains details about conference tags." + "description": "Object. Contains details about conference tags including severity." }, "processing_state": { "type": "string", "$ref": "#/components/schemas/conference_enum_processing_state", "nullable": true, - "description": "Processing state for the Conference Summary resource." + "description": "Processing state for the Conference Summary resource. Will be `in_progress` while data is being aggregated, `timeout` if Twilio couldn't process the summary in 24hrs, and `complete` once aggregations and analysis has ended." }, "url": { "type": "string", @@ -453,7 +453,7 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs." + "description": "Contains a dictionary of URL links to nested resources of this Conference." } } }, @@ -534,7 +534,7 @@ "maxLength": 34, "pattern": "^CF[0-9a-fA-F]{32}$", "nullable": true, - "description": "Conference SID." + "description": "The unique SID identifier of the Conference." }, "call_sid": { "type": "string", @@ -542,7 +542,7 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Unique SID identifier of the call." + "description": "Unique SID identifier of the call that generated the Participant resource." }, "account_sid": { "type": "string", @@ -550,13 +550,13 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account SID." + "description": "The unique SID identifier of the Account." }, "call_direction": { "type": "string", "$ref": "#/components/schemas/conference_participant_enum_call_direction", "nullable": true, - "description": "Call direction of the participant." + "description": "Call direction of the participant; inbound or outbound." }, "from": { "type": "string", @@ -577,7 +577,7 @@ "country_code": { "type": "string", "nullable": true, - "description": "ISO alpha-2 country code of the participant." + "description": "ISO alpha-2 country code of the participant based on caller ID or called number." }, "is_moderator": { "type": "boolean", @@ -604,18 +604,18 @@ "outbound_queue_length": { "type": "integer", "nullable": true, - "description": "Estimated time in queue at call creation." + "description": "Add Participant API only. Estimated time in queue at call creation." }, "outbound_time_in_queue": { "type": "integer", "nullable": true, - "description": "Actual time in queue (seconds)." + "description": "Add Participant API only. Actual time in queue in seconds." }, "jitter_buffer_size": { "type": "string", "$ref": "#/components/schemas/conference_participant_enum_jitter_buffer_size", "nullable": true, - "description": "The Jitter Buffer Size of this Conference Participant." + "description": "The Jitter Buffer Size of this Conference Participant. One of `large`, `small`, `medium` or `off`." }, "is_coach": { "type": "boolean", @@ -640,19 +640,19 @@ "type": "string", "$ref": "#/components/schemas/conference_participant_enum_region", "nullable": true, - "description": "The Conference Region of this Conference Participant." + "description": "The Conference Region of this Conference Participant. One of `us1`, `us2`, `au1`, `br1`, `ie1`, `jp1`, `sg1` or `de1`." }, "call_type": { "type": "string", "$ref": "#/components/schemas/conference_participant_enum_call_type", "nullable": true, - "description": "The Call Type of this Conference Participant." + "description": "The Call Type of this Conference Participant. One of `carrier`, `client` or `sip`." }, "processing_state": { "type": "string", "$ref": "#/components/schemas/conference_participant_enum_processing_state", "nullable": true, - "description": "Processing state of the Participant Summary." + "description": "Processing state of the Participant Summary. Will be `in_progress` while data is being aggregated, `timeout` if Twilio couldn't process the summary in 24hrs, and `complete` once aggregations and analysis has ended." }, "properties": { "nullable": true, @@ -660,11 +660,11 @@ }, "events": { "nullable": true, - "description": "Object containing information of actions taken by participants. Nested resource URLs." + "description": "Object containing information of actions taken by participants. Contains a dictionary of URL links to nested resources of this Conference Participant." }, "metrics": { "nullable": true, - "description": "Object. Contains participant quality metrics." + "description": "Object. Contains participant call quality metrics." }, "url": { "type": "string", @@ -1039,7 +1039,7 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "When the participant left the room" + "description": "When the participant left the room." }, "duration_sec": { "type": "integer", @@ -1067,7 +1067,7 @@ "type": "string", "$ref": "#/components/schemas/video_participant_summary_enum_room_status", "nullable": true, - "description": "Status of the room." + "description": "Status of the room. Can be `in_progress` or `completed`." }, "codecs": { "type": "array", @@ -1076,12 +1076,12 @@ "$ref": "#/components/schemas/video_participant_summary_enum_codec" }, "nullable": true, - "description": "Codecs detected from the participant." + "description": "Codecs detected from the participant. Can be `VP8`, `H264`, or `VP9`." }, "end_reason": { "type": "string", "nullable": true, - "description": "Reason the participant left the room." + "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)." }, "error_code": { "type": "integer", @@ -1097,21 +1097,21 @@ "type": "string", "$ref": "#/components/schemas/video_participant_summary_enum_twilio_realm", "nullable": true, - "description": "Twilio media region the participant connected to." + "description": "Twilio media region the participant connected to. See [the list of possible media servers here](https://www.twilio.com/docs/video/ip-addresses)." }, "properties": { "nullable": true, - "description": "Object containing information about the participant's data from the room." + "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." }, "edge_location": { "type": "string", "$ref": "#/components/schemas/video_participant_summary_enum_edge_location", "nullable": true, - "description": "Name of the edge location the participant connected to." + "description": "Name of the edge location the participant connected to. See [the list of public edge locations](https://www.twilio.com/docs/global-infrastructure/edge-locations#public-edge-locations) for the possible values." }, "publisher_info": { "nullable": true, - "description": "Object containing information about the SDK name and version." + "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." }, "url": { "type": "string", @@ -1187,7 +1187,7 @@ "room_name": { "type": "string", "nullable": true, - "description": "room friendly name." + "description": "Room friendly name." }, "create_time": { "type": "string", @@ -1205,13 +1205,13 @@ "type": "string", "$ref": "#/components/schemas/video_room_summary_enum_room_type", "nullable": true, - "description": "Type of room." + "description": "Type of room. Can be `go`, `peer_to_peer`, `group`, or `group_small`." }, "room_status": { "type": "string", "$ref": "#/components/schemas/video_room_summary_enum_room_status", "nullable": true, - "description": "Status of the room." + "description": "Status of the room. Can be `in_progress` or `completed`." }, "status_callback": { "type": "string", @@ -1237,13 +1237,13 @@ "type": "string", "$ref": "#/components/schemas/video_room_summary_enum_created_method", "nullable": true, - "description": "How the room was created." + "description": "How the room was created. Can be `sdk`, `ad_hoc`, or `api`." }, "end_reason": { "type": "string", "$ref": "#/components/schemas/video_room_summary_enum_end_reason", "nullable": true, - "description": "Reason the room ended." + "description": "Reason the room ended. Can be `room_ended_via_api` or `timeout`." }, "max_participants": { "type": "integer", @@ -1277,13 +1277,13 @@ "$ref": "#/components/schemas/video_room_summary_enum_codec" }, "nullable": true, - "description": "Codecs used by participants in the room." + "description": "Codecs used by participants in the room. Can be `VP8`, `H264`, or `VP9`." }, "media_region": { "type": "string", "$ref": "#/components/schemas/video_room_summary_enum_twilio_realm", "nullable": true, - "description": "Region of Twilio media servers for the room." + "description": "Region of Twilio media servers for the room. See [the list of possible media servers here](https://www.twilio.com/docs/video/ip-addresses)." }, "duration_sec": { "type": "integer", @@ -1307,7 +1307,7 @@ "type": "string", "$ref": "#/components/schemas/video_room_summary_enum_processing_state", "nullable": true, - "description": "Video Log Analyzer resource state. Will be either `in-progress` or `complete`." + "description": "Video Log Analyzer resource state. Will be either `in-progress` or `complete`. `in-progress` indicates that more details may be appended to the resource. `complete` indicates no further information will be added." }, "recording_enabled": { "type": "boolean", @@ -1318,7 +1318,7 @@ "type": "string", "$ref": "#/components/schemas/video_room_summary_enum_edge_location", "nullable": true, - "description": "Edge location of Twilio media servers for the room." + "description": "Edge location of Twilio media servers for the room. See [the list of public edge locations](https://www.twilio.com/docs/global-infrastructure/edge-locations#public-edge-locations) for the possible values." }, "url": { "type": "string", diff --git a/spec/json/twilio_lookups_v1.json b/spec/json/twilio_lookups_v1.json index 9db82f27..443863a7 100644 --- a/spec/json/twilio_lookups_v1.json +++ b/spec/json/twilio_lookups_v1.json @@ -6,37 +6,37 @@ "properties": { "caller_name": { "nullable": true, - "description": "The name of the phone number's owner" + "description": "The name of the phone number's owner. If `null`, that information was not available." }, "country_code": { "type": "string", "nullable": true, - "description": "The ISO country code for the phone number" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for the phone number." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "national_format": { "type": "string", "nullable": true, - "description": "The phone number, in national format" + "description": "The phone number, in national format." }, "carrier": { "nullable": true, - "description": "The telecom company that provides the phone number" + "description": "The telecom company that provides the phone number." }, "add_ons": { "nullable": true, - "description": "A JSON string with the results of the Add-ons you specified" + "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)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, diff --git a/spec/json/twilio_lookups_v2.json b/spec/json/twilio_lookups_v2.json index f9cb6a6c..20bd56c4 100644 --- a/spec/json/twilio_lookups_v2.json +++ b/spec/json/twilio_lookups_v2.json @@ -7,28 +7,28 @@ "calling_country_code": { "type": "string", "nullable": true, - "description": "International dialing prefix" + "description": "International dialing prefix of the phone number defined in the E.164 standard." }, "country_code": { "type": "string", "nullable": true, - "description": "Phone number's ISO country code" + "description": "The phone number's [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "Phone number in E.164 format" + "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." }, "national_format": { "type": "string", "nullable": true, - "description": "Phone number in national format" + "description": "The phone number in [national format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers)." }, "valid": { "type": "boolean", "nullable": true, - "description": "Boolean which indicates if the phone number is valid" + "description": "Boolean which indicates if the phone number is in a valid range that can be freely assigned by a carrier to a user." }, "validation_errors": { "type": "array", @@ -37,37 +37,37 @@ "$ref": "#/components/schemas/phone_number_enum_validation_error" }, "nullable": true, - "description": "Contains reasons why a phone number is invalid" + "description": "Contains reasons why a phone number is invalid. Possible values: TOO_SHORT, TOO_LONG, INVALID_BUT_POSSIBLE, INVALID_COUNTRY_CODE, INVALID_LENGTH, NOT_A_NUMBER." }, "caller_name": { "nullable": true, - "description": "An object that contains caller name information" + "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)." }, "sim_swap": { "nullable": true, - "description": "An object that contains SIM swap information" + "description": "An object that contains information on the last date the subscriber identity module (SIM) was changed for a mobile phone number." }, "call_forwarding": { "nullable": true, - "description": "An object that contains call forwarding status information" + "description": "An object that contains information on the unconditional call forwarding status of mobile phone number." }, "live_activity": { "nullable": true, - "description": "An object that contains live activity information" + "description": "An object that contains live activity information for a mobile phone number." }, "line_type_intelligence": { "nullable": true, - "description": "An object that contains line type information" + "description": "An object that contains line type information including the carrier name, mobile country code, and mobile network code." }, "identity_match": { "nullable": true, - "description": "An object that contains identity match information" + "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" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, diff --git a/spec/json/twilio_media_v1.json b/spec/json/twilio_media_v1.json index 76cf7d9c..ba73d39d 100644 --- a/spec/json/twilio_media_v1.json +++ b/spec/json/twilio_media_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the MediaProcessor resource." }, "sid": { "type": "string", @@ -18,52 +18,52 @@ "maxLength": 34, "pattern": "^ZX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string generated to identify the MediaProcessor resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "extension": { "type": "string", "nullable": true, - "description": "The Media Extension name or URL" + "description": "The [Media Extension](/docs/live/api/media-extensions-overview) name or URL. Ex: `video-composer-v2`" }, "extension_context": { "type": "string", "nullable": true, - "description": "The Media Extension context" + "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." }, "status": { "type": "string", "$ref": "#/components/schemas/media_processor_enum_status", "nullable": true, - "description": "The status of the MediaProcessor" + "description": "The status of the MediaProcessor. Can be: `started`, `ended` or `failed`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "ended_reason": { "type": "string", "nullable": true, - "description": "The reason why a MediaProcessor ended" + "description": "The reason why a MediaProcessor ended. When a MediaProcessor is in progress, will be `null`. When a MediaProcessor is completed, can be `ended-via-api`, `max-duration-exceeded`, `error-loading-extension`, `error-streaming-media` or `internal-service-error`. See [ended reasons](/docs/live/api/mediaprocessors#mediaprocessor-ended-reason-values) for more details." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to which Twilio will send MediaProcessor event updates" + "description": "The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) for details." }, "status_callback_method": { "type": "string", @@ -77,12 +77,12 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method Twilio should use to call the `status_callback` URL" + "description": "The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`." }, "max_duration": { "type": "integer", "nullable": true, - "description": "Maximum MediaProcessor duration in seconds" + "description": "The maximum time, in seconds, that the MediaProcessor can run 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 MediaProcessor, regardless of whether media is still streaming." } } }, @@ -116,36 +116,36 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the MediaRecording resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "duration": { "type": "integer", "nullable": true, - "description": "The duration of the MediaRecording" + "description": "The duration of the MediaRecording in seconds." }, "format": { "type": "string", "$ref": "#/components/schemas/media_recording_enum_format", "nullable": true, - "description": "The format of the MediaRecording" + "description": "The format of the MediaRecording, either `mp4` or `webm`." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." }, "processor_sid": { "type": "string", @@ -153,12 +153,12 @@ "maxLength": 34, "pattern": "^ZX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the MediaProcessor" + "description": "The SID of the MediaProcessor resource which produced the MediaRecording." }, "resolution": { "type": "string", "nullable": true, - "description": "The dimensions of the video image in pixels" + "description": "The dimensions of the video image in pixels expressed as columns (width) and rows (height)." }, "source_sid": { "type": "string", @@ -166,7 +166,7 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource that generated the original media" + "description": "The SID of the resource that generated the original media track(s) of the MediaRecording." }, "sid": { "type": "string", @@ -174,25 +174,25 @@ "maxLength": 34, "pattern": "^KV[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string generated to identify the MediaRecording resource." }, "media_size": { "type": "integer", "format": "int64", "nullable": true, - "description": "The size of the recording media" + "description": "The size of the recording media in bytes." }, "status": { "type": "string", "$ref": "#/components/schemas/media_recording_enum_status", "nullable": true, - "description": "The status of the MediaRecording" + "description": "The status of the MediaRecording. Can be: `processing`, `completed`, `deleted`, or `failed`." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to which Twilio will send MediaRecording event updates" + "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." }, "status_callback_method": { "type": "string", @@ -206,13 +206,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method Twilio should use to call the `status_callback` URL" + "description": "The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -248,30 +248,30 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the PlayerStreamer resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "video": { "type": "boolean", "nullable": true, - "description": "Whether the PlayerStreamer is configured to stream video" + "description": "Specifies whether the PlayerStreamer is configured to stream video. Defaults to `true`." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." }, "sid": { "type": "string", @@ -279,25 +279,25 @@ "maxLength": 34, "pattern": "^VJ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string generated to identify the PlayerStreamer resource." }, "status": { "type": "string", "$ref": "#/components/schemas/player_streamer_enum_status", "nullable": true, - "description": "The status of the PlayerStreamer" + "description": "The status of the PlayerStreamer. Can be: `created`, `started`, `ended`, or `failed`. See [status](/docs/live/api/playerstreamers#status) for more information." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to which Twilio will send PlayerStreamer event updates" + "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." }, "status_callback_method": { "type": "string", @@ -311,18 +311,18 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method Twilio should use to call the `status_callback` URL" + "description": "The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`." }, "ended_reason": { "type": "string", "$ref": "#/components/schemas/player_streamer_enum_ended_reason", "nullable": true, - "description": "The reason why a PlayerStreamer ended" + "description": "The reason why a PlayerStreamer ended. When a PlayerStreamer is in progress, will be `null`. When a PlayerStreamer is completed, can be `ended-via-api`, `max-duration-exceeded`, `stream-disconnected-by-source` or `unexpected-failure`. See [ended reasons](/docs/live/api/playerstreamers#ended-reason) for more details." }, "max_duration": { "type": "integer", "nullable": true, - "description": "Maximum PlayerStreamer duration in seconds" + "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." } } }, @@ -366,13 +366,13 @@ "maxLength": 34, "pattern": "^VJ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the PlayerStreamer associated with this PlaybackGrant." + "description": "The unique string generated to identify the PlayerStreamer resource that this PlaybackGrant authorizes views for." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "account_sid": { "type": "string", @@ -380,13 +380,13 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "grant": { "nullable": true, diff --git a/spec/json/twilio_messaging_v1.json b/spec/json/twilio_messaging_v1.json index 4f0bceb8..7349b543 100644 --- a/spec/json/twilio_messaging_v1.json +++ b/spec/json/twilio_messaging_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^AI[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the AlphaSender resource." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AlphaSender resource." }, "service_sid": { "type": "string", @@ -26,24 +26,24 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource is associated with." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "alpha_sender": { "type": "string", "nullable": true, - "description": "The Alphanumeric Sender ID string" + "description": "The Alphanumeric Sender ID string." }, "capabilities": { "type": "array", @@ -51,13 +51,13 @@ "type": "string" }, "nullable": true, - "description": "An array of values that describe whether the number can receive calls or messages" + "description": "An array of values that describe whether the number can receive calls or messages. Can be: `SMS`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the AlphaSender resource" + "description": "The absolute URL of the AlphaSender resource." } } }, @@ -70,7 +70,7 @@ "maxLength": 34, "pattern": "^BN[0-9a-fA-F]{32}$", "nullable": true, - "description": "A2P BrandRegistration Sid" + "description": "The unique string to identify Brand Registration." }, "account_sid": { "type": "string", @@ -78,7 +78,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Brand Registration resource." }, "customer_profile_bundle_sid": { "type": "string", @@ -86,7 +86,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "A2P Messaging Profile Bundle BundleSid" + "description": "A2P Messaging Profile Bundle BundleSid." }, "a2p_profile_bundle_sid": { "type": "string", @@ -94,51 +94,51 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "A2P Messaging Profile Bundle BundleSid" + "description": "A2P Messaging Profile Bundle BundleSid." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "brand_type": { "type": "string", "nullable": true, - "description": "Type of brand. One of: \"STANDARD\", \"STARTER\"." + "description": "Type of brand. One of: \"STANDARD\", \"STARTER\". STARTER is for the low volume, STARTER campaign use case. There can only be one STARTER campaign created per STARTER brand. STANDARD is for all other campaign use cases. Multiple campaign use cases can be created per STANDARD brand." }, "status": { "type": "string", "$ref": "#/components/schemas/brand_registrations_enum_status", "nullable": true, - "description": "Brand Registration status." + "description": "Brand Registration status. One of \"PENDING\", \"APPROVED\", \"FAILED\", \"IN_REVIEW\", \"DELETED\"." }, "tcr_id": { "type": "string", "nullable": true, - "description": "Campaign Registry (TCR) Brand ID" + "description": "Campaign Registry (TCR) Brand ID. Assigned only after successful brand registration." }, "failure_reason": { "type": "string", "nullable": true, - "description": "A reason why brand registration has failed" + "description": "A reason why brand registration has failed. Only applicable when status is FAILED." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Brand Registration" + "description": "The absolute URL of the Brand Registration resource." }, "brand_score": { "type": "integer", "nullable": true, - "description": "Brand score" + "description": "The secondary vetting score if it was done. Otherwise, it will be the brand score if it's returned from TCR. It may be null if no score is available." }, "brand_feedback": { "type": "array", @@ -147,33 +147,33 @@ "$ref": "#/components/schemas/brand_registrations_enum_brand_feedback" }, "nullable": true, - "description": "Brand feedback" + "description": "Feedback on how to improve brand score" }, "identity_status": { "type": "string", "$ref": "#/components/schemas/brand_registrations_enum_identity_status", "nullable": true, - "description": "Identity Status" + "description": "When a brand is registered, TCR will attempt to verify the identity of the brand based on the supplied information." }, "russell_3000": { "type": "boolean", "nullable": true, - "description": "Russell 3000" + "description": "Publicly traded company identified in the Russell 3000 Index" }, "government_entity": { "type": "boolean", "nullable": true, - "description": "Government Entity" + "description": "Identified as a government entity" }, "tax_exempt_status": { "type": "string", "nullable": true, - "description": "Tax Exempt Status" + "description": "Nonprofit organization tax-exempt status per section 501 of the U.S. tax code." }, "skip_automatic_sec_vet": { "type": "boolean", "nullable": true, - "description": "Skip Automatic Secondary Vetting" + "description": "A flag to disable automatic secondary vetting for brands which it would otherwise be done." }, "mock": { "type": "boolean", @@ -225,7 +225,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the vetting" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the vetting record." }, "brand_sid": { "type": "string", @@ -233,7 +233,7 @@ "maxLength": 34, "pattern": "^BN[0-9a-fA-F]{32}$", "nullable": true, - "description": "A2P BrandRegistration Sid" + "description": "The unique string to identify Brand Registration." }, "brand_vetting_sid": { "type": "string", @@ -241,46 +241,46 @@ "maxLength": 34, "pattern": "^VT[0-9a-fA-F]{32}$", "nullable": true, - "description": "SID for third-party vetting record" + "description": "The Twilio SID of the third-party vetting record." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "vetting_id": { "type": "string", "nullable": true, - "description": "The unique ID of the vetting" + "description": "The unique identifier of the vetting from the third-party provider." }, "vetting_class": { "type": "string", "nullable": true, - "description": "The type of vetting" + "description": "The type of vetting that has been conducted. One of \u201cSTANDARD\u201d (Aegis) or \u201cPOLITICAL\u201d (Campaign Verify)." }, "vetting_status": { "type": "string", "nullable": true, - "description": "Status of vetting attempt" + "description": "The status of the import vetting attempt. One of \u201cPENDING,\u201d \u201cSUCCESS,\u201d or \u201cFAILED\u201d." }, "vetting_provider": { "type": "string", "$ref": "#/components/schemas/brand_vetting_enum_vetting_provider", "nullable": true, - "description": "Third-party provider that has conducted the vetting" + "description": "The third-party provider that has conducted the vetting. One of \u201cCampaignVerify\u201d (Campaign Verify tokens) or \u201cAEGIS\u201d (Secondary Vetting)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Brand Vetting" + "description": "The absolute URL of the Brand Vetting resource." } } }, @@ -297,7 +297,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "Redirect url to the list of deactivated numbers." + "description": "Returns an authenticated url that redirects to a file containing the deactivated numbers for the requested day. This url is valid for up to two minutes." } } }, @@ -322,13 +322,13 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "Expiration date for your private certificate." + "description": "Date that the private certificate associated with this domain expires. You will need to update the certificate before that date to ensure your shortened links will continue to work." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "Date this Domain SID was created." + "description": "Date that this Domain was registered to the Twilio platform to create a new Domain object." }, "domain_name": { "type": "string", @@ -352,7 +352,7 @@ "validated": { "type": "boolean", "nullable": true, - "description": "Certificate validation field" + "description": "Boolean value indicating whether certificate has been validated" } } }, @@ -390,7 +390,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "We will redirect requests to urls we are unable to identify to this url." + "description": "Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping." }, "callback_url": { "type": "string", @@ -426,7 +426,7 @@ "maxLength": 34, "pattern": "^QE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies a US A2P Compliance resource" + "description": "The unique string that identifies a US A2P Compliance resource `QE2c6890da8086d771620e9b13fadeba0b`." }, "account_sid": { "type": "string", @@ -434,7 +434,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Campaign belongs to." }, "campaign_id": { "type": "string", @@ -447,13 +447,13 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Messaging Service the resource is associated with" + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) that the resource is associated with." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." } } }, @@ -466,7 +466,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the PhoneNumber resource." }, "account_sid": { "type": "string", @@ -474,7 +474,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the PhoneNumber resource." }, "service_sid": { "type": "string", @@ -482,30 +482,30 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource is associated with." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "country_code": { "type": "string", "nullable": true, - "description": "The 2-character ISO Country Code of the number" + "description": "The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) of the number." }, "capabilities": { "type": "array", @@ -513,13 +513,13 @@ "type": "string" }, "nullable": true, - "description": "An array of values that describe whether the number can receive calls or messages" + "description": "An array of values that describe whether the number can receive calls or messages. Can be: `Voice`, `SMS`, and `MMS`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the PhoneNumber resource" + "description": "The absolute URL of the PhoneNumber resource." } } }, @@ -532,7 +532,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Service resource." }, "account_sid": { "type": "string", @@ -540,30 +540,30 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource." }, "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "inbound_request_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using inbound_method when a message is received by any phone number or short code in the Service. This field will be overridden if the `use_inbound_webhook_on_number` field is enabled." + "description": "The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service." }, "inbound_method": { "type": "string", @@ -577,13 +577,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call inbound_request_url" + "description": "The HTTP method we use to call `inbound_request_url`. Can be `GET` or `POST`." }, "fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call using fallback_method if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. This field will be overridden if the `use_inbound_webhook_on_number` field is enabled." + "description": "The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service." }, "fallback_method": { "type": "string", @@ -597,71 +597,71 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call fallback_url" + "description": "The HTTP method we use to call `fallback_url`. Can be: `GET` or `POST`." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call to pass status updates about message delivery" + "description": "The URL we call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery." }, "sticky_sender": { "type": "boolean", "nullable": true, - "description": "Whether to enable Sticky Sender on the Service instance" + "description": "Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance." }, "mms_converter": { "type": "boolean", "nullable": true, - "description": "Whether to enable the MMS Converter for messages sent through the Service instance" + "description": "Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance." }, "smart_encoding": { "type": "boolean", "nullable": true, - "description": "Whether to enable Encoding for messages sent through the Service instance" + "description": "Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance." }, "scan_message_content": { "type": "string", "$ref": "#/components/schemas/service_enum_scan_message_content", "nullable": true, - "description": "Reserved" + "description": "Reserved." }, "fallback_to_long_code": { "type": "boolean", "nullable": true, - "description": "Whether to enable Fallback to Long Code for messages sent through the Service instance" + "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." }, "area_code_geomatch": { "type": "boolean", "nullable": true, - "description": "Whether to enable Area Code Geomatch on the Service Instance" + "description": "Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance." }, "synchronous_validation": { "type": "boolean", "nullable": true, - "description": "Reserved" + "description": "Reserved." }, "validity_period": { "type": "integer", "nullable": true, - "description": "How long, in seconds, messages sent from the Service are valid" + "description": "How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Service resource" + "description": "The absolute URL of the Service resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The absolute URLs of related resources" + "description": "The absolute URLs of related resources." }, "usecase": { "type": "string", "nullable": true, - "description": "A string describing the scenario in which the Messaging Service will be used" + "description": "A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]" }, "us_app_to_person_registered": { "type": "boolean", @@ -671,7 +671,7 @@ "use_inbound_webhook_on_number": { "type": "boolean", "nullable": true, - "description": "If enabled, the webhook url configured on the phone number will be used and will override the `inbound_request_url`/`fallback_url` url called when an inbound message is received." + "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." } } }, @@ -692,7 +692,7 @@ "maxLength": 34, "pattern": "^SC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the ShortCode resource." }, "account_sid": { "type": "string", @@ -700,7 +700,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode resource." }, "service_sid": { "type": "string", @@ -708,29 +708,29 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource is associated with." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "short_code": { "type": "string", "nullable": true, - "description": "The E.164 format of the short code" + "description": "The [E.164](https://www.twilio.com/docs/glossary/what-e164) format of the short code." }, "country_code": { "type": "string", "nullable": true, - "description": "The 2-character ISO Country Code of the number" + "description": "The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) of the number." }, "capabilities": { "type": "array", @@ -738,13 +738,13 @@ "type": "string" }, "nullable": true, - "description": "An array of values that describe whether the number can receive calls or messages" + "description": "An array of values that describe whether the number can receive calls or messages. Can be: `SMS` and `MMS`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the ShortCode resource" + "description": "The absolute URL of the ShortCode resource." } } }, @@ -757,7 +757,7 @@ "maxLength": 34, "pattern": "^HH[0-9a-fA-F]{32}$", "nullable": true, - "description": "Tollfree Verification Sid" + "description": "The unique string to identify Tollfree Verification." }, "account_sid": { "type": "string", @@ -765,7 +765,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "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", @@ -773,7 +773,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "Customer's Profile Bundle BundleSid" + "description": "Customer's Profile Bundle BundleSid." }, "trust_product_sid": { "type": "string", @@ -781,19 +781,19 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "Tollfree TrustProduct Bundle BundleSid" + "description": "Tollfree TrustProduct Bundle BundleSid." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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", @@ -801,73 +801,73 @@ "maxLength": 34, "pattern": "^RA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Regulated Item" + "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" + "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" + "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" + "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" + "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" + "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" + "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" + "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" + "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" + "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" + "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" + "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 phone number of the contact for the business or organization using the Tollfree number" + "description": "The 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. " + "description": "The email address to receive the notification about the verification result. ." }, "use_case_categories": { "type": "array", @@ -875,17 +875,17 @@ "type": "string" }, "nullable": true, - "description": "The category of the use case for the Tollfree Number. List as many are applicable." + "description": "The category of the use case for the Tollfree Number. List as many are applicable.." }, "use_case_summary": { "type": "string", "nullable": true, - "description": "Further explaination on how messaging is used by the business or organization" + "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" + "description": "An example of message content, i.e. a sample message." }, "opt_in_image_urls": { "type": "array", @@ -893,23 +893,23 @@ "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" + "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" + "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" + "description": "Estimate monthly volume of messages from the Tollfree Number." }, "additional_information": { "type": "string", "nullable": true, - "description": "Additional information to be provided for verification" + "description": "Additional information to be provided for verification." }, "tollfree_phone_number_sid": { "type": "string", @@ -917,7 +917,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Phone Number associated with the Tollfree Verification" + "description": "The SID of the Phone Number associated with the Tollfree Verification." }, "status": { "type": "string", @@ -929,11 +929,11 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Tollfree Verification" + "description": "The absolute URL of the Tollfree Verification resource." }, "resource_links": { "nullable": true, - "description": "The URLs of the documents associated with the Tollfree Verification resource" + "description": "The URLs of the documents associated with the Tollfree Verification resource." } } }, @@ -965,7 +965,7 @@ "maxLength": 34, "pattern": "^QE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies a US A2P Compliance resource" + "description": "The unique string that identifies a US A2P Compliance resource `QE2c6890da8086d771620e9b13fadeba0b`." }, "account_sid": { "type": "string", @@ -973,7 +973,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Campaign belongs to." }, "brand_registration_sid": { "type": "string", @@ -981,7 +981,7 @@ "maxLength": 34, "pattern": "^BN[0-9a-fA-F]{32}$", "nullable": true, - "description": "A2P Brand Registration SID" + "description": "The unique string to identify the A2P brand." }, "messaging_service_sid": { "type": "string", @@ -989,12 +989,12 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Messaging Service the resource is associated with" + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) that the resource is associated with." }, "description": { "type": "string", "nullable": true, - "description": "A short description of what this SMS campaign does" + "description": "A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters." }, "message_samples": { "type": "array", @@ -1002,27 +1002,27 @@ "type": "string" }, "nullable": true, - "description": "Message samples" + "description": "Message samples, at least 1 and up to 5 sample messages (at least 2 for starter/sole proprietor), >=20 chars, <=1024 chars each." }, "us_app_to_person_usecase": { "type": "string", "nullable": true, - "description": "A2P Campaign Use Case." + "description": "A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING, STARTER...]. STARTER campaign use cases can only be created by STARTER Brands, and there can only be one STARTER campaign created per STARTER Brand." }, "has_embedded_links": { "type": "boolean", "nullable": true, - "description": "Indicate that this SMS campaign will send messages that contain links" + "description": "Indicate that this SMS campaign will send messages that contain links." }, "has_embedded_phone": { "type": "boolean", "nullable": true, - "description": "Indicates that this SMS campaign will send messages that contain phone numbers" + "description": "Indicates that this SMS campaign will send messages that contain phone numbers." }, "campaign_status": { "type": "string", "nullable": true, - "description": "Campaign status" + "description": "Campaign status. Examples: IN_PROGRESS, VERIFIED, FAILED." }, "campaign_id": { "type": "string", @@ -1032,31 +1032,31 @@ "is_externally_registered": { "type": "boolean", "nullable": true, - "description": "Indicates whether the campaign was registered externally or not" + "description": "Indicates whether the campaign was registered externally or not." }, "rate_limits": { "nullable": true, - "description": "Rate limit and/or classification set by each carrier" + "description": "Rate limit and/or classification set by each carrier, Ex. AT&T or T-Mobile." }, "message_flow": { "type": "string", "nullable": true, - "description": "Consumer opt-in flow" + "description": "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." }, "opt_in_message": { "type": "string", "nullable": true, - "description": "Opt In Message" + "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." }, "opt_out_message": { "type": "string", "nullable": true, - "description": "Opt Out Message" + "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." }, "help_message": { "type": "string", "nullable": true, - "description": "Help Message" + "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." }, "opt_in_keywords": { "type": "array", @@ -1064,7 +1064,7 @@ "type": "string" }, "nullable": true, - "description": "Opt In Keywords" + "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." }, "opt_out_keywords": { "type": "array", @@ -1072,7 +1072,7 @@ "type": "string" }, "nullable": true, - "description": "Opt Out Keywords" + "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." }, "help_keywords": { "type": "array", @@ -1080,30 +1080,30 @@ "type": "string" }, "nullable": true, - "description": "Help Keywords" + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 US App to Person resource" + "description": "The absolute URL of the US App to Person resource." }, "mock": { "type": "boolean", "nullable": true, - "description": "A boolean that specifies whether campaign is a mock or not." + "description": "A boolean that specifies whether campaign is a mock or not. Mock campaigns will be automatically created if using a mock brand. Mock campaigns should only be used for testing purposes." } } }, @@ -1114,7 +1114,7 @@ "type": "array", "items": {}, "nullable": true, - "description": "Human readable A2P Use Case details" + "description": "Human readable name, code, description and post_approval_required (indicates whether or not post approval is required for this Use Case) of A2P Campaign Use Cases." } } }, @@ -1125,7 +1125,7 @@ "type": "array", "items": {}, "nullable": true, - "description": "Human readable Messaging Service Use Case details" + "description": "Human readable use case details (usecase, description and purpose) of Messaging Service Use Cases." } } } diff --git a/spec/json/twilio_microvisor_v1.json b/spec/json/twilio_microvisor_v1.json index 143016ba..ca2c35a9 100644 --- a/spec/json/twilio_microvisor_v1.json +++ b/spec/json/twilio_microvisor_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^KA[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this App." + "description": "A 34-character string that uniquely identifies this App." }, "account_sid": { "type": "string", @@ -18,29 +18,29 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The Account SID." + "description": "The unique SID identifier of the Account." }, "hash": { "type": "string", "nullable": true, - "description": "App manifest hash represented as hash_algorithm:hash_value." + "description": "App manifest hash represented as `hash_algorithm:hash_value`." }, "unique_name": { "type": "string", "nullable": true, - "description": "An developer-defined string that uniquely identifies the App." + "description": "A developer-defined string that uniquely identifies the App. This value must be unique for all Apps on this Account. The `unique_name` value may be used as an alternative to the `sid` in the URL path to address the resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this App was created." + "description": "The date that this App was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this App was last updated." + "description": "The date that this App was last updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", @@ -59,12 +59,12 @@ "maxLength": 34, "pattern": "^UV[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Device." + "description": "A 34-character string that uniquely identifies this Device." }, "unique_name": { "type": "string", "nullable": true, - "description": "A developer-defined string that uniquely identifies the Device." + "description": "A developer-defined string that uniquely identifies the Device. This value must be unique for all Devices on this Account. The `unique_name` value may be used as an alternative to the `sid` in the URL path to address the resource." }, "account_sid": { "type": "string", @@ -72,27 +72,27 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account SID." + "description": "The unique SID identifier of the Account." }, "app": { "nullable": true, - "description": "Information about the target App and the App reported by this Device." + "description": "Information about the target App and the App reported by this Device. Contains the properties `target_sid`, `date_targeted`, `update_status` (one of `up-to-date`, `pending` and `error`), `update_error_code`, `reported_sid` and `date_reported`." }, "logging": { "nullable": true, - "description": "Object specifying whether application logging is enabled for this Device." + "description": "Object specifying whether application logging is enabled for this Device. Contains the properties `enabled` and `date_expires`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this Device was created." + "description": "The date that this Device was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this Device was last updated." + "description": "The date that this Device was last updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", @@ -104,7 +104,7 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "The absolute URLs of related resources" + "description": "The absolute URLs of related resources." } } } diff --git a/spec/json/twilio_monitor_v1.json b/spec/json/twilio_monitor_v1.json index fdb8d0fa..7090ea36 100644 --- a/spec/json/twilio_monitor_v1.json +++ b/spec/json/twilio_monitor_v1.json @@ -10,50 +10,50 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Alert resource." }, "alert_text": { "type": "string", "nullable": true, - "description": "The text of the alert" + "description": "The text of the alert." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used when the alert was generated" + "description": "The API version used when the alert was generated. Can be empty for events that don't have a specific API version." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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_generated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date and time when the alert was generated specified in ISO 8601 format" + "description": "The date and time in GMT when the alert was generated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. Due to buffering, this can be different than `date_created`." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "error_code": { "type": "string", "nullable": true, - "description": "The error code for the condition that generated the alert" + "description": "The error code for the condition that generated the alert. See the [Error Dictionary](https://www.twilio.com/docs/api/errors) for possible causes and solutions to the error." }, "log_level": { "type": "string", "nullable": true, - "description": "The log level" + "description": "The log level. Can be: `error`, `warning`, `notice`, or `debug`." }, "more_info": { "type": "string", "nullable": true, - "description": "The URL of the page in our Error Dictionary with more information about the error condition" + "description": "The URL of the page in our [Error Dictionary](https://www.twilio.com/docs/api/errors) with more information about the error condition." }, "request_method": { "type": "string", @@ -67,12 +67,12 @@ "DELETE" ], "nullable": true, - "description": "The method used by the request that generated the alert" + "description": "The method used by the request that generated the alert. If the alert was generated by a request we made to your server, this is the method we used. If the alert was generated by a request from your application to our API, this is the method your application used." }, "request_url": { "type": "string", "nullable": true, - "description": "The URL of the request that generated the alert" + "description": "The URL of the request that generated the alert. If the alert was generated by a request we made to your server, this is the URL on your server that generated the alert. If the alert was generated by a request from your application to our API, this is the URL of the resource requested." }, "resource_sid": { "type": "string", @@ -80,7 +80,7 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource for which the alert was generated" + "description": "The SID of the resource for which the alert was generated. For instance, if your server failed to respond to an HTTP request during the flow of a particular call, this value would be the SID of the server. This value is empty if the alert was not generated for a particular resource." }, "sid": { "type": "string", @@ -88,13 +88,13 @@ "maxLength": 34, "pattern": "^NO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Alert resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Alert resource" + "description": "The absolute URL of the Alert resource." }, "service_sid": { "type": "string", @@ -102,7 +102,7 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the service or resource that generated the alert" + "description": "The SID of the service or resource that generated the alert. Can be `null`." } } }, @@ -115,50 +115,50 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Alert resource." }, "alert_text": { "type": "string", "nullable": true, - "description": "The text of the alert" + "description": "The text of the alert." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used when the alert was generated" + "description": "The API version used when the alert was generated. Can be empty for events that don't have a specific API version." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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_generated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date and time when the alert was generated specified in ISO 8601 format" + "description": "The date and time in GMT when the alert was generated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. Due to buffering, this can be different than `date_created`." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "error_code": { "type": "string", "nullable": true, - "description": "The error code for the condition that generated the alert" + "description": "The error code for the condition that generated the alert. See the [Error Dictionary](https://www.twilio.com/docs/api/errors) for possible causes and solutions to the error." }, "log_level": { "type": "string", "nullable": true, - "description": "The log level" + "description": "The log level. Can be: `error`, `warning`, `notice`, or `debug`." }, "more_info": { "type": "string", "nullable": true, - "description": "The URL of the page in our Error Dictionary with more information about the error condition" + "description": "The URL of the page in our [Error Dictionary](https://www.twilio.com/docs/api/errors) with more information about the error condition." }, "request_method": { "type": "string", @@ -172,17 +172,17 @@ "DELETE" ], "nullable": true, - "description": "The method used by the request that generated the alert" + "description": "The method used by the request that generated the alert. If the alert was generated by a request we made to your server, this is the method we used. If the alert was generated by a request from your application to our API, this is the method your application used." }, "request_url": { "type": "string", "nullable": true, - "description": "The URL of the request that generated the alert" + "description": "The URL of the request that generated the alert. If the alert was generated by a request we made to your server, this is the URL on your server that generated the alert. If the alert was generated by a request from your application to our API, this is the URL of the resource requested." }, "request_variables": { "type": "string", "nullable": true, - "description": "The variables passed in the request that generated the alert" + "description": "The variables passed in the request that generated the alert. This value is only returned when a single Alert resource is fetched." }, "resource_sid": { "type": "string", @@ -190,17 +190,17 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource for which the alert was generated" + "description": "The SID of the resource for which the alert was generated. For instance, if your server failed to respond to an HTTP request during the flow of a particular call, this value would be the SID of the server. This value is empty if the alert was not generated for a particular resource." }, "response_body": { "type": "string", "nullable": true, - "description": "The response body of the request that generated the alert" + "description": "The response body of the request that generated the alert. This value is only returned when a single Alert resource is fetched." }, "response_headers": { "type": "string", "nullable": true, - "description": "The response headers of the request that generated the alert" + "description": "The response headers of the request that generated the alert. This value is only returned when a single Alert resource is fetched." }, "sid": { "type": "string", @@ -208,18 +208,18 @@ "maxLength": 34, "pattern": "^NO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Alert resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Alert resource" + "description": "The absolute URL of the Alert resource." }, "request_headers": { "type": "string", "nullable": true, - "description": "The request headers of the request that generated the alert" + "description": "The request headers of the request that generated the alert. This value is only returned when a single Alert resource is fetched." }, "service_sid": { "type": "string", @@ -227,7 +227,7 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the service or resource that generated the alert" + "description": "The SID of the service or resource that generated the alert. Can be `null`." } } }, @@ -240,7 +240,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Event resource." }, "actor_sid": { "type": "string", @@ -248,32 +248,32 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the actor that caused the event, if available" + "description": "The SID of the actor that caused the event, if available. Can be `null`." }, "actor_type": { "type": "string", "nullable": true, - "description": "The type of actor that caused the event" + "description": "The type of actor that caused the event. Can be: `user` for a change made by a logged-in user in the Twilio Console, `account` for an event caused by an API request by an authenticating Account, `twilio-admin` for an event caused by a Twilio employee, and so on." }, "description": { "type": "string", "nullable": true, - "description": "A description of the event" + "description": "A description of the event. Can be `null`." }, "event_data": { "nullable": true, - "description": "A JSON string that represents an object with additional data about the event" + "description": "An object with additional data about the event. The contents depend on `event_type`. For example, event-types of the form `RESOURCE.updated`, this value contains a `resource_properties` dictionary that describes the previous and updated properties of the resource." }, "event_date": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the event was recorded" + "description": "The date and time in GMT when the event was recorded specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "event_type": { "type": "string", "nullable": true, - "description": "The event's type" + "description": "The event's type. Event-types are typically in the form: `RESOURCE_TYPE.ACTION`, where `RESOURCE_TYPE` is the type of resource that was affected and `ACTION` is what happened to it. For example, `phone-number.created`. For a full list of all event-types, see the [Monitor Event Types](https://www.twilio.com/docs/usage/monitor-events#event-types)." }, "resource_sid": { "type": "string", @@ -281,12 +281,12 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource that was affected" + "description": "The SID of the resource that was affected." }, "resource_type": { "type": "string", "nullable": true, - "description": "The type of resource that was affected" + "description": "The type of resource that was affected. For a full list of all resource-types, see the [Monitor Event Types](https://www.twilio.com/docs/usage/monitor-events#event-types)." }, "sid": { "type": "string", @@ -294,29 +294,29 @@ "maxLength": 34, "pattern": "^AE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Event resource." }, "source": { "type": "string", "nullable": true, - "description": "The originating system or interface that caused the event" + "description": "The originating system or interface that caused the event. Can be: `web` for events caused by user action in the Twilio Console, `api` for events caused by a request to our API, or `twilio` for events caused by an automated or internal Twilio system." }, "source_ip_address": { "type": "string", "nullable": true, - "description": "The IP address of the source" + "description": "The IP address of the source, if the source is outside the Twilio cloud. This value is `null` for events with `source` of `twilio`" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource that was affected" + "description": "The absolute URL of the resource that was affected. Can be `null`." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The absolute URLs of related resources" + "description": "The absolute URLs of related resources." } } } diff --git a/spec/json/twilio_notify_v1.json b/spec/json/twilio_notify_v1.json index 466f84fb..4ad7ede9 100644 --- a/spec/json/twilio_notify_v1.json +++ b/spec/json/twilio_notify_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^BS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Binding resource." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Binding resource." }, "service_sid": { "type": "string", @@ -26,7 +26,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource is associated with." }, "credential_sid": { "type": "string", @@ -34,44 +34,44 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Credential resource to be used to send notifications to this Binding" + "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applicable only to `apn`, `fcm`, and `gcm` type Bindings." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "notification_protocol_version": { "type": "string", "nullable": true, - "description": "The protocol version to use to send the notification" + "description": "The protocol version to use to send the notification. This defaults to the value of `default_xxxx_notification_protocol_version` in the [Service](https://www.twilio.com/docs/notify/api/service-resource) for the protocol. The current version is `\"3\"` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not applicable to `sms` and `facebook-messenger` type Bindings as the data format is fixed." }, "endpoint": { "type": "string", "nullable": true, - "description": "Deprecated" + "description": "Deprecated." }, "identity": { "type": "string", "nullable": true, - "description": "The `identity` value that identifies the new resource's User" + "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." }, "binding_type": { "type": "string", "nullable": true, - "description": "The type of the Binding" + "description": "The transport technology to use for the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`." }, "address": { "type": "string", "nullable": true, - "description": "The channel-specific address" + "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." }, "tags": { "type": "array", @@ -79,19 +79,19 @@ "type": "string" }, "nullable": true, - "description": "The list of tags associated with this Binding" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Binding resource" + "description": "The absolute URL of the Binding resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -115,7 +115,7 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Credential resource." }, "account_sid": { "type": "string", @@ -123,41 +123,41 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Credential resource." }, "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." }, "type": { "type": "string", "$ref": "#/components/schemas/credential_enum_push_service", "nullable": true, - "description": "The Credential type, one of `gcm`, `fcm`, or `apn`" + "description": "The Credential type. Can be: `gcm`, `fcm`, or `apn`." }, "sandbox": { "type": "string", "nullable": true, - "description": "[APN only] Whether to send the credential to sandbox APNs" + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Credential resource" + "description": "The absolute URL of the Credential resource." } } }, @@ -178,7 +178,7 @@ "maxLength": 34, "pattern": "^NT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Notification resource." }, "account_sid": { "type": "string", @@ -186,7 +186,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resource." }, "service_sid": { "type": "string", @@ -194,13 +194,13 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource is associated with." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." }, "identities": { "type": "array", @@ -208,7 +208,7 @@ "type": "string" }, "nullable": true, - "description": "The list of identity values of the Users to notify" + "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." }, "tags": { "type": "array", @@ -216,7 +216,7 @@ "type": "string" }, "nullable": true, - "description": "The tags that select the Bindings to notify" + "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." }, "segments": { "type": "array", @@ -224,66 +224,66 @@ "type": "string" }, "nullable": true, - "description": "The list of Segments to notify" + "description": "The list of Segments to notify. The [Segment](https://www.twilio.com/docs/notify/api/segment-resource) resource is deprecated. Use the `tags` property, instead." }, "priority": { "type": "string", "$ref": "#/components/schemas/notification_enum_priority", "nullable": true, - "description": "The priority of the notification" + "description": "The priority of the notification. Can be: `low` or `high` and the default is `high`. A value of `low` optimizes the client app's battery consumption; however, notifications may be delivered with unspecified delay. For FCM and GCM, `low` priority is the same as `Normal` priority. For APNS `low` priority is the same as `5`. A value of `high` sends the notification immediately, and can wake up a sleeping device. For FCM and GCM, `high` is the same as `High` priority. For APNS, `high` is a priority `10`. SMS does not support this property." }, "ttl": { "type": "integer", "nullable": true, - "description": "How long, in seconds, the notification is valid" + "description": "How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property." }, "title": { "type": "string", "nullable": true, - "description": "The notification title" + "description": "The notification title. For FCM and GCM, this translates to the `data.twi_title` value. For APNS, this translates to the `aps.alert.title` value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices." }, "body": { "type": "string", "nullable": true, - "description": "The notification body text" + "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." }, "sound": { "type": "string", "nullable": true, - "description": "The name of the sound to be played for the notification" + "description": "The name of the sound to be played for the notification. For FCM and GCM, this Translates to `data.twi_sound`. For APNS, this translates to `aps.sound`. SMS does not support this property." }, "action": { "type": "string", "nullable": true, - "description": "The actions to display for the notification" + "description": "The actions to display for the notification. For APNS, translates to the `aps.category` value. For GCM, translates to the `data.twi_action` value. For SMS, this parameter is not supported and is omitted from deliveries to those channels." }, "data": { "nullable": true, - "description": "The custom key-value pairs of the notification's payload" + "description": "The custom key-value pairs of the notification's payload. For FCM and GCM, this value translates to `data` in the FCM and GCM payloads. FCM and GCM [reserve certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of `data` are inserted into the APNS payload as custom properties outside of the `aps` dictionary. In all channels, we reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed and are rejected as 400 Bad request with no delivery attempted. For SMS, this parameter is not supported and is omitted from deliveries to those channels." }, "apn": { "nullable": true, - "description": "The APNS-specific payload that overrides corresponding attributes in a generic payload for APNS Bindings" + "description": "The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNS `Payload` item, therefore the `aps` key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. See the [APNS documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed." }, "gcm": { "nullable": true, - "description": "The GCM-specific payload that overrides corresponding attributes in generic payload for GCM Bindings" + "description": "The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. 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." }, "fcm": { "nullable": true, - "description": "The FCM-specific payload that overrides corresponding attributes in generic payload for FCM Bindings" + "description": "The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters `to`, `registration_ids`, `condition`, and `notification_key` are not allowed in this parameter. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. FCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref), which cannot be used in that channel." }, "sms": { "nullable": true, - "description": "The SMS-specific payload that overrides corresponding attributes in generic payload for SMS Bindings" + "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/api/message-resource) 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." }, "facebook_messenger": { "nullable": true, - "description": "Deprecated" + "description": "Deprecated." }, "alexa": { "nullable": true, - "description": "Deprecated" + "description": "Deprecated." } } }, @@ -303,7 +303,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Service resource." }, "account_sid": { "type": "string", @@ -311,24 +311,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource." }, "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "apn_credential_sid": { "type": "string", @@ -336,7 +336,7 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Credential to use for APN Bindings" + "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings." }, "gcm_credential_sid": { "type": "string", @@ -344,7 +344,7 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Credential to use for GCM Bindings" + "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings." }, "fcm_credential_sid": { "type": "string", @@ -352,7 +352,7 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Credential to use for FCM Bindings" + "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings." }, "messaging_service_sid": { "type": "string", @@ -360,64 +360,64 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Messaging Service to use for SMS Bindings" + "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." }, "facebook_messenger_page_id": { "type": "string", "nullable": true, - "description": "Deprecated" + "description": "Deprecated." }, "default_apn_notification_protocol_version": { "type": "string", "nullable": true, - "description": "The protocol version to use for sending APNS notifications" + "description": "The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource." }, "default_gcm_notification_protocol_version": { "type": "string", "nullable": true, - "description": "The protocol version to use for sending GCM notifications" + "description": "The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource." }, "default_fcm_notification_protocol_version": { "type": "string", "nullable": true, - "description": "The protocol version to use for sending FCM notifications" + "description": "The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource." }, "log_enabled": { "type": "boolean", "nullable": true, - "description": "Whether to log notifications" + "description": "Whether to log notifications. Can be: `true` or `false` and the default is `true`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Service resource" + "description": "The absolute URL of the Service resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the resources related to the service" + "description": "The URLs of the Binding, Notification, Segment, and User resources related to the service." }, "alexa_skill_id": { "type": "string", "nullable": true, - "description": "Deprecated" + "description": "Deprecated." }, "default_alexa_notification_protocol_version": { "type": "string", "nullable": true, - "description": "Deprecated" + "description": "Deprecated." }, "delivery_callback_url": { "type": "string", "nullable": true, - "description": "Webhook URL" + "description": "URL to send delivery status callback." }, "delivery_callback_enabled": { "type": "boolean", "nullable": true, - "description": "Enable delivery callbacks" + "description": "Callback configuration that enables delivery callbacks, default false" } } } diff --git a/spec/json/twilio_numbers_v2.json b/spec/json/twilio_numbers_v2.json index 05e980b4..fecb3c97 100644 --- a/spec/json/twilio_numbers_v2.json +++ b/spec/json/twilio_numbers_v2.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource." + "description": "The unique string that we created to identify the Bundle resource." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource." }, "regulation_sid": { "type": "string", @@ -26,29 +26,29 @@ "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string of a regulation." + "description": "The unique string of a regulation that is associated to the Bundle resource." }, "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." }, "status": { "type": "string", "$ref": "#/components/schemas/bundle_enum_status", "nullable": true, - "description": "The verification status of the Bundle resource" + "description": "The verification status of the Bundle resource." }, "valid_until": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource will be valid until." + "description": "The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until." }, "email": { "type": "string", "nullable": true, - "description": "The email address" + "description": "The email address that will receive updates when the Bundle resource changes status." }, "status_callback": { "type": "string", @@ -60,25 +60,25 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 Bundle resource" + "description": "The absolute URL of the Bundle resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the Assigned Items of the Bundle resource" + "description": "The URLs of the Assigned Items of the Bundle resource." } } }, @@ -123,7 +123,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Bundle resource." }, "account_sid": { "type": "string", @@ -131,7 +131,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource." }, "regulation_sid": { "type": "string", @@ -139,47 +139,47 @@ "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string of a regulation" + "description": "The unique string of a regulation that is associated to the Bundle resource." }, "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." }, "status": { "type": "string", "$ref": "#/components/schemas/bundle_copy_enum_status", "nullable": true, - "description": "The verification status of the Bundle resource" + "description": "The verification status of the Bundle resource." }, "valid_until": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource will be valid until" + "description": "The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until." }, "email": { "type": "string", "nullable": true, - "description": "The email address" + "description": "The email address that will receive updates when the Bundle resource changes status." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call to inform your application of status changes" + "description": "The URL we call to inform your application of status changes." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." } } }, @@ -210,7 +210,7 @@ "maxLength": 34, "pattern": "^IT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string created by Twilio to identify the End User resource." }, "account_sid": { "type": "string", @@ -218,40 +218,40 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the End User resource." }, "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." }, "type": { "type": "string", "$ref": "#/components/schemas/end_user_enum_type", "nullable": true, - "description": "The type of end user of the Bundle resource" + "description": "The type of end user of the Bundle resource - can be `individual` or `business`." }, "attributes": { "nullable": true, - "description": "The set of parameters that compose the End Users resource" + "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 End User resource" + "description": "The absolute URL of the End User resource." } } }, @@ -271,29 +271,29 @@ "maxLength": 34, "pattern": "^OY[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the End-User Type resource" + "description": "The unique string that identifies the End-User Type resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human-readable description of the End-User Type resource" + "description": "A human-readable description that is assigned to describe the End-User Type resource. Examples can include first name, last name, email, business name, etc" }, "machine_name": { "type": "string", "nullable": true, - "description": "A machine-readable description of the End-User Type resource" + "description": "A machine-readable description of the End-User Type resource. Examples can include first_name, last_name, email, business_name, etc." }, "fields": { "type": "array", "items": {}, "nullable": true, - "description": "The required information for creating an End-User." + "description": "The required information for creating an End-User. The required fields will change as regulatory needs change and will differ for businesses and individuals." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the End-User Type resource" + "description": "The absolute URL of the End-User Type resource." } } }, @@ -306,7 +306,7 @@ "maxLength": 34, "pattern": "^EL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Evaluation resource" + "description": "The unique string that identifies the Evaluation resource." }, "account_sid": { "type": "string", @@ -314,7 +314,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource." }, "regulation_sid": { "type": "string", @@ -322,7 +322,7 @@ "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string of a regulation" + "description": "The unique string of a regulation that is associated to the Bundle resource." }, "bundle_sid": { "type": "string", @@ -330,19 +330,19 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Bundle resource." }, "status": { "type": "string", "$ref": "#/components/schemas/evaluation_enum_status", "nullable": true, - "description": "The compliance status of the Evaluation resource" + "description": "The compliance status of the Evaluation resource." }, "results": { "type": "array", "items": {}, "nullable": true, - "description": "The results of the Evaluation resource" + "description": "The results of the Evaluation which includes the valid and invalid attributes." }, "date_created": { "type": "string", @@ -372,7 +372,7 @@ "maxLength": 34, "pattern": "^BV[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Item Assignment resource." }, "bundle_sid": { "type": "string", @@ -380,7 +380,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Bundle resource." + "description": "The unique string that we created to identify the Bundle resource." }, "account_sid": { "type": "string", @@ -388,7 +388,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource." }, "object_sid": { "type": "string", @@ -396,19 +396,19 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The sid of an object bag" + "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 ISO 8601 date and time in GMT when the resource was created" + "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" + "description": "The absolute URL of the Identity resource." } } }, @@ -421,38 +421,38 @@ "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Regulation resource" + "description": "The unique string that identifies the Regulation resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human-readable description of the Regulation resource" + "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" + "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" + "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", "$ref": "#/components/schemas/regulation_enum_end_user_type", "nullable": true, - "description": "The type of End User of the Regulation resource" + "description": "The type of End User the regulation requires - can be `individual` or `business`." }, "requirements": { "nullable": true, - "description": "The sid of a regulation object that dictates requirements" + "description": "The SID of an object that holds the regulatory information of the phone number country, phone number type, and end user type." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Regulation resource" + "description": "The absolute URL of the Regulation resource." } } }, @@ -476,7 +476,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Bundle resource." }, "account_sid": { "type": "string", @@ -484,7 +484,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource." }, "regulation_sid": { "type": "string", @@ -492,47 +492,47 @@ "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string of a regulation" + "description": "The unique string of a regulation that is associated to the Bundle resource." }, "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." }, "status": { "type": "string", "$ref": "#/components/schemas/replace_items_enum_status", "nullable": true, - "description": "The verification status of the Bundle resource" + "description": "The verification status of the Bundle resource." }, "valid_until": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource will be valid until" + "description": "The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until." }, "email": { "type": "string", "nullable": true, - "description": "The email address" + "description": "The email address that will receive updates when the Bundle resource changes status." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call to inform your application of status changes" + "description": "The URL we call to inform your application of status changes." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." } } }, @@ -563,7 +563,7 @@ "maxLength": 34, "pattern": "^RD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string created by Twilio to identify the Supporting Document resource." }, "account_sid": { "type": "string", @@ -571,23 +571,23 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource." }, "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." }, "mime_type": { "type": "string", "nullable": true, - "description": "The image type of the file" + "description": "The image type uploaded in the Supporting Document container." }, "status": { "type": "string", "$ref": "#/components/schemas/supporting_document_enum_status", "nullable": true, - "description": "The verification status of the Supporting Document resource" + "description": "The verification status of the Supporting Document resource." }, "failure_reason": { "type": "string", @@ -597,29 +597,29 @@ "type": { "type": "string", "nullable": true, - "description": "The type of the Supporting Document" + "description": "The type of the Supporting Document." }, "attributes": { "nullable": true, - "description": "The set of parameters that compose the Supporting Documents resource" + "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 Supporting Document resource" + "description": "The absolute URL of the Supporting Document resource." } } }, @@ -643,29 +643,29 @@ "maxLength": 34, "pattern": "^OY[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Supporting Document Type resource" + "description": "The unique string that identifies the Supporting Document Type resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human-readable description of the Supporting Document Type resource" + "description": "A human-readable description of the Supporting Document Type resource." }, "machine_name": { "type": "string", "nullable": true, - "description": "The machine-readable description of the Supporting Document Type resource" + "description": "The machine-readable description of the Supporting Document Type resource." }, "fields": { "type": "array", "items": {}, "nullable": true, - "description": "The required information for creating a Supporting Document" + "description": "The required information for creating a Supporting Document. The required fields will change as regulatory needs change and will differ for businesses and individuals." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Supporting Document Type resource" + "description": "The absolute URL of the Supporting Document Type resource." } } } diff --git a/spec/json/twilio_oauth_v1.json b/spec/json/twilio_oauth_v1.json index 13e98654..5247cb00 100644 --- a/spec/json/twilio_oauth_v1.json +++ b/spec/json/twilio_oauth_v1.json @@ -6,7 +6,7 @@ "properties": { "keys": { "nullable": true, - "description": "A collection of certificates" + "description": "A collection of certificates where are signed Twilio-issued tokens." }, "url": { "type": "string", @@ -21,33 +21,33 @@ "device_code": { "type": "string", "nullable": true, - "description": "The device verification code" + "description": "The device verification code." }, "user_code": { "type": "string", "nullable": true, - "description": "The verification code for the end user" + "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 request" + "description": "The URI that the end user visits to verify authorization request." }, "verification_uri_complete": { "type": "string", "nullable": true, - "description": "he URI with user_code that the end-user alternatively visits to verify request" + "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" + "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" + "description": "The minimum amount of time in seconds that the client should wait between polling requests to the token endpoint." } } }, @@ -58,43 +58,43 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The issuer URL" + "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 URL of authorization endpoint" + "description": "The endpoint that validates all authorization requests." }, "device_authorization_endpoint": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of device code authorization endpoint" + "description": "The endpoint that validates all device code related authorization requests." }, "token_endpoint": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of token endpoint" + "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 user info endpoint" + "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 URL of revocation endpoint" + "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 public JWK endpoint" + "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", @@ -102,7 +102,7 @@ "type": "string" }, "nullable": true, - "description": "List of response type supported for identity token" + "description": "A collection of response type supported by authorization server." }, "subject_type_supported": { "type": "array", @@ -110,7 +110,7 @@ "type": "string" }, "nullable": true, - "description": "List of subject supported for identity token" + "description": "A collection of subject by authorization server." }, "id_token_signing_alg_values_supported": { "type": "array", @@ -118,7 +118,7 @@ "type": "string" }, "nullable": true, - "description": "List of JWS signing algorithms supported for identity token" + "description": "A collection of JWS signing algorithms supported by authorization server to sign identity token." }, "scopes_supported": { "type": "array", @@ -126,7 +126,7 @@ "type": "string" }, "nullable": true, - "description": "List of scopes supported identity token" + "description": "A collection of scopes supported by authorization server for identity token" }, "claims_supported": { "type": "array", @@ -134,7 +134,7 @@ "type": "string" }, "nullable": true, - "description": "List of claims supported for identity token" + "description": "A collection of claims supported by authorization server for identity token" }, "url": { "type": "string", @@ -149,12 +149,12 @@ "access_token": { "type": "string", "nullable": true, - "description": "Token which carries the necessary information to access a Twilio resource directly" + "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" + "description": "Token which carries the information necessary to get a new access token." }, "id_token": { "type": "string", @@ -164,13 +164,13 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the refresh token expires" + "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 RFC 2822 date and time in GMT when the access token expires" + "description": "The date and time in GMT when the refresh token expires in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." } } }, @@ -183,27 +183,27 @@ "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true, - "description": "The user sid" + "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" + "description": "The first name of the end-user." }, "last_name": { "type": "string", "nullable": true, - "description": "The last name of the end-user" + "description": "The last name of the end-user." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The friendly name of the end-user" + "description": "The friendly name of the end-user." }, "email": { "type": "string", "nullable": true, - "description": "The end-user's preferred email address" + "description": "The end-user's preferred email address." }, "url": { "type": "string", diff --git a/spec/json/twilio_preview.json b/spec/json/twilio_preview.json index f887de15..d6818b42 100644 --- a/spec/json/twilio_preview.json +++ b/spec/json/twilio_preview.json @@ -10,23 +10,23 @@ "maxLength": 34, "pattern": "^CY[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Certificate." + "description": "Contains a 34 character string that uniquely identifies this Certificate credential resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of this Certificate." + "description": "Contains an absolute URL for this Certificate credential resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description for this Certificate." + "description": "Contains a human readable descriptive text for this Certificate credential, up to 256 characters long." }, "fleet_sid": { "type": "string", "nullable": true, - "description": "The unique identifier of the Fleet." + "description": "Specifies the unique string identifier of the Fleet that the given Certificate credential belongs to." }, "account_sid": { "type": "string", @@ -34,7 +34,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID that identifies this Account." + "description": "Specifies the unique string identifier of the Account responsible for this Certificate credential." }, "device_sid": { "type": "string", @@ -42,24 +42,24 @@ "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique identifier of a mapped Device." + "description": "Specifies the unique string identifier of a Device authenticated with this Certificate credential." }, "thumbprint": { "type": "string", "nullable": true, - "description": "A Certificate unique payload hash." + "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": "The date this Certificate was created." + "description": "Specifies the date this Certificate credential was created, given in UTC ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Certificate was updated." + "description": "Specifies the date this Certificate credential was last updated, given in UTC ISO 8601 format." } } }, @@ -72,23 +72,23 @@ "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Deployment." + "description": "Contains a 34 character string that uniquely identifies this Deployment resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of this Deployment." + "description": "Contains an absolute URL for this Deployment resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description for this Deployment" + "description": "Contains a human readable descriptive text for this Deployment, up to 64 characters long" }, "fleet_sid": { "type": "string", "nullable": true, - "description": "The unique identifier of the Fleet." + "description": "Specifies the unique string identifier of the Fleet that the given Deployment belongs to." }, "account_sid": { "type": "string", @@ -96,7 +96,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID that identifies this Account." + "description": "Specifies the unique string identifier of the Account responsible for this Deployment." }, "sync_service_sid": { "type": "string", @@ -104,19 +104,19 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique identifier of the Sync service instance." + "description": "Specifies the unique string identifier of the Twilio Sync service instance linked to and accessible by this Deployment." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Deployment was created." + "description": "Specifies the date this Deployment was created, given in UTC ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Deployment was updated." + "description": "Specifies the date this Deployment was last updated, given in UTC ISO 8601 format." } } }, @@ -129,33 +129,33 @@ "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Device." + "description": "Contains a 34 character string that uniquely identifies this Device resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of this Device." + "description": "Contains an absolute URL for this Device resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "A unique, addressable name of this Device." + "description": "Contains a unique and addressable name of this Device, assigned by the developer, up to 128 characters long." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description for this Device" + "description": "Contains a human readable descriptive text for this Device, up to 256 characters long" }, "fleet_sid": { "type": "string", "nullable": true, - "description": "The unique identifier of the Fleet." + "description": "Specifies the unique string identifier of the Fleet that the given Device belongs to." }, "enabled": { "type": "boolean", "nullable": true, - "description": "Device enabled flag." + "description": "Contains a boolean flag indicating whether the device is enabled or not, blocks device connectivity if set to false." }, "account_sid": { "type": "string", @@ -163,12 +163,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID that identifies this Account." + "description": "Specifies the unique string identifier of the Account responsible for this Device." }, "identity": { "type": "string", "nullable": true, - "description": "An identifier of the Device user." + "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", @@ -176,25 +176,25 @@ "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID of the Deployment group." + "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 this Device 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 this Device was updated." + "description": "Specifies the date this Device was last updated, given in UTC ISO 8601 format." }, "date_authenticated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Device was authenticated." + "description": "Specifies the date this Device was last authenticated, given in UTC ISO 8601 format." } } }, @@ -207,23 +207,23 @@ "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Fleet." + "description": "Contains a 34 character string that uniquely identifies this Fleet resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of this Fleet." + "description": "Contains an absolute URL for this Fleet resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "A unique, addressable name of this Fleet." + "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": "A human readable description for this Fleet." + "description": "Contains a human readable descriptive text for this Fleet, up to 256 characters long." }, "account_sid": { "type": "string", @@ -231,7 +231,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID that identifies this Account." + "description": "Speicifies the unique string identifier of the Account responsible for this Fleet." }, "default_deployment_sid": { "type": "string", @@ -239,25 +239,25 @@ "maxLength": 34, "pattern": "^DL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID that identifies this Fleet's default Deployment." + "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 this Fleet 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 this Fleet was updated." + "description": "Specifies the date this Fleet was last updated, given in UTC ISO 8601 format." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs." + "description": "Contains a dictionary of URL links to nested resources of this Fleet." } } }, @@ -270,23 +270,23 @@ "maxLength": 34, "pattern": "^KY[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Key." + "description": "Contains a 34 character string that uniquely identifies this Key credential resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of this Key." + "description": "Contains an absolute URL for this Key credential resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description for this Key." + "description": "Contains a human readable descriptive text for this Key credential, up to 256 characters long." }, "fleet_sid": { "type": "string", "nullable": true, - "description": "The unique identifier of the Fleet." + "description": "Specifies the unique string identifier of the Fleet that the given Key credential belongs to." }, "account_sid": { "type": "string", @@ -294,7 +294,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID that identifies this Account." + "description": "Specifies the unique string identifier of the Account responsible for this Key credential." }, "device_sid": { "type": "string", @@ -302,24 +302,24 @@ "maxLength": 34, "pattern": "^TH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique identifier of a mapped Device." + "description": "Specifies the unique string identifier of a Device authenticated with this Key credential." }, "secret": { "type": "string", "nullable": true, - "description": "The key secret." + "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": "The date this Key credential was created." + "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": "The date this Key credential was updated." + "description": "Specifies the date this Key credential was last updated, given in UTC ISO 8601 format." } } }, @@ -332,7 +332,7 @@ "maxLength": 34, "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, - "description": "AuthorizationDocument sid." + "description": "A 34 character string that uniquely identifies this AuthorizationDocument." }, "address_sid": { "type": "string", @@ -340,18 +340,18 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "Address sid." + "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": "The Status of this AuthorizationDocument." + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." }, "email": { "type": "string", "nullable": true, - "description": "Email." + "description": "Email that this AuthorizationDocument will be sent to for signing." }, "cc_emails": { "type": "array", @@ -359,19 +359,19 @@ "type": "string" }, "nullable": true, - "description": "A list of emails." + "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 AuthorizationDocument was created." + "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 this AuthorizationDocument was updated." + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, "url": { "type": "string", @@ -404,7 +404,7 @@ "maxLength": 34, "pattern": "^HR[0-9a-fA-F]{32}$", "nullable": true, - "description": "HostedNumberOrder sid." + "description": "A 34 character string that uniquely identifies this Authorization Document" }, "account_sid": { "type": "string", @@ -412,7 +412,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account sid." + "description": "The unique SID identifier of the Account." }, "incoming_phone_number_sid": { "type": "string", @@ -420,7 +420,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "IncomingPhoneNumber sid." + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder." }, "address_sid": { "type": "string", @@ -428,7 +428,7 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "Address 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", @@ -436,13 +436,13 @@ "maxLength": 34, "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, - "description": "LOA document sid." + "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." + "description": "An E164 formatted phone number hosted by this HostedNumberOrder." }, "capabilities": { "type": "object", @@ -462,50 +462,50 @@ } }, "nullable": true, - "description": "A mapping of phone number capabilities." + "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." + "description": "A human readable description of this resource, up to 64 characters." }, "unique_name": { "type": "string", "nullable": true, - "description": "A unique, developer assigned name of this HostedNumberOrder." + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." }, "status": { "type": "string", "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status", "nullable": true, - "description": "The Status of this HostedNumberOrder." + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." }, "failure_reason": { "type": "string", "nullable": true, - "description": "Why a hosted_number_order reached status \"action-required\"" + "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 HostedNumberOrder was created." + "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 this HostedNumberOrder was updated." + "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." + "description": "The number of attempts made to verify ownership of the phone number that is being hosted." }, "email": { "type": "string", "nullable": true, - "description": "Email." + "description": "Email of the owner of this phone number that is being hosted." }, "cc_emails": { "type": "array", @@ -513,13 +513,13 @@ "type": "string" }, "nullable": true, - "description": "A list of emails." + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" }, "verification_type": { "type": "string", "$ref": "#/components/schemas/dependent_hosted_number_order_enum_verification_type", "nullable": true, - "description": "The method used for verifying ownership of the number to be hosted." + "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", @@ -527,17 +527,17 @@ "maxLength": 34, "pattern": "^RI[0-9a-fA-F]{32}$", "nullable": true, - "description": "Verification Document Sid." + "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": "Phone extension to use for ownership verification call." + "description": "A numerical extension to be used when making the ownership verification call." }, "call_delay": { "type": "integer", "nullable": true, - "description": "Seconds (0-30) to delay ownership verification call by." + "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." }, "verification_code": { "type": "string", @@ -550,7 +550,7 @@ "type": "string" }, "nullable": true, - "description": "List of IDs for ownership verification calls." + "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." } } }, @@ -584,7 +584,7 @@ "maxLength": 34, "pattern": "^HR[0-9a-fA-F]{32}$", "nullable": true, - "description": "HostedNumberOrder sid." + "description": "A 34 character string that uniquely identifies this HostedNumberOrder." }, "account_sid": { "type": "string", @@ -592,7 +592,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account Sid." + "description": "A 34 character string that uniquely identifies the account." }, "incoming_phone_number_sid": { "type": "string", @@ -600,7 +600,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "IncomingPhoneNumber sid." + "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", @@ -608,7 +608,7 @@ "maxLength": 34, "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "Address 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", @@ -616,13 +616,13 @@ "maxLength": 34, "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, - "description": "LOA document sid." + "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": "An E164 formatted phone number." + "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", @@ -642,50 +642,50 @@ } }, "nullable": true, - "description": "A mapping of phone number capabilities." + "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." + "description": "A 64 character string that is a human-readable text that describes this resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "A unique, developer assigned name of this HostedNumberOrder." + "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": "The Status of this HostedNumberOrder." + "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": "Why a hosted_number_order reached status \"action-required\"" + "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 HostedNumberOrder was created." + "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 this HostedNumberOrder was updated." + "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." + "description": "The number of attempts made to verify ownership of the phone number that is being hosted." }, "email": { "type": "string", "nullable": true, - "description": "Email." + "description": "Email of the owner of this phone number that is being hosted." }, "cc_emails": { "type": "array", @@ -693,7 +693,7 @@ "type": "string" }, "nullable": true, - "description": "A list of emails." + "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." }, "url": { "type": "string", @@ -705,7 +705,7 @@ "type": "string", "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", "nullable": true, - "description": "The method used for verifying ownership of the number to be hosted." + "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", @@ -713,22 +713,22 @@ "maxLength": 34, "pattern": "^RI[0-9a-fA-F]{32}$", "nullable": true, - "description": "Verification Document Sid." + "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": "Phone extension to use for ownership verification call." + "description": "A numerical extension to be used when making the ownership verification call." }, "call_delay": { "type": "integer", "nullable": true, - "description": "Seconds (0-30) to delay ownership verification call by." + "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." }, "verification_code": { "type": "string", "nullable": true, - "description": "The digits passed during the ownership verification call." + "description": "A verification code provided in the response for a user to enter when they pick up the phone call." }, "verification_call_sids": { "type": "array", @@ -736,7 +736,7 @@ "type": "string" }, "nullable": true, - "description": "List of IDs for ownership verification calls." + "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." } } }, @@ -770,38 +770,38 @@ "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "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": "The string that you assigned to describe the resource." }, "description": { "type": "string", "nullable": true, - "description": "A short description of the Add-on's functionality" + "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" + "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" + "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" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -814,7 +814,7 @@ "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the AvailableAddOnExtension resource." }, "available_add_on_sid": { "type": "string", @@ -822,28 +822,28 @@ "maxLength": 34, "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the AvailableAddOn resource to which this extension applies" + "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", "nullable": true, - "description": "The name of the Extension's Product" + "description": "The name of the Product this Extension is used within." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource" + "description": "An application-defined string that uniquely identifies the resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -856,7 +856,7 @@ "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the 'Available Add-on Sid'." }, "account_sid": { "type": "string", @@ -864,50 +864,50 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the InstalledAddOn resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource" + "description": "The string that you assigned to describe the resource." }, "description": { "type": "string", "nullable": true, - "description": "A short description of the Add-on's functionality" + "description": "A short description of the Add-on's functionality." }, "configuration": { "nullable": true, - "description": "The JSON object that represents the current configuration of installed Add-on" + "description": "The JSON object that represents the current configuration of installed Add-on." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource" + "description": "An application-defined string that uniquely identifies the resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -920,7 +920,7 @@ "maxLength": 34, "pattern": "^XF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the InstalledAddOn Extension resource." }, "installed_add_on_sid": { "type": "string", @@ -928,33 +928,33 @@ "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the InstalledAddOn resource to which this extension applies" + "description": "The SID of the InstalledAddOn resource to which this extension applies." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource" + "description": "The string that you assigned to describe the resource." }, "product_name": { "type": "string", "nullable": true, - "description": "The name of the Extension's Product" + "description": "The name of the Product this Extension is used within." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource" + "description": "An application-defined string that uniquely identifies the resource." }, "enabled": { "type": "boolean", "nullable": true, - "description": "Whether the Extension will be invoked" + "description": "Whether the Extension will be invoked." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -1028,7 +1028,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Twilio Account SID." + "description": "The unique SID identifier of the Twilio Account." }, "service_sid": { "type": "string", @@ -1036,7 +1036,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "Sync Service Instance SID." + "description": "The unique SID identifier of the Sync Service Instance." }, "document_sid": { "type": "string", @@ -1044,33 +1044,33 @@ "maxLength": 34, "pattern": "^ET[0-9a-fA-F]{32}$", "nullable": true, - "description": "Sync Document SID." + "description": "The unique SID identifier of the Sync Document to which the Permission applies." }, "identity": { "type": "string", "nullable": true, - "description": "Identity of the user to whom the Sync Document Permission applies." + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." }, "read": { "type": "boolean", "nullable": true, - "description": "Read access." + "description": "Boolean flag specifying whether the identity can read the Sync Document." }, "write": { "type": "boolean", "nullable": true, - "description": "Write access." + "description": "Boolean flag specifying whether the identity can update the Sync Document." }, "manage": { "type": "boolean", "nullable": true, - "description": "Manage access." + "description": "Boolean flag specifying whether the identity can delete the Sync Document." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of this Sync Document Permission." + "description": "Contains an absolute URL for this Sync Document Permission." } } }, @@ -1267,7 +1267,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Twilio Account SID." + "description": "The unique SID identifier of the Twilio Account." }, "service_sid": { "type": "string", @@ -1275,7 +1275,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "Sync Service Instance SID." + "description": "The unique SID identifier of the Sync Service Instance." }, "list_sid": { "type": "string", @@ -1283,33 +1283,33 @@ "maxLength": 34, "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true, - "description": "Sync List SID." + "description": "The unique SID identifier of the Sync List to which the Permission applies." }, "identity": { "type": "string", "nullable": true, - "description": "Identity of the user to whom the Sync List Permission applies." + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." }, "read": { "type": "boolean", "nullable": true, - "description": "Read access." + "description": "Boolean flag specifying whether the identity can read the Sync List and its Items." }, "write": { "type": "boolean", "nullable": true, - "description": "Write access." + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." }, "manage": { "type": "boolean", "nullable": true, - "description": "Manage access." + "description": "Boolean flag specifying whether the identity can delete the Sync List." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of this Sync List Permission." + "description": "Contains an absolute URL for this Sync List Permission." } } }, @@ -1450,7 +1450,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Twilio Account SID." + "description": "The unique SID identifier of the Twilio Account." }, "service_sid": { "type": "string", @@ -1458,7 +1458,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "Sync Service Instance SID." + "description": "The unique SID identifier of the Sync Service Instance." }, "map_sid": { "type": "string", @@ -1466,33 +1466,33 @@ "maxLength": 34, "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true, - "description": "Sync Map SID." + "description": "The unique SID identifier of the Sync Map to which the Permission applies." }, "identity": { "type": "string", "nullable": true, - "description": "Identity of the user to whom the Sync Map Permission applies." + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." }, "read": { "type": "boolean", "nullable": true, - "description": "Read access." + "description": "Boolean flag specifying whether the identity can read the Sync Map and its Items." }, "write": { "type": "boolean", "nullable": true, - "description": "Write access." + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." }, "manage": { "type": "boolean", "nullable": true, - "description": "Manage access." + "description": "Boolean flag specifying whether the identity can delete the Sync Map." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "URL of this Sync Map Permission." + "description": "Contains an absolute URL for this Sync Map Permission." } } }, @@ -1691,7 +1691,7 @@ "field_type": { "type": "string", "nullable": true, - "description": "The Field Type of this field. It can be any Built-in Field Type or unique_name or the Field Type sid of a custom Field Type." + "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": { "type": "string", @@ -2089,7 +2089,7 @@ "source_channel": { "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" + "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" } } }, diff --git a/spec/json/twilio_pricing_v1.json b/spec/json/twilio_pricing_v1.json index 2b1c6273..bd55b51e 100644 --- a/spec/json/twilio_pricing_v1.json +++ b/spec/json/twilio_pricing_v1.json @@ -26,19 +26,19 @@ "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -48,13 +48,13 @@ "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "outbound_sms_prices": { "type": "array", @@ -91,7 +91,7 @@ } }, "nullable": true, - "description": "The list of OutboundSMSPrice records" + "description": "The list of [OutboundSMSPrice](https://www.twilio.com/docs/sms/api/pricing#outbound-sms-price) records that represent the price to send a message for each MCC/MNC applicable in this country." }, "inbound_sms_prices": { "type": "array", @@ -111,19 +111,19 @@ } }, "nullable": true, - "description": "The list of InboundPrice records" + "description": "The list of [InboundPrice](https://www.twilio.com/docs/sms/api/pricing#inbound-price) records that describe the price to receive an inbound SMS to the different Twilio phone number types supported in this country" }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy)" + "description": "The currency in which prices are measured, specified in [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -152,19 +152,19 @@ "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code " + "description": "The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -174,13 +174,13 @@ "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code " + "description": "The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "phone_number_prices": { "type": "array", @@ -200,19 +200,19 @@ } }, "nullable": true, - "description": "The list of PhoneNumberPrices records" + "description": "The list of [PhoneNumberPrice](https://www.twilio.com/docs/phone-numbers/pricing#phone-number-price) records." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy)" + "description": "The currency in which prices are measured, specified in [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -241,19 +241,19 @@ "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -263,13 +263,13 @@ "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "outbound_prefix_prices": { "type": "array", @@ -295,7 +295,7 @@ } }, "nullable": true, - "description": "The list of OutboundPrefixPrice records" + "description": "The list of OutboundPrefixPrice records, which include a list of the `prefixes`, the `friendly_name`, `base_price`, and the `current_price` for those prefixes." }, "inbound_call_prices": { "type": "array", @@ -315,19 +315,19 @@ } }, "nullable": true, - "description": "The list of InboundCallPrice records" + "description": "The list of [InboundCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) records." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy)" + "description": "The currency in which prices are measured, specified in [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -338,18 +338,18 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number" + "description": "The phone number." }, "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "outbound_call_price": { "type": "object", @@ -363,7 +363,7 @@ } }, "nullable": true, - "description": "The OutboundCallPrice record" + "description": "The OutboundCallPrice record, which includes a list of `origination_prefixes` and the `base_price` and `current_price` for those prefixes." }, "inbound_call_price": { "type": "object", @@ -380,19 +380,19 @@ } }, "nullable": true, - "description": "The InboundCallPrice record" + "description": "The [InboundCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) record. If `null`, the Phone Number is not a Twilio number owned by this account." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy)" + "description": "The currency in which prices are measured, specified in [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } } diff --git a/spec/json/twilio_pricing_v2.json b/spec/json/twilio_pricing_v2.json index 4a7cb2ea..c8ef59ad 100644 --- a/spec/json/twilio_pricing_v2.json +++ b/spec/json/twilio_pricing_v2.json @@ -7,19 +7,19 @@ "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -29,13 +29,13 @@ "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "terminating_prefix_prices": { "type": "array", @@ -67,7 +67,7 @@ } }, "nullable": true, - "description": "The list of TerminatingPrefixPrice records" + "description": "The list of [TerminatingPrefixPrice](https://www.twilio.com/docs/voice/pricing#outbound-prefix-price-with-origin) records." }, "originating_call_prices": { "type": "array", @@ -87,19 +87,19 @@ } }, "nullable": true, - "description": "The list of OriginatingCallPrice records" + "description": "The list of [OriginatingCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) records." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy)" + "description": "The currency in which prices are measured, specified in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -110,24 +110,24 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "The destination phone number, in E.164 format" + "description": "The destination 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." }, "origination_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The origination phone number, in E.164 format" + "description": "The origination 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." }, "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" }, "terminating_prefix_prices": { "type": "array", @@ -175,19 +175,19 @@ } }, "nullable": true, - "description": "The OriginatingCallPrice record" + "description": "The [OriginatingCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) record." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy)" + "description": "The currency in which prices are measured, specified in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -197,19 +197,19 @@ "name": { "type": "string", "nullable": true, - "description": "The resource name" + "description": "The resource name." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the related Countries and Numbers resources" + "description": "The URLs of the related Countries and Numbers resources." } } }, @@ -219,19 +219,19 @@ "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -241,13 +241,13 @@ "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "outbound_prefix_prices": { "type": "array", @@ -279,7 +279,7 @@ } }, "nullable": true, - "description": "The list of OutboundPrefixPriceWithOrigin records" + "description": "The list of [OutboundPrefixPriceWithOrigin](https://www.twilio.com/docs/voice/pricing#outbound-prefix-price-with-origin) records." }, "inbound_call_prices": { "type": "array", @@ -299,19 +299,19 @@ } }, "nullable": true, - "description": "The list of InboundCallPrice records" + "description": "The list of [InboundCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) records." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy)" + "description": "The currency in which prices are measured, specified in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -322,24 +322,24 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "The destination phone number, in E.164 format" + "description": "The destination 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." }, "origination_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The origination phone number, in E.164 format" + "description": "The origination 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." }, "country": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" }, "outbound_call_prices": { "type": "array", @@ -362,7 +362,7 @@ } }, "nullable": true, - "description": "The list of OutboundCallPriceWithOrigin records" + "description": "The list of [OutboundCallPriceWithOrigin](https://www.twilio.com/docs/voice/pricing#outbound-call-price-with-origin) records." }, "inbound_call_price": { "type": "object", @@ -379,19 +379,19 @@ } }, "nullable": true, - "description": "The InboundCallPrice record" + "description": "The [InboundCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) record." }, "price_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy)" + "description": "The currency in which prices are measured, specified in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } } diff --git a/spec/json/twilio_proxy_v1.json b/spec/json/twilio_proxy_v1.json index 84e96bc4..28e4f13e 100644 --- a/spec/json/twilio_proxy_v1.json +++ b/spec/json/twilio_proxy_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^KI[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Interaction resource." }, "session_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^KC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource's parent Session" + "description": "The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) resource." }, "service_sid": { "type": "string", @@ -26,7 +26,7 @@ "maxLength": 34, "pattern": "^KS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource's parent Service" + "description": "The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) resource." }, "account_sid": { "type": "string", @@ -34,18 +34,18 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Interaction resource." }, "data": { "type": "string", "nullable": true, - "description": "A JSON string that includes the message body of message interactions" + "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\"}`)." }, "type": { "type": "string", "$ref": "#/components/schemas/interaction_enum_type", "nullable": true, - "description": "The Type of the Interaction" + "description": "The Type of the Interaction. Can be: `message`, `voice` or `unknown`." }, "inbound_participant_sid": { "type": "string", @@ -53,7 +53,7 @@ "maxLength": 34, "pattern": "^KP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the inbound Participant resource" + "description": "The SID of the inbound [Participant](https://www.twilio.com/docs/proxy/api/participant) resource." }, "inbound_resource_sid": { "type": "string", @@ -61,18 +61,18 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the inbound resource" + "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." }, "inbound_resource_status": { "type": "string", "$ref": "#/components/schemas/interaction_enum_resource_status", "nullable": true, - "description": "The inbound resource status of the Interaction" + "description": "The inbound resource status of the Interaction. Will always be `delivered` for messages and `in-progress` for calls." }, "inbound_resource_type": { "type": "string", "nullable": true, - "description": "The inbound resource type" + "description": "The inbound resource type. Can be [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message-resource)." }, "inbound_resource_url": { "type": "string", @@ -86,7 +86,7 @@ "maxLength": 34, "pattern": "^KP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the outbound Participant" + "description": "The SID of the outbound [Participant](https://www.twilio.com/docs/proxy/api/participant))." }, "outbound_resource_sid": { "type": "string", @@ -94,42 +94,42 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the outbound resource" + "description": "The SID of the outbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message-resource)." }, "outbound_resource_status": { "type": "string", "$ref": "#/components/schemas/interaction_enum_resource_status", "nullable": true, - "description": "The outbound resource status of the Interaction" + "description": "The outbound resource status of the Interaction. Can be: `accepted`, `canceled`, `deleted`, `delivered`, `delivery-unknown`, `failed`, `partially-delivered`, `queued`, `read`, `received`, `receiving`, `scheduled`, `sending`, `sent`, `undelivered`, or `unknown` for messages. Can be `initiated` or `completed` or `unknown` for calls." }, "outbound_resource_type": { "type": "string", "nullable": true, - "description": "The outbound resource type" + "description": "The outbound resource type. Can be: [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message-resource)." }, "outbound_resource_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the Twilio outbound resource" + "description": "The URL of the Twilio outbound resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Interaction was created" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Interaction was created." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Interaction resource" + "description": "The absolute URL of the Interaction resource." } } }, @@ -176,7 +176,7 @@ "maxLength": 34, "pattern": "^KI[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the MessageInteraction resource." }, "session_sid": { "type": "string", @@ -184,7 +184,7 @@ "maxLength": 34, "pattern": "^KC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource's parent Session" + "description": "The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) resource." }, "service_sid": { "type": "string", @@ -192,7 +192,7 @@ "maxLength": 34, "pattern": "^KS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource's parent Service" + "description": "The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) resource." }, "account_sid": { "type": "string", @@ -200,18 +200,18 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the MessageInteraction resource." }, "data": { "type": "string", "nullable": true, - "description": "A JSON string that includes the message body sent to the participant" + "description": "A JSON string that includes the message body sent to the participant. (e.g. `{\"body\": \"hello\"}`)" }, "type": { "type": "string", "$ref": "#/components/schemas/message_interaction_enum_type", "nullable": true, - "description": "The Type of Message Interaction" + "description": "The Type of Message Interaction. This value is always `message`." }, "participant_sid": { "type": "string", @@ -219,7 +219,7 @@ "maxLength": 34, "pattern": "^KP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Participant resource" + "description": "The SID of the [Participant](https://www.twilio.com/docs/proxy/api/participant) resource." }, "inbound_participant_sid": { "type": "string", @@ -227,7 +227,7 @@ "maxLength": 34, "pattern": "^KP[0-9a-fA-F]{32}$", "nullable": true, - "description": "Always empty for Message Interactions" + "description": "Always empty for created Message Interactions." }, "inbound_resource_sid": { "type": "string", @@ -235,24 +235,24 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "Always empty for Message Interactions" + "description": "Always empty for created Message Interactions." }, "inbound_resource_status": { "type": "string", "$ref": "#/components/schemas/message_interaction_enum_resource_status", "nullable": true, - "description": "Always empty for Message Interactions" + "description": "Always empty for created Message Interactions." }, "inbound_resource_type": { "type": "string", "nullable": true, - "description": "Always empty for Message Interactions" + "description": "Always empty for created Message Interactions." }, "inbound_resource_url": { "type": "string", "format": "uri", "nullable": true, - "description": "Always empty for Message Interactions" + "description": "Always empty for created Message Interactions." }, "outbound_participant_sid": { "type": "string", @@ -260,7 +260,7 @@ "maxLength": 34, "pattern": "^KP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the outbound Participant resource" + "description": "The SID of the outbound [Participant](https://www.twilio.com/docs/proxy/api/participant) resource." }, "outbound_resource_sid": { "type": "string", @@ -268,42 +268,42 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the outbound Message resource" + "description": "The SID of the outbound [Message](https://www.twilio.com/docs/sms/api/message-resource) resource." }, "outbound_resource_status": { "type": "string", "$ref": "#/components/schemas/message_interaction_enum_resource_status", "nullable": true, - "description": "The outbound resource status" + "description": "The outbound message resource status. Can be: `accepted`, `deleted`, `delivered`, `delivery-unknown`, `failed`, `queued`, `received`, `receiving`, `scheduled`, `sending`, `sent`, `undelivered`, or `unknown`." }, "outbound_resource_type": { "type": "string", "nullable": true, - "description": "The outbound resource type" + "description": "The outbound resource type. This value is always `Message`." }, "outbound_resource_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the Twilio message resource" + "description": "The URL of the Twilio message resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the MessageInteraction resource" + "description": "The absolute URL of the MessageInteraction resource." } } }, @@ -350,7 +350,7 @@ "maxLength": 34, "pattern": "^KP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Participant resource." }, "session_sid": { "type": "string", @@ -358,7 +358,7 @@ "maxLength": 34, "pattern": "^KC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource's parent Session" + "description": "The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) resource." }, "service_sid": { "type": "string", @@ -366,7 +366,7 @@ "maxLength": 34, "pattern": "^KS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource's parent Service" + "description": "The SID of the resource's parent [Service](https://www.twilio.com/docs/proxy/api/service) resource." }, "account_sid": { "type": "string", @@ -374,22 +374,22 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the participant" + "description": "The string that you assigned to describe the participant. This value must be 255 characters or fewer. Supports UTF-8 characters. **This value should not have PII.**" }, "identifier": { "type": "string", "nullable": true, - "description": "The phone number or channel identifier of the Participant" + "description": "The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters." }, "proxy_identifier": { "type": "string", "nullable": true, - "description": "The phone number or short code of the participant's partner" + "description": "The phone number or short code (masked number) of the participant's partner. The participant will call or message the partner participant at this number." }, "proxy_identifier_sid": { "type": "string", @@ -397,37 +397,37 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Proxy Identifier assigned to the Participant" + "description": "The SID of the Proxy Identifier assigned to the Participant." }, "date_deleted": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date the Participant was removed" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Participant was removed from the session." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Participant resource" + "description": "The absolute URL of the Participant resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs to resources related the participant" + "description": "The URLs to resources related the participant." } } }, @@ -440,7 +440,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the PhoneNumber resource." }, "account_sid": { "type": "string", @@ -448,7 +448,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the PhoneNumber resource." }, "service_sid": { "type": "string", @@ -456,35 +456,35 @@ "maxLength": 34, "pattern": "^KS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the PhoneNumber resource's parent Service resource" + "description": "The SID of the PhoneNumber resource's parent [Service](https://www.twilio.com/docs/proxy/api/service) resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "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." }, "iso_country": { "type": "string", "nullable": true, - "description": "The ISO Country Code" + "description": "The ISO Country Code for the phone number." }, "capabilities": { "type": "object", @@ -504,23 +504,23 @@ } }, "nullable": true, - "description": "The capabilities of the phone number" + "description": "The capabilities of the phone number." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the PhoneNumber resource" + "description": "The absolute URL of the PhoneNumber resource." }, "is_reserved": { "type": "boolean", "nullable": true, - "description": "Reserve the phone number for manual assignment to participants only" + "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." }, "in_use": { "type": "integer", "nullable": true, - "description": "The number of open session assigned to the number." + "description": "The number of open session assigned to the number. See the [How many Phone Numbers do I need?](https://www.twilio.com/docs/proxy/phone-numbers-needed) guide for more information." } } }, @@ -533,12 +533,12 @@ "maxLength": 34, "pattern": "^KS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Service resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource" + "description": "An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. Supports UTF-8 characters. **This value should not have PII.**" }, "account_sid": { "type": "string", @@ -546,7 +546,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource." }, "chat_instance_sid": { "type": "string", @@ -554,66 +554,66 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Chat Service Instance" + "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." }, "callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the interaction status changes" + "description": "The URL we call when the interaction status changes." }, "default_ttl": { "type": "integer", "nullable": true, - "description": "Default TTL for a Session, in seconds" + "description": "The default `ttl` value for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` value." }, "number_selection_behavior": { "type": "string", "$ref": "#/components/schemas/service_enum_number_selection_behavior", "nullable": true, - "description": "The preference for Proxy Number selection for the Service instance" + "description": "The preference for Proxy Number selection in the Service instance. Can be: `prefer-sticky` or `avoid-sticky`. `prefer-sticky` means that we will try and select the same Proxy Number for a given participant if they have previous [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail if that Proxy Number cannot be used. `avoid-sticky` means that we will try to use different Proxy Numbers as long as that is possible within a given pool rather than try and use a previously assigned number." }, "geo_match_level": { "type": "string", "$ref": "#/components/schemas/service_enum_geo_match_level", "nullable": true, - "description": "Where a proxy number must be located relative to the participant identifier" + "description": "Where a proxy number must be located relative to the participant identifier. Can be: `country`, `area-code`, or `extended-area-code`. The default value is `country` and more specific areas than `country` are only available in North America." }, "intercept_callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call on each interaction" + "description": "The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues." }, "out_of_session_callback_url": { "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" + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Service resource" + "description": "The absolute URL of the Service resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of resources related to the Service" + "description": "The URLs of resources related to the Service." } } }, @@ -642,7 +642,7 @@ "maxLength": 34, "pattern": "^KC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Session resource." }, "service_sid": { "type": "string", @@ -650,7 +650,7 @@ "maxLength": 34, "pattern": "^KS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource's parent Service" + "description": "The SID of the [Service](https://www.twilio.com/docs/proxy/api/service) the session is associated with." }, "account_sid": { "type": "string", @@ -658,82 +658,82 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Session resource." }, "date_started": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date when the Session started" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session started." }, "date_ended": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date when the Session ended" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session ended." }, "date_last_interaction": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date when the Session last had an interaction" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session last had an interaction." }, "date_expiry": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date when the Session should expire" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource" + "description": "An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. Supports UTF-8 characters. **This value should not have PII.**" }, "status": { "type": "string", "$ref": "#/components/schemas/session_enum_status", "nullable": true, - "description": "The status of the Session" + "description": "The status of the Session. Can be: `open`, `in-progress`, `closed`, `failed`, or `unknown`." }, "closed_reason": { "type": "string", "nullable": true, - "description": "The reason the Session ended" + "description": "The reason the Session ended." }, "ttl": { "type": "integer", "nullable": true, - "description": "When the session will expire" + "description": "The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction." }, "mode": { "type": "string", "$ref": "#/components/schemas/session_enum_mode", "nullable": true, - "description": "The Mode of the Session" + "description": "The Mode of the Session. Can be: `message-only`, `voice-only`, or `voice-and-message`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Session resource" + "description": "The absolute URL of the Session resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of resources related to the Session" + "description": "The URLs of resources related to the Session." } } }, @@ -764,7 +764,7 @@ "maxLength": 34, "pattern": "^SC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the ShortCode resource." }, "account_sid": { "type": "string", @@ -772,7 +772,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode resource." }, "service_sid": { "type": "string", @@ -780,29 +780,29 @@ "maxLength": 34, "pattern": "^KS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource's parent Service" + "description": "The SID of the ShortCode resource's parent [Service](https://www.twilio.com/docs/proxy/api/service) resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated." }, "short_code": { "type": "string", "nullable": true, - "description": "The short code's number" + "description": "The short code's number." }, "iso_country": { "type": "string", "nullable": true, - "description": "The ISO Country Code" + "description": "The ISO Country Code for the short code." }, "capabilities": { "type": "object", @@ -822,18 +822,18 @@ } }, "nullable": true, - "description": "The capabilities of the short code" + "description": "The capabilities of the short code." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the ShortCode resource" + "description": "The absolute URL of the ShortCode resource." }, "is_reserved": { "type": "boolean", "nullable": true, - "description": "Whether the short code should be reserved for manual assignment to participants only" + "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." } } } diff --git a/spec/json/twilio_routes_v2.json b/spec/json/twilio_routes_v2.json index 82c6a07d..93af8995 100644 --- a/spec/json/twilio_routes_v2.json +++ b/spec/json/twilio_routes_v2.json @@ -7,13 +7,13 @@ "phone_number": { "type": "string", "nullable": true, - "description": "The phone number" + "description": "The phone number in E.164 format" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "sid": { "type": "string", @@ -21,7 +21,7 @@ "maxLength": 34, "pattern": "^QQ[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies the Inbound Processing Region assignments for this phone number." + "description": "A 34 character string that uniquely identifies the Inbound Processing Region assignments for this phone number." }, "account_sid": { "type": "string", @@ -29,12 +29,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account Sid." + "description": "The unique SID identifier of the Account." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of the Inbound Processing Region assignments for this phone number." + "description": "A human readable description of the Inbound Processing Region assignments for this phone number, up to 64 characters." }, "voice_region": { "type": "string", @@ -45,13 +45,13 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this phone number was assigned an Inbound Processing Region." + "description": "The date that this phone number was assigned an Inbound Processing Region, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that the Inbound Processing Region was updated for this phone number." + "description": "The date that the Inbound Processing Region was updated for this phone number, given in ISO 8601 format." } } }, @@ -107,13 +107,13 @@ "sip_trunk_domain": { "type": "string", "nullable": true, - "description": "The SIP Trunk" + "description": "The absolute URL of the SIP Trunk" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "sid": { "type": "string", @@ -121,7 +121,7 @@ "maxLength": 34, "pattern": "^QQ[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies the Inbound Processing Region assignments for this SIP Trunk." + "description": "A 34 character string that uniquely identifies the Inbound Processing Region assignments for this SIP Trunk." }, "account_sid": { "type": "string", @@ -129,12 +129,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account Sid." + "description": "The unique SID identifier of the Account." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of the Inbound Processing Region assignments for this SIP Trunk." + "description": "A human readable description of the Inbound Processing Region assignments for this SIP Trunk, up to 64 characters." }, "voice_region": { "type": "string", @@ -145,13 +145,13 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this SIP Trunk was assigned an Inbound Processing Region." + "description": "The date that this SIP Trunk was assigned an Inbound Processing Region, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that the Inbound Processing Region was updated for this SIP Trunk." + "description": "The date that the Inbound Processing Region was updated for this SIP Trunk, given in ISO 8601 format." } } } diff --git a/spec/json/twilio_serverless_v1.json b/spec/json/twilio_serverless_v1.json index 801be665..c37b0eaa 100644 --- a/spec/json/twilio_serverless_v1.json +++ b/spec/json/twilio_serverless_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Asset resource" + "description": "The unique string that we created to identify the Asset resource." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Asset resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Asset resource." }, "service_sid": { "type": "string", @@ -26,36 +26,36 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Asset resource is associated with" + "description": "The SID of the Service that the Asset resource is associated with." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Asset resource" + "description": "The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Asset resource was created" + "description": "The date and time in GMT when the Asset 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 ISO 8601 date and time in GMT when the Asset resource was last updated" + "description": "The date and time in GMT when the Asset 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 Asset resource" + "description": "The absolute URL of the Asset resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the Asset resource's nested resources" + "description": "The URLs of the Asset resource's nested resources." } } }, @@ -68,7 +68,7 @@ "maxLength": 34, "pattern": "^ZN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Asset Version resource" + "description": "The unique string that we created to identify the Asset Version resource." }, "account_sid": { "type": "string", @@ -76,7 +76,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Asset Version resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Asset Version resource." }, "service_sid": { "type": "string", @@ -84,7 +84,7 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Asset Version resource is associated with" + "description": "The SID of the Service that the Asset Version resource is associated with." }, "asset_sid": { "type": "string", @@ -92,30 +92,30 @@ "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Asset resource that is the parent of the Asset Version" + "description": "The SID of the Asset resource that is the parent of the Asset Version." }, "path": { "type": "string", "nullable": true, - "description": "The URL-friendly string by which the Asset Version can be referenced" + "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." }, "visibility": { "type": "string", "$ref": "#/components/schemas/asset_version_enum_visibility", "nullable": true, - "description": "The access control that determines how the Asset Version can be accessed" + "description": "The access control that determines how the Asset Version resource can be accessed. Can be: `public`, `protected`, or `private`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Asset Version resource was created" + "description": "The date and time in GMT when the Asset Version 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 Asset Version resource" + "description": "The absolute URL of the Asset Version resource." } } }, @@ -136,7 +136,7 @@ "maxLength": 34, "pattern": "^ZB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Build resource" + "description": "The unique string that we created to identify the Build resource." }, "account_sid": { "type": "string", @@ -144,7 +144,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Build resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Build resource." }, "service_sid": { "type": "string", @@ -152,55 +152,55 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Build resource is associated with" + "description": "The SID of the Service that the Build resource is associated with." }, "status": { "type": "string", "$ref": "#/components/schemas/build_enum_status", "nullable": true, - "description": "The status of the Build" + "description": "The status of the Build. Can be: `building`, `completed`, or `failed`." }, "asset_versions": { "type": "array", "items": {}, "nullable": true, - "description": "The list of Asset Version resource SIDs that are included in the Build" + "description": "The list of Asset Version resource SIDs that are included in the Build." }, "function_versions": { "type": "array", "items": {}, "nullable": true, - "description": "The list of Function Version resource SIDs that are included in the Build" + "description": "The list of Function Version resource SIDs that are included in the Build." }, "dependencies": { "type": "array", "items": {}, "nullable": true, - "description": "A list of objects that describe the Dependencies included in the Build" + "description": "A list of objects that describe the Dependencies included in the Build. Each object contains the `name` and `version` of the dependency." }, "runtime": { "type": "string", "$ref": "#/components/schemas/build_enum_runtime", "nullable": true, - "description": "The Runtime version that will be used to run the Build." + "description": "The Runtime version that will be used to run the Build resource when it is deployed." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Build resource was created" + "description": "The date and time in GMT when the Build 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 ISO 8601 date and time in GMT when the Build resource was last updated" + "description": "The date and time in GMT when the Build 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 Build resource" + "description": "The absolute URL of the Build resource." }, "links": { "type": "object", @@ -236,7 +236,7 @@ "maxLength": 34, "pattern": "^ZB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Build resource" + "description": "The unique string that we created to identify the Build resource." }, "account_sid": { "type": "string", @@ -244,7 +244,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Build resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Build resource." }, "service_sid": { "type": "string", @@ -252,19 +252,19 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Build resource is associated with" + "description": "The SID of the Service that the Build resource is associated with." }, "status": { "type": "string", "$ref": "#/components/schemas/build_status_enum_status", "nullable": true, - "description": "The status of the Build" + "description": "The status of the Build. Can be: `building`, `completed`, or `failed`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Build Status resource" + "description": "The absolute URL of the Build Status resource." } } }, @@ -285,7 +285,7 @@ "maxLength": 34, "pattern": "^ZD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Deployment resource" + "description": "The unique string that we created to identify the Deployment resource." }, "account_sid": { "type": "string", @@ -293,7 +293,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Deployment resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Deployment resource." }, "service_sid": { "type": "string", @@ -301,7 +301,7 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Deployment resource is associated with" + "description": "The SID of the Service that the Deployment resource is associated with." }, "environment_sid": { "type": "string", @@ -309,7 +309,7 @@ "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Environment for the Deployment" + "description": "The SID of the Environment for the Deployment." }, "build_sid": { "type": "string", @@ -317,25 +317,25 @@ "maxLength": 34, "pattern": "^ZB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Build for the deployment" + "description": "The SID of the Build for the deployment." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Deployment resource was created" + "description": "The date and time in GMT when the Deployment 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 ISO 8601 date and time in GMT when the Deployment resource was last updated" + "description": "The date and time in GMT when the Deployment 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 Deployment resource" + "description": "The absolute URL of the Deployment resource." } } }, @@ -348,7 +348,7 @@ "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Environment resource" + "description": "The unique string that we created to identify the Environment resource." }, "account_sid": { "type": "string", @@ -356,7 +356,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Environment resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Environment resource." }, "service_sid": { "type": "string", @@ -364,7 +364,7 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Environment resource is associated with" + "description": "The SID of the Service that the Environment resource is associated with." }, "build_sid": { "type": "string", @@ -372,46 +372,46 @@ "maxLength": 34, "pattern": "^ZB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the build deployed in the environment" + "description": "The SID of the build deployed in the environment." }, "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." }, "domain_suffix": { "type": "string", "nullable": true, - "description": "A URL-friendly name that represents the environment" + "description": "A URL-friendly name that represents the environment and forms part of the domain name." }, "domain_name": { "type": "string", "nullable": true, - "description": "The domain name for all Functions and Assets deployed in the Environment" + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Environment resource was created" + "description": "The date and time in GMT when the Environment 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 ISO 8601 date and time in GMT when the Environment resource was last updated" + "description": "The date and time in GMT when the Environment 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 Environment resource" + "description": "The absolute URL of the Environment resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the Environment resource's nested resources" + "description": "The URLs of the Environment resource's nested resources." } } }, @@ -424,7 +424,7 @@ "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Function resource" + "description": "The unique string that we created to identify the Function resource." }, "account_sid": { "type": "string", @@ -432,7 +432,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Function resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Function resource." }, "service_sid": { "type": "string", @@ -440,36 +440,36 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Function resource is associated with" + "description": "The SID of the Service that the Function resource is associated with." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Function resource" + "description": "The string that you assigned to describe the Function resource. It can be a maximum of 255 characters." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Function resource was created" + "description": "The date and time in GMT when the Function 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 ISO 8601 date and time in GMT when the Function resource was last updated" + "description": "The date and time in GMT when the Function 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 Function resource" + "description": "The absolute URL of the Function resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of nested resources of the Function resource" + "description": "The URLs of nested resources of the Function resource." } } }, @@ -482,7 +482,7 @@ "maxLength": 34, "pattern": "^ZN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Function Version resource" + "description": "The unique string that we created to identify the Function Version resource." }, "account_sid": { "type": "string", @@ -490,7 +490,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Function Version resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Function Version resource." }, "service_sid": { "type": "string", @@ -498,7 +498,7 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Function Version resource is associated with" + "description": "The SID of the Service that the Function Version resource is associated with." }, "function_sid": { "type": "string", @@ -506,30 +506,30 @@ "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Function resource that is the parent of the Function Version resource" + "description": "The SID of the Function resource that is the parent of the Function Version resource." }, "path": { "type": "string", "nullable": true, - "description": "The URL-friendly string by which the Function Version resource can be referenced" + "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." }, "visibility": { "type": "string", "$ref": "#/components/schemas/function_version_enum_visibility", "nullable": true, - "description": "The access control that determines how the Function Version resource can be accessed" + "description": "The access control that determines how the Function Version resource can be accessed. Can be: `public`, `protected`, or `private`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Function Version resource was created" + "description": "The date and time in GMT when the Function Version 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 Function Version resource" + "description": "The absolute URL of the Function Version resource." }, "links": { "type": "object", @@ -555,7 +555,7 @@ "maxLength": 34, "pattern": "^ZN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Function Version resource" + "description": "The unique string that we created to identify the Function Version resource." }, "account_sid": { "type": "string", @@ -563,7 +563,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Function Version resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Function Version resource." }, "service_sid": { "type": "string", @@ -571,7 +571,7 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Function Version resource is associated with" + "description": "The SID of the Service that the Function Version resource is associated with." }, "function_sid": { "type": "string", @@ -579,12 +579,12 @@ "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Function that is the parent of the Function Version" + "description": "The SID of the Function that is the parent of the Function Version." }, "content": { "type": "string", "nullable": true, - "description": "The content of the Function Version resource" + "description": "The content of the Function Version resource." }, "url": { "type": "string", @@ -602,7 +602,7 @@ "maxLength": 34, "pattern": "^NO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Log resource" + "description": "The unique string that we created to identify the Log resource." }, "account_sid": { "type": "string", @@ -610,7 +610,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Log resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Log resource." }, "service_sid": { "type": "string", @@ -618,7 +618,7 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Log resource is associated with" + "description": "The SID of the Service that the Log resource is associated with." }, "environment_sid": { "type": "string", @@ -626,7 +626,7 @@ "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the environment in which the log occurred" + "description": "The SID of the environment in which the log occurred." }, "build_sid": { "type": "string", @@ -634,7 +634,7 @@ "maxLength": 34, "pattern": "^ZB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the build that corresponds to the log" + "description": "The SID of the build that corresponds to the log." }, "deployment_sid": { "type": "string", @@ -642,7 +642,7 @@ "maxLength": 34, "pattern": "^ZD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the deployment that corresponds to the log" + "description": "The SID of the deployment that corresponds to the log." }, "function_sid": { "type": "string", @@ -650,7 +650,7 @@ "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the function whose invocation produced the log" + "description": "The SID of the function whose invocation produced the log." }, "request_sid": { "type": "string", @@ -658,30 +658,30 @@ "maxLength": 34, "pattern": "^RQ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the request associated with the log" + "description": "The SID of the request associated with the log." }, "level": { "type": "string", "$ref": "#/components/schemas/log_enum_level", "nullable": true, - "description": "The log level" + "description": "The log level. Can be: `info`, `warn`, or `error`." }, "message": { "type": "string", "nullable": true, - "description": "The log message" + "description": "The log message." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Log resource was created" + "description": "The date and time in GMT when the Log 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 Log resource" + "description": "The absolute URL of the Log resource." } } }, @@ -702,7 +702,7 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Service resource" + "description": "The unique string that we created to identify the Service resource." }, "account_sid": { "type": "string", @@ -710,56 +710,56 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Service resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource." }, "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." }, "unique_name": { "type": "string", "nullable": true, - "description": "A user-defined string that uniquely identifies 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." }, "include_credentials": { "type": "boolean", "nullable": true, - "description": "Whether to inject Account credentials into a function invocation context" + "description": "Whether to inject Account credentials into a function invocation context." }, "ui_editable": { "type": "boolean", "nullable": true, - "description": "Whether the Service resource's properties and subresources can be edited via the UI" + "description": "Whether the Service resource's properties and subresources can be edited via the UI." }, "domain_base": { "type": "string", "nullable": true, - "description": "The base domain name for this Service, which is a combination of the unique name and a randomly generated string" + "description": "The base domain name for this Service, which is a combination of the unique name and a randomly generated string." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Service resource was created" + "description": "The date and time in GMT when the Service 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 ISO 8601 date and time in GMT when the Service resource was last updated" + "description": "The date and time in GMT when the Service 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 Service resource" + "description": "The absolute URL of the Service resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the Service's nested resources" + "description": "The URLs of the Service's nested resources." } } }, @@ -772,7 +772,7 @@ "maxLength": 34, "pattern": "^ZV[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Variable resource" + "description": "The unique string that we created to identify the Variable resource." }, "account_sid": { "type": "string", @@ -780,7 +780,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the Variable resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Variable resource." }, "service_sid": { "type": "string", @@ -788,7 +788,7 @@ "maxLength": 34, "pattern": "^ZS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the Variable resource is associated with" + "description": "The SID of the Service that the Variable resource is associated with." }, "environment_sid": { "type": "string", @@ -796,35 +796,35 @@ "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Environment in which the Variable exists" + "description": "The SID of the Environment in which the Variable exists." }, "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." }, "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Variable resource was created" + "description": "The date and time in GMT when the Variable 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 ISO 8601 date and time in GMT when the Variable resource was last updated" + "description": "The date and time in GMT when the Variable 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 Variable resource" + "description": "The absolute URL of the Variable resource." } } } diff --git a/spec/json/twilio_studio_v1.json b/spec/json/twilio_studio_v1.json index 0db06aa3..e41cdf5f 100644 --- a/spec/json/twilio_studio_v1.json +++ b/spec/json/twilio_studio_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Engagement resource." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Engagement resource." }, "flow_sid": { "type": "string", @@ -26,7 +26,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flow" + "description": "The SID of the Flow." }, "contact_sid": { "type": "string", @@ -34,46 +34,46 @@ "maxLength": 34, "pattern": "^FC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Contact" + "description": "The SID of the Contact." }, "contact_channel_address": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that triggered this Engagement" + "description": "The phone number, SIP address or Client identifier that triggered this Engagement. Phone numbers are in E.164 format (+16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`." }, "context": { "nullable": true, - "description": "The current state of the execution flow" + "description": "The current state of the execution flow. As your flow executes, we save the state in a flow context. Your widgets can access the data in the flow context as variables, either in configuration fields or in text areas as variable substitution." }, "status": { "type": "string", "$ref": "#/components/schemas/engagement_enum_status", "nullable": true, - "description": "The status of the Engagement" + "description": "The status of the Engagement. Can be: `active` or `ended`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Engagement was created" + "description": "The date and time in GMT when the Engagement was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Engagement was last updated" + "description": "The date and time in GMT when the Engagement was updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the Engagement's nested resources" + "description": "The URLs of the Engagement's nested resources." } } }, @@ -93,11 +93,11 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account SID" + "description": "The SID of the Account." }, "context": { "nullable": true, - "description": "Flow state" + "description": "As your flow executes, we save the state in what's called the Flow Context. Any data in the flow context can be accessed by your widgets as variables, either in configuration fields or in text areas as variable substitution." }, "engagement_sid": { "type": "string", @@ -105,7 +105,7 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "Engagement SID" + "description": "The SID of the Engagement." }, "flow_sid": { "type": "string", @@ -113,13 +113,13 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "Flow SID" + "description": "The SID of the Flow." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the resource" + "description": "The URL of the resource." } } }, @@ -132,7 +132,7 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Execution resource." }, "account_sid": { "type": "string", @@ -140,7 +140,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Execution resource." }, "flow_sid": { "type": "string", @@ -148,7 +148,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flow" + "description": "The SID of the Flow." }, "contact_sid": { "type": "string", @@ -156,46 +156,46 @@ "maxLength": 34, "pattern": "^FC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Contact" + "description": "The SID of the Contact." }, "contact_channel_address": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that triggered the Execution" + "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`." }, "context": { "nullable": true, - "description": "The current state of the flow" + "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." }, "status": { "type": "string", "$ref": "#/components/schemas/execution_enum_status", "nullable": true, - "description": "The status of the Execution" + "description": "The status of the Execution. Can be: `active` or `ended`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs" + "description": "The URLs of nested resources." } } }, @@ -215,11 +215,11 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ExecutionContext resource." }, "context": { "nullable": true, - "description": "The current state of the flow" + "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." }, "flow_sid": { "type": "string", @@ -227,7 +227,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flow" + "description": "The SID of the Flow." }, "execution_sid": { "type": "string", @@ -235,13 +235,13 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Execution" + "description": "The SID of the context's Execution resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -254,7 +254,7 @@ "maxLength": 34, "pattern": "^FT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the ExecutionStep resource." }, "account_sid": { "type": "string", @@ -262,7 +262,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ExecutionStep resource." }, "flow_sid": { "type": "string", @@ -270,7 +270,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flow" + "description": "The SID of the Flow." }, "execution_sid": { "type": "string", @@ -278,50 +278,50 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Execution" + "description": "The SID of the Step's Execution resource." }, "name": { "type": "string", "nullable": true, - "description": "The event that caused the Flow to transition to the Step" + "description": "The event that caused the Flow to transition to the Step." }, "context": { "nullable": true, - "description": "The current state of the flow" + "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." }, "transitioned_from": { "type": "string", "nullable": true, - "description": "The Widget that preceded the Widget for the Step" + "description": "The Widget that preceded the Widget for the Step." }, "transitioned_to": { "type": "string", "nullable": true, - "description": "The Widget that will follow the Widget for the Step" + "description": "The Widget that will follow the Widget for the Step." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -334,11 +334,11 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ExecutionStepContext resource." }, "context": { "nullable": true, - "description": "The current state of the flow" + "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." }, "execution_sid": { "type": "string", @@ -346,7 +346,7 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Execution" + "description": "The SID of the context's Execution resource." }, "flow_sid": { "type": "string", @@ -354,7 +354,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flow" + "description": "The SID of the Flow." }, "step_sid": { "type": "string", @@ -362,13 +362,13 @@ "maxLength": 34, "pattern": "^FT[0-9a-fA-F]{32}$", "nullable": true, - "description": "Step SID" + "description": "The SID of the Step that the context is associated with." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -381,7 +381,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Flow resource." }, "account_sid": { "type": "string", @@ -389,47 +389,47 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flow resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Flow" + "description": "The string that you assigned to describe the Flow." }, "status": { "type": "string", "$ref": "#/components/schemas/flow_enum_status", "nullable": true, - "description": "The status of the Flow" + "description": "The status of the Flow. Can be: `draft` or `published`." }, "version": { "type": "integer", "nullable": true, - "description": "The latest version number of the Flow's definition" + "description": "The latest version number of the Flow's definition." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs" + "description": "The URLs of the Flow's nested resources." } } }, @@ -449,7 +449,7 @@ "maxLength": 34, "pattern": "^FT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Step resource." }, "account_sid": { "type": "string", @@ -457,7 +457,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Step resource." }, "flow_sid": { "type": "string", @@ -465,7 +465,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flow" + "description": "The SID of the Flow." }, "engagement_sid": { "type": "string", @@ -473,50 +473,50 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Engagement" + "description": "The SID of the Engagement." }, "name": { "type": "string", "nullable": true, - "description": "The event that caused the Flow to transition to the Step" + "description": "The event that caused the Flow to transition to the Step." }, "context": { "nullable": true, - "description": "The current state of the flow" + "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." }, "transitioned_from": { "type": "string", "nullable": true, - "description": "The Widget that preceded the Widget for the Step" + "description": "The Widget that preceded the Widget for the Step." }, "transitioned_to": { "type": "string", "nullable": true, - "description": "The Widget that will follow the Widget for the Step" + "description": "The Widget that will follow the Widget for the Step." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -529,11 +529,11 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the StepContext resource." }, "context": { "nullable": true, - "description": "The current state of the flow" + "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." }, "engagement_sid": { "type": "string", @@ -541,7 +541,7 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Engagement" + "description": "The SID of the Engagement." }, "flow_sid": { "type": "string", @@ -549,7 +549,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flow" + "description": "The SID of the Flow." }, "step_sid": { "type": "string", @@ -557,13 +557,13 @@ "maxLength": 34, "pattern": "^FT[0-9a-fA-F]{32}$", "nullable": true, - "description": "Step SID" + "description": "The SID of the Step the context is associated with." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } } diff --git a/spec/json/twilio_studio_v2.json b/spec/json/twilio_studio_v2.json index d2259d78..3e02465c 100644 --- a/spec/json/twilio_studio_v2.json +++ b/spec/json/twilio_studio_v2.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Execution resource." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Execution resource." }, "flow_sid": { "type": "string", @@ -26,46 +26,46 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flow" + "description": "The SID of the Flow." }, "contact_channel_address": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that triggered the Execution" + "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`." }, "context": { "nullable": true, - "description": "The current state of the flow" + "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." }, "status": { "type": "string", "$ref": "#/components/schemas/execution_enum_status", "nullable": true, - "description": "The status of the Execution" + "description": "The status of the Execution. Can be: `active` or `ended`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs" + "description": "The URLs of nested resources." } } }, @@ -85,11 +85,11 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ExecutionContext resource." }, "context": { "nullable": true, - "description": "The current state of the flow" + "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." }, "flow_sid": { "type": "string", @@ -97,7 +97,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flow" + "description": "The SID of the Flow." }, "execution_sid": { "type": "string", @@ -105,13 +105,13 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Execution" + "description": "The SID of the context's Execution resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -124,7 +124,7 @@ "maxLength": 34, "pattern": "^FT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the ExecutionStep resource." }, "account_sid": { "type": "string", @@ -132,7 +132,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ExecutionStep resource." }, "flow_sid": { "type": "string", @@ -140,7 +140,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flow" + "description": "The SID of the Flow." }, "execution_sid": { "type": "string", @@ -148,50 +148,50 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Execution" + "description": "The SID of the Step's Execution resource." }, "name": { "type": "string", "nullable": true, - "description": "The event that caused the Flow to transition to the Step" + "description": "The event that caused the Flow to transition to the Step." }, "context": { "nullable": true, - "description": "The current state of the flow" + "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." }, "transitioned_from": { "type": "string", "nullable": true, - "description": "The Widget that preceded the Widget for the Step" + "description": "The Widget that preceded the Widget for the Step." }, "transitioned_to": { "type": "string", "nullable": true, - "description": "The Widget that will follow the Widget for the Step" + "description": "The Widget that will follow the Widget for the Step." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -204,11 +204,11 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ExecutionStepContext resource." }, "context": { "nullable": true, - "description": "The current state of the flow" + "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." }, "execution_sid": { "type": "string", @@ -216,7 +216,7 @@ "maxLength": 34, "pattern": "^FN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Execution" + "description": "The SID of the context's Execution resource." }, "flow_sid": { "type": "string", @@ -224,7 +224,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flow" + "description": "The SID of the Flow." }, "step_sid": { "type": "string", @@ -232,13 +232,13 @@ "maxLength": 34, "pattern": "^FT[0-9a-fA-F]{32}$", "nullable": true, - "description": "Step SID" + "description": "The SID of the Step that the context is associated with." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -251,7 +251,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Flow resource." }, "account_sid": { "type": "string", @@ -259,61 +259,61 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flow resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Flow" + "description": "The string that you assigned to describe the Flow." }, "definition": { "nullable": true, - "description": "JSON representation of flow definition" + "description": "JSON representation of flow definition." }, "status": { "type": "string", "$ref": "#/components/schemas/flow_enum_status", "nullable": true, - "description": "The status of the Flow" + "description": "The status of the Flow. Can be: `draft` or `published`." }, "revision": { "type": "integer", "nullable": true, - "description": "The latest revision number of the Flow's definition" + "description": "The latest revision number of the Flow's definition." }, "commit_message": { "type": "string", "nullable": true, - "description": "Description of change made in the revision" + "description": "Description of change made in the revision." }, "valid": { "type": "boolean", "nullable": true, - "description": "Boolean if the flow definition is valid" + "description": "Boolean if the flow definition is valid." }, "errors": { "type": "array", "items": {}, "nullable": true, - "description": "List of error in the flow definition" + "description": "List of error in the flow definition." }, "warnings": { "type": "array", "items": {}, "nullable": true, - "description": "List of warnings in the flow definition" + "description": "List of warnings in the flow definition." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "webhook_url": { "type": "string", @@ -324,13 +324,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs" + "description": "The URLs of the Flow's nested resources." } } }, @@ -350,7 +350,7 @@ "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Flow resource." }, "account_sid": { "type": "string", @@ -358,61 +358,61 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flow resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Flow" + "description": "The string that you assigned to describe the Flow." }, "definition": { "nullable": true, - "description": "JSON representation of flow definition" + "description": "JSON representation of flow definition." }, "status": { "type": "string", "$ref": "#/components/schemas/flow_revision_enum_status", "nullable": true, - "description": "The status of the Flow" + "description": "The status of the Flow. Can be: `draft` or `published`." }, "revision": { "type": "integer", "nullable": true, - "description": "The latest revision number of the Flow's definition" + "description": "The latest revision number of the Flow's definition." }, "commit_message": { "type": "string", "nullable": true, - "description": "Description of change made in the revision" + "description": "Description of change made in the revision." }, "valid": { "type": "boolean", "nullable": true, - "description": "Boolean if the flow definition is valid" + "description": "Boolean if the flow definition is valid." }, "errors": { "type": "array", "items": {}, "nullable": true, - "description": "List of error in the flow definition" + "description": "List of error in the flow definition." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -429,7 +429,7 @@ "valid": { "type": "boolean", "nullable": true, - "description": "Boolean if the flow definition is valid" + "description": "Boolean if the flow definition is valid." } } }, diff --git a/spec/json/twilio_supersim_v1.json b/spec/json/twilio_supersim_v1.json index 00d4fe7b..af6b711d 100644 --- a/spec/json/twilio_supersim_v1.json +++ b/spec/json/twilio_supersim_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^HB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Billing Period" + "description": "The SID of the Billing Period." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account the Super SIM belongs to" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) the Super SIM belongs to." }, "sim_sid": { "type": "string", @@ -26,37 +26,37 @@ "maxLength": 34, "pattern": "^HS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Super SIM the Billing Period belongs to" + "description": "The SID of the Super SIM the Billing Period belongs to." }, "start_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The start time of the Billing Period" + "description": "The start time of the Billing Period specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The end time of the Billing Period" + "description": "The end time of the Billing Period specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "period_type": { "type": "string", "$ref": "#/components/schemas/billing_period_enum_bp_type", "nullable": true, - "description": "The type of the Billing Period" + "description": "The type of Billing Period. Can be `ready` or `active`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." } } }, @@ -76,7 +76,7 @@ "maxLength": 34, "pattern": "^HP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the eSIM Profile resource." }, "account_sid": { "type": "string", @@ -84,12 +84,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account to which the eSIM Profile resource belongs" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the eSIM Profile resource belongs." }, "iccid": { "type": "string", "nullable": true, - "description": "The ICCID associated with the Sim resource" + "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource." }, "sim_sid": { "type": "string", @@ -97,52 +97,52 @@ "maxLength": 34, "pattern": "^HS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sim resource that this eSIM Profile controls" + "description": "The SID of the [Sim](https://www.twilio.com/docs/wireless/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" + "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." }, "eid": { "type": "string", "nullable": true, - "description": "Identifier of the eUICC that can claim the eSIM Profile" + "description": "Identifier of the eUICC that can claim the eSIM Profile." }, "smdp_plus_address": { "type": "string", "format": "uri", "nullable": true, - "description": "Address of the SM-DP+ server from which the Profile will be downloaded" + "description": "Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status `available`." }, "error_code": { "type": "string", "nullable": true, - "description": "Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state" + "description": "Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state." }, "error_message": { "type": "string", "nullable": true, - "description": "Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state" + "description": "Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 eSIM Profile resource" + "description": "The absolute URL of the eSIM Profile resource." } } }, @@ -166,7 +166,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Fleet resource." }, "sid": { "type": "string", @@ -174,57 +174,57 @@ "maxLength": 34, "pattern": "^HF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Fleet resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 Fleet resource" + "description": "The absolute URL of the Fleet resource." }, "data_enabled": { "type": "boolean", "nullable": true, - "description": "Defines whether SIMs in the Fleet are capable of using data connectivity" + "description": "Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to `true`." }, "data_limit": { "type": "integer", "nullable": true, - "description": "The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume" + "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)." }, "data_metering": { "type": "string", "$ref": "#/components/schemas/fleet_enum_data_metering", "nullable": true, - "description": "The model by which a SIM is metered and billed" + "description": "The model by which a SIMs usage is metered and billed. Defaults to `payg`." }, "sms_commands_enabled": { "type": "boolean", "nullable": true, - "description": "Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands" + "description": "Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to `true`." }, "sms_commands_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number" + "description": "The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored." }, "sms_commands_method": { "type": "string", @@ -238,7 +238,7 @@ "DELETE" ], "nullable": true, - "description": "A string representing the HTTP method to use when making a request to `sms_commands_url`" + "description": "A string representing the HTTP method to use when making a request to `sms_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`." }, "network_access_profile_sid": { "type": "string", @@ -246,13 +246,13 @@ "maxLength": 34, "pattern": "^HA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Network Access Profile of the Fleet" + "description": "The SID of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to." }, "ip_commands_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device" + "description": "The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored." }, "ip_commands_method": { "type": "string", @@ -266,7 +266,7 @@ "DELETE" ], "nullable": true, - "description": "A string representing the HTTP method to use when making a request to `ip_commands_url`" + "description": "A string representing the HTTP method to use when making a request to `ip_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`." } } }, @@ -285,7 +285,7 @@ "maxLength": 34, "pattern": "^HG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the IP Command resource." }, "account_sid": { "type": "string", @@ -293,7 +293,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IP Command resource." }, "sim_sid": { "type": "string", @@ -301,63 +301,63 @@ "maxLength": 34, "pattern": "^HS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Super SIM that this IP Command was sent to or from" + "description": "The SID of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) that this IP Command was sent to or from." }, "sim_iccid": { "type": "string", "nullable": true, - "description": "The ICCID of the Super SIM that this IP Command was sent to or from" + "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) that this IP Command was sent to or from." }, "status": { "type": "string", "$ref": "#/components/schemas/ip_command_enum_status", "nullable": true, - "description": "The status of the IP Command" + "description": "The delivery status of the IP Command. This is one of the following: \u201cqueued\u201d, \u201csent\u201d, \u201cfailed\u201d or \u201creceived\u201d." }, "direction": { "type": "string", "$ref": "#/components/schemas/ip_command_enum_direction", "nullable": true, - "description": "The direction of the IP Command" + "description": "Either `to_sim` or `from_sim`. Indicates whether the IP Command resource was sent from or to the Super SIM." }, "device_ip": { "type": "string", "nullable": true, - "description": "The IP address of the device that the IP Command was sent to or received from" + "description": "The IP address of the device that the IP Command was sent to or received from. For an IP Command sent to a Super SIM, `device_ip` starts out as `null`, and once the IP Command is \u201csent\u201d, the `device_ip` will be filled out. An IP Command sent from a Super SIM have its `device_ip` always set." }, "device_port": { "type": "integer", "nullable": true, - "description": "The port that the IP Command either originated from or was sent to" + "description": "For an IP Command sent to a Super SIM, it would be the destination port of the IP message. For an IP Command sent from a Super SIM, it would be the source port of the IP message." }, "payload_type": { "type": "string", "$ref": "#/components/schemas/ip_command_enum_payload_type", "nullable": true, - "description": "The payload type of the IP Command" + "description": "Either \u201ctext\u201d or \u201cbinary\u201d. For an IP Command sent to a Super SIM, `payload_type` is configurable. For an IP Command sent from a Super SIM, `payload_type` is always \u201cbinary\u201d." }, "payload": { "type": "string", "nullable": true, - "description": "The payload of the IP Command sent to or from the Super SIM" + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 IP Command resource" + "description": "The absolute URL of the IP Command resource." } } }, @@ -393,29 +393,29 @@ "maxLength": 34, "pattern": "^HW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Network resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable identifier of this resource" + "description": "A human readable identifier of this resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Network resource" + "description": "The absolute URL of the Network resource." }, "iso_country": { "type": "string", "nullable": true, - "description": "The ISO country code of the Network resource" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resource." }, "identifiers": { "type": "array", "items": {}, "nullable": true, - "description": "The MCC/MNCs included in the Network resource" + "description": "Array of objects identifying the [MCC-MNCs](https://en.wikipedia.org/wiki/Mobile_country_code) that are included in the Network resource." } } }, @@ -428,12 +428,12 @@ "maxLength": 34, "pattern": "^HA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that identifies the Network Access Profile resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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." }, "account_sid": { "type": "string", @@ -441,25 +441,25 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that the Network Access Profile belongs to" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Network Access Profile belongs to." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the Network Access Profile resource." }, "links": { "type": "object", @@ -477,7 +477,7 @@ "maxLength": 34, "pattern": "^HW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that identifies the Network resource." }, "network_access_profile_sid": { "type": "string", @@ -485,29 +485,29 @@ "maxLength": 34, "pattern": "^HA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Network Access Profile resource" + "description": "The unique string that identifies the Network resource's Network Access Profile resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable identifier of this resource" + "description": "A human readable identifier of the Network this resource refers to." }, "iso_country": { "type": "string", "nullable": true, - "description": "The ISO country code of the Network resource" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resource." }, "identifiers": { "type": "array", "items": {}, "nullable": true, - "description": "The MCC/MNCs included in the resource" + "description": "Array of objects identifying the [MCC-MNCs](https://en.wikipedia.org/wiki/Mobile_country_code) that are included in the Network resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the Network resource." } } }, @@ -520,12 +520,12 @@ "maxLength": 34, "pattern": "^OB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique identifier of this Settings Update" + "description": "The unique identifier of this Settings Update." }, "iccid": { "type": "string", "nullable": true, - "description": "The ICCID associated with the SIM" + "description": "The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM." }, "sim_sid": { "type": "string", @@ -533,37 +533,37 @@ "maxLength": 34, "pattern": "^HS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Super SIM to which this Settings Update was applied" + "description": "The SID of the Super SIM to which this Settings Update was applied." }, "status": { "type": "string", "$ref": "#/components/schemas/settings_update_enum_status", "nullable": true, - "description": "The Status of this Settings Update" + "description": "The Status of this Settings Update. One of `scheduled`, `in-progress`, `successful` or `failed`." }, "packages": { "type": "array", "items": {}, "nullable": true, - "description": "Array containing the different Settings Packages that will be applied to the SIM after the update completes" + "description": "Array containing the different Settings Packages that will be applied to the SIM after the update completes. Each object within the array indicates the name and the version of the Settings Package that will be on the SIM if the update is successful." }, "date_completed": { "type": "string", "format": "date-time", "nullable": true, - "description": "The time when the update successfully completed and the new settings were applied to the SIM" + "description": "The time, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, when the update successfully completed and the new settings were applied to the SIM." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Settings Update was created" + "description": "The date that this Settings Update was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Settings Update was last updated" + "description": "The date that this Settings Update was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." } } }, @@ -585,12 +585,12 @@ "maxLength": 34, "pattern": "^HS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that identifies the Sim resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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." }, "account_sid": { "type": "string", @@ -598,18 +598,18 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that the Super SIM belongs to" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Super SIM belongs to." }, "iccid": { "type": "string", "nullable": true, - "description": "The ICCID associated with the SIM" + "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM." }, "status": { "type": "string", "$ref": "#/components/schemas/sim_enum_status", "nullable": true, - "description": "The status of the Super SIM" + "description": "The status of the Super SIM. Can be `new`, `ready`, `active`, `inactive`, or `scheduled`. See the [Super SIM Status Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values) for a description of each." }, "fleet_sid": { "type": "string", @@ -617,25 +617,25 @@ "maxLength": 34, "pattern": "^HF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the Fleet configured for this SIM" + "description": "The unique ID of the Fleet configured for this SIM." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 Sim Resource" + "description": "The absolute URL of the Sim Resource." }, "links": { "type": "object", @@ -674,7 +674,7 @@ "type": "string", "$ref": "#/components/schemas/sim_ip_address_enum_ip_address_version", "nullable": true, - "description": "IP address version" + "description": "IP address version of the corresponding IP address" } } }, @@ -694,7 +694,7 @@ "maxLength": 34, "pattern": "^HC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the SMS Command resource." }, "account_sid": { "type": "string", @@ -702,7 +702,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SMS Command resource." }, "sim_sid": { "type": "string", @@ -710,42 +710,42 @@ "maxLength": 34, "pattern": "^HS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the SIM that this SMS Command was sent to or from" + "description": "The SID of the [SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) that this SMS Command was sent to or from." }, "payload": { "type": "string", "nullable": true, - "description": "The message body of the SMS Command sent to or from the SIM" + "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." }, "status": { "type": "string", "$ref": "#/components/schemas/sms_command_enum_status", "nullable": true, - "description": "The status of the SMS Command" + "description": "The status of the SMS Command. Can be: `queued`, `sent`, `delivered`, `received` or `failed`. See the [SMS Command Status Values](https://www.twilio.com/docs/wireless/api/smscommand-resource#status-values) for a description of each." }, "direction": { "type": "string", "$ref": "#/components/schemas/sms_command_enum_direction", "nullable": true, - "description": "The direction of the SMS Command" + "description": "The direction of the SMS Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 SMS Command resource" + "description": "The absolute URL of the SMS Command resource." } } }, @@ -775,7 +775,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that incurred the usage." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that incurred the usage." }, "sim_sid": { "type": "string", @@ -783,7 +783,7 @@ "maxLength": 34, "pattern": "^HS[0-9a-fA-F]{32}$", "nullable": true, - "description": "SID of a Sim resource to which the UsageRecord belongs." + "description": "SID of a Sim resource to which the UsageRecord belongs. Value will only be present when either a value for the `Sim` query parameter is provided or when UsageRecords are grouped by `sim`. Otherwise, the value will be `null`." }, "network_sid": { "type": "string", @@ -791,7 +791,7 @@ "maxLength": 34, "pattern": "^HW[0-9a-fA-F]{32}$", "nullable": true, - "description": "SID of the Network resource on which the usage occurred." + "description": "SID of the Network resource the usage occurred on. Value will only be present when either a value for the `Network` query parameter is provided or when UsageRecords are grouped by `network`. Otherwise, the value will be `null`." }, "fleet_sid": { "type": "string", @@ -799,17 +799,17 @@ "maxLength": 34, "pattern": "^HF[0-9a-fA-F]{32}$", "nullable": true, - "description": "SID of the Fleet resource on which the usage occurred." + "description": "SID of the Fleet resource the usage occurred on. Value will only be present when either a value for the `Fleet` query parameter is provided or when UsageRecords are grouped by `fleet`. Otherwise, the value will be `null`." }, "iso_country": { "type": "string", "format": "iso-country-code", "nullable": true, - "description": "Alpha-2 ISO Country Code of the country the usage occurred in." + "description": "Alpha-2 ISO Country Code that the usage occurred in. Value will only be present when either a value for the `IsoCountry` query parameter is provided or when UsageRecords are grouped by `isoCountry`. Otherwise, the value will be `null`." }, "period": { "nullable": true, - "description": "The time period for which the usage is reported." + "description": "The time period for which the usage is reported. The period is represented as a pair of `start_time` and `end_time` timestamps specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "data_upload": { "type": "integer", @@ -832,13 +832,13 @@ "data_total_billed": { "type": "number", "nullable": true, - "description": "Total amount in the `billed_unit` that was charged for the data uploaded or downloaded." + "description": "Total amount in the `billed_unit` that was charged for the data uploaded or downloaded. Will return 0 for usage prior to February 1, 2022. Value may be 0 despite `data_total` being greater than 0 if the data usage is still being processed by Twilio's billing system. Refer to [Data Usage Processing](https://www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) for more details." }, "billed_unit": { "type": "string", "format": "currency", "nullable": true, - "description": "The currency in which the billed amounts are measured, specified in the 3 letter ISO 4127 format (e.g. `USD`, `EUR`, `JPY`)." + "description": "The currency in which the billed amounts are measured, specified in the 3 letter ISO 4127 format (e.g. `USD`, `EUR`, `JPY`). This can be null when data_toal_billed is 0 and we do not yet have billing information for the corresponding data usage. Refer to [Data Usage Processing](https://www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) for more details." } } }, diff --git a/spec/json/twilio_sync_v1.json b/spec/json/twilio_sync_v1.json index 666c41b6..dc6ea7a1 100644 --- a/spec/json/twilio_sync_v1.json +++ b/spec/json/twilio_sync_v1.json @@ -10,12 +10,12 @@ "maxLength": 34, "pattern": "^ET[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Document resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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 and can be up to 320 characters long." }, "account_sid": { "type": "string", @@ -23,7 +23,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource." }, "service_sid": { "type": "string", @@ -31,51 +31,51 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync Service that the resource is associated with" + "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Document resource" + "description": "The absolute URL of the Document resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of resources related to the Sync Document" + "description": "The URLs of resources related to the Sync Document." }, "revision": { "type": "string", "nullable": true, - "description": "The current revision of the Sync Document, represented by a string identifier" + "description": "The current revision of the Sync Document, represented as a string. The `revision` property is used with conditional updates to ensure data consistency." }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the Sync Document stores" + "description": "An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length." }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Sync Document expires" + "description": "The date and time in GMT when the Sync Document expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync Document does not expire, this value is `null`. The Document resource might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync Document's creator" + "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`." } } }, @@ -88,7 +88,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document Permission resource." }, "service_sid": { "type": "string", @@ -96,7 +96,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync Service that the resource is associated with" + "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "document_sid": { "type": "string", @@ -104,33 +104,33 @@ "maxLength": 34, "pattern": "^ET[0-9a-fA-F]{32}$", "nullable": true, - "description": "The Sync Document SID" + "description": "The SID of the Sync Document to which the Document Permission applies." }, "identity": { "type": "string", "nullable": true, - "description": "The identity of the user to whom the Sync Document Permission applies" + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." }, "read": { "type": "boolean", "nullable": true, - "description": "Read access" + "description": "Whether the identity can read the Sync Document." }, "write": { "type": "boolean", "nullable": true, - "description": "Write access" + "description": "Whether the identity can update the Sync Document." }, "manage": { "type": "boolean", "nullable": true, - "description": "Manage access" + "description": "Whether the identity can delete the Sync Document." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Sync Document Permission resource" + "description": "The absolute URL of the Sync Document Permission resource." } } }, @@ -143,12 +143,12 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Service resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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. It is a read-only property, it cannot be assigned using REST API." }, "account_sid": { "type": "string", @@ -156,67 +156,67 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource." }, "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 Service resource" + "description": "The absolute URL of the Service resource." }, "webhook_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when Sync objects are manipulated" + "description": "The URL we call when Sync objects are manipulated." }, "webhooks_from_rest_enabled": { "type": "boolean", "nullable": true, - "description": "Whether the Service instance should call webhook_url when the REST API is used to update Sync objects" + "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`." }, "reachability_webhooks_enabled": { "type": "boolean", "nullable": true, - "description": "Whether the service instance calls webhook_url when client endpoints connect to Sync" + "description": "Whether the service instance calls `webhook_url` when client endpoints connect to Sync. The default is `false`." }, "acl_enabled": { "type": "boolean", "nullable": true, - "description": "Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource" + "description": "Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource. It is disabled (false) by default." }, "reachability_debouncing_enabled": { "type": "boolean", "nullable": true, - "description": "Whether every endpoint_disconnected event occurs after a configurable delay" + "description": "Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event." }, "reachability_debouncing_window": { "type": "integer", "nullable": true, - "description": "The reachability event delay in milliseconds" + "description": "The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before `webhook_url` is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -229,11 +229,11 @@ "maxLength": 34, "pattern": "^TZ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Stream Message resource." }, "data": { "nullable": true, - "description": "Stream Message body" + "description": "An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length." } } }, @@ -246,12 +246,12 @@ "maxLength": 34, "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Sync List resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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." }, "account_sid": { "type": "string", @@ -259,7 +259,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync List resource." }, "service_sid": { "type": "string", @@ -267,47 +267,47 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync Service that the resource is associated with" + "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Sync List resource" + "description": "The absolute URL of the Sync List resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the Sync List's nested resources" + "description": "The URLs of the Sync List's nested resources." }, "revision": { "type": "string", "nullable": true, - "description": "The current revision of the Sync List, represented as a string" + "description": "The current revision of the Sync List, represented as a string." }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Sync List expires" + "description": "The date and time in GMT when the Sync List expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync List does not expire, this value is `null`. The Sync List might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync List's creator" + "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`." } } }, @@ -317,7 +317,7 @@ "index": { "type": "integer", "nullable": true, - "description": "The automatically generated index of the List Item" + "description": "The automatically generated index of the List Item. The `index` values of the List Items in a Sync List can have gaps in their sequence." }, "account_sid": { "type": "string", @@ -325,7 +325,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the List Item resource." }, "service_sid": { "type": "string", @@ -333,7 +333,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync Service that the resource is associated with" + "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "list_sid": { "type": "string", @@ -341,45 +341,45 @@ "maxLength": 34, "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync List that contains the List Item" + "description": "The SID of the Sync List that contains the List Item." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the List Item resource" + "description": "The absolute URL of the List Item resource." }, "revision": { "type": "string", "nullable": true, - "description": "The current revision of the item, represented as a string" + "description": "The current revision of the item, represented as a string." }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the List Item stores" + "description": "An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length." }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the List Item expires" + "description": "The date and time in GMT when the List Item expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the List Item does not expire, this value is `null`. The List Item resource might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "created_by": { "type": "string", "nullable": true, - "description": "The identity of the List Item's creator" + "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`." } } }, @@ -406,7 +406,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync List Permission resource." }, "service_sid": { "type": "string", @@ -414,7 +414,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync Service that the resource is associated with" + "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "list_sid": { "type": "string", @@ -422,33 +422,33 @@ "maxLength": 34, "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync List to which the Permission applies" + "description": "The SID of the Sync List to which the Permission applies." }, "identity": { "type": "string", "nullable": true, - "description": "The identity of the user to whom the Sync List Permission applies" + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." }, "read": { "type": "boolean", "nullable": true, - "description": "Read access" + "description": "Whether the identity can read the Sync List and its Items." }, "write": { "type": "boolean", "nullable": true, - "description": "Write access" + "description": "Whether the identity can create, update, and delete Items in the Sync List." }, "manage": { "type": "boolean", "nullable": true, - "description": "Manage access" + "description": "Whether the identity can delete the Sync List." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Sync List Permission resource" + "description": "The absolute URL of the Sync List Permission resource." } } }, @@ -461,12 +461,12 @@ "maxLength": 34, "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Sync Map resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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." }, "account_sid": { "type": "string", @@ -474,7 +474,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Map resource." }, "service_sid": { "type": "string", @@ -482,47 +482,47 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync Service that the resource is associated with" + "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Sync Map resource" + "description": "The absolute URL of the Sync Map resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the Sync Map's nested resources" + "description": "The URLs of the Sync Map's nested resources." }, "revision": { "type": "string", "nullable": true, - "description": "The current revision of the Sync Map, represented as a string" + "description": "The current revision of the Sync Map, represented as a string." }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Sync Map expires" + "description": "The date and time in GMT when the Sync Map expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync Map does not expire, this value is `null`. The Sync Map might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync Map's creator" + "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`." } } }, @@ -532,7 +532,7 @@ "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." }, "account_sid": { "type": "string", @@ -540,7 +540,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Map Item resource." }, "service_sid": { "type": "string", @@ -548,7 +548,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync Service that the resource is associated with" + "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "map_sid": { "type": "string", @@ -556,45 +556,45 @@ "maxLength": 34, "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync Map that contains the Map Item" + "description": "The SID of the Sync Map that contains the Map Item." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Map Item resource" + "description": "The absolute URL of the Map Item resource." }, "revision": { "type": "string", "nullable": true, - "description": "The current revision of the Map Item, represented as a string" + "description": "The current revision of the Map Item, represented as a string." }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the Map Item stores" + "description": "An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length." }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Map Item expires" + "description": "The date and time in GMT when the Map Item expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Map Item does not expire, this value is `null`. The Map Item might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Map Item's creator" + "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`." } } }, @@ -621,7 +621,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Map Permission resource." }, "service_sid": { "type": "string", @@ -629,7 +629,7 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync Service that the resource is associated with" + "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "map_sid": { "type": "string", @@ -637,33 +637,33 @@ "maxLength": 34, "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true, - "description": "Sync Map SID" + "description": "The SID of the Sync Map to which the Permission applies." }, "identity": { "type": "string", "nullable": true, - "description": "The identity of the user to whom the Sync Document Permission applies" + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." }, "read": { "type": "boolean", "nullable": true, - "description": "Read access" + "description": "Whether the identity can read the Sync Map and its Items." }, "write": { "type": "boolean", "nullable": true, - "description": "Write access" + "description": "Whether the identity can create, update, and delete Items in the Sync Map." }, "manage": { "type": "boolean", "nullable": true, - "description": "Manage access" + "description": "Whether the identity can delete the Sync Map." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Sync Map Permission resource" + "description": "The absolute URL of the Sync Map Permission resource." } } }, @@ -676,12 +676,12 @@ "maxLength": 34, "pattern": "^TO[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Sync Stream resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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." }, "account_sid": { "type": "string", @@ -689,7 +689,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Stream resource." }, "service_sid": { "type": "string", @@ -697,42 +697,42 @@ "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sync Service that the resource is associated with" + "description": "The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Message Stream resource" + "description": "The absolute URL of the Message Stream resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the Stream's nested resources" + "description": "The URLs of the Stream's nested resources." }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Message Stream expires" + "description": "The date and time in GMT when the Message Stream expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Message Stream does not expire, this value is `null`. The Stream might not be deleted immediately after it expires." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "created_by": { "type": "string", "nullable": true, - "description": "The Identity of the Stream's creator" + "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'." } } } diff --git a/spec/json/twilio_taskrouter_v1.json b/spec/json/twilio_taskrouter_v1.json index 8291153c..4402a751 100644 --- a/spec/json/twilio_taskrouter_v1.json +++ b/spec/json/twilio_taskrouter_v1.json @@ -10,29 +10,29 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Activity resource." }, "available": { "type": "boolean", "nullable": true, - "description": "Whether the Worker should be eligible to receive a Task when it occupies the Activity" + "description": "Whether the Worker is eligible to receive a Task when it occupies the Activity. A value of `true`, `1`, or `yes` indicates the Activity is available. All other values indicate that it is not. The value cannot be changed after the Activity is created." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Activity resource" + "description": "The string that you assigned to describe the Activity resource." }, "sid": { "type": "string", @@ -40,7 +40,7 @@ "maxLength": 34, "pattern": "^WA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Activity resource." }, "workspace_sid": { "type": "string", @@ -48,13 +48,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the Activity" + "description": "The SID of the Workspace that contains the Activity." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Activity resource" + "description": "The absolute URL of the Activity resource." }, "links": { "type": "object", @@ -72,7 +72,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Event resource." }, "actor_sid": { "type": "string", @@ -80,44 +80,44 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the resource that triggered the event" + "description": "The SID of the resource that triggered the event." }, "actor_type": { "type": "string", "nullable": true, - "description": "The type of resource that triggered the event" + "description": "The type of resource that triggered the event." }, "actor_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource that triggered the event" + "description": "The absolute URL of the resource that triggered the event." }, "description": { "type": "string", "nullable": true, - "description": "A description of the event" + "description": "A description of the event." }, "event_data": { "nullable": true, - "description": "Data about the event" + "description": "Data about the event. For more information, see [Event types](https://www.twilio.com/docs/taskrouter/api/event#event-types)." }, "event_date": { "type": "string", "format": "date-time", "nullable": true, - "description": "The time the event was sent" + "description": "The time the event was sent, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "event_date_ms": { "type": "integer", "format": "int64", "nullable": true, - "description": "The time the event was sent in milliseconds" + "description": "The time the event was sent in milliseconds." }, "event_type": { "type": "string", "nullable": true, - "description": "The identifier for the event" + "description": "The identifier for the event." }, "resource_sid": { "type": "string", @@ -125,18 +125,18 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the object the event is most relevant to" + "description": "The SID of the object the event is most relevant to, such as a TaskSid, ReservationSid, or a WorkerSid." }, "resource_type": { "type": "string", "nullable": true, - "description": "The type of object the event is most relevant to" + "description": "The type of object the event is most relevant to, such as a Task, Reservation, or a Worker)." }, "resource_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the resource the event is most relevant to" + "description": "The URL of the resource the event is most relevant to." }, "sid": { "type": "string", @@ -144,23 +144,23 @@ "maxLength": 34, "pattern": "^EV[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Event resource." }, "source": { "type": "string", "nullable": true, - "description": "Where the Event originated" + "description": "Where the Event originated." }, "source_ip_address": { "type": "string", "nullable": true, - "description": "The IP from which the Event originated" + "description": "The IP from which the Event originated." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Event resource" + "description": "The absolute URL of the Event resource." }, "workspace_sid": { "type": "string", @@ -168,7 +168,7 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the Event" + "description": "The SID of the Workspace that contains the Event." } } }, @@ -181,56 +181,56 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Task resource." }, "age": { "type": "integer", "nullable": true, - "description": "The number of seconds since the Task was created" + "description": "The number of seconds since the Task was created." }, "assignment_status": { "type": "string", "$ref": "#/components/schemas/task_enum_status", "nullable": true, - "description": "The current status of the Task's assignment" + "description": "The current status of the Task's assignment. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string with custom attributes of the work" + "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." }, "addons": { "type": "string", "nullable": true, - "description": "An object that contains the addon data for all installed addons" + "description": "An object that contains the [addon](https://www.twilio.com/docs/taskrouter/marketplace) data for all installed addons." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "task_queue_entered_date": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Task entered the TaskQueue." + "description": "The date and time in GMT when the Task entered the TaskQueue, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "priority": { "type": "integer", "nullable": true, - "description": "Retrieve the list of all Tasks in the Workspace with the specified priority" + "description": "The current priority score of the Task as assigned to a Worker by the workflow. Tasks with higher priority values will be assigned before Tasks with lower values." }, "reason": { "type": "string", "nullable": true, - "description": "The reason the Task was canceled or completed" + "description": "The reason the Task was canceled or completed, if applicable." }, "sid": { "type": "string", @@ -238,7 +238,7 @@ "maxLength": 34, "pattern": "^WT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Task resource." }, "task_queue_sid": { "type": "string", @@ -246,12 +246,12 @@ "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the TaskQueue" + "description": "The SID of the TaskQueue." }, "task_queue_friendly_name": { "type": "string", "nullable": true, - "description": "The friendly name of the TaskQueue" + "description": "The friendly name of the TaskQueue." }, "task_channel_sid": { "type": "string", @@ -259,17 +259,17 @@ "maxLength": 34, "pattern": "^TC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the TaskChannel" + "description": "The SID of the TaskChannel." }, "task_channel_unique_name": { "type": "string", "nullable": true, - "description": "The unique name of the TaskChannel" + "description": "The unique name of the TaskChannel." }, "timeout": { "type": "integer", "nullable": true, - "description": "The amount of time in seconds that the Task can live before being assigned" + "description": "The amount of time in seconds that the Task can live before being assigned." }, "workflow_sid": { "type": "string", @@ -277,12 +277,12 @@ "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workflow that is controlling the Task" + "description": "The SID of the Workflow that is controlling the Task." }, "workflow_friendly_name": { "type": "string", "nullable": true, - "description": "The friendly name of the Workflow that is controlling the Task" + "description": "The friendly name of the Workflow that is controlling the Task." }, "workspace_sid": { "type": "string", @@ -290,19 +290,19 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the Task" + "description": "The SID of the Workspace that contains the Task." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Task resource" + "description": "The absolute URL of the Task resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -326,24 +326,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Task Channel resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "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." }, "sid": { "type": "string", @@ -351,12 +351,12 @@ "maxLength": 34, "pattern": "^TC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Task Channel resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Task Channel" + "description": "An application-defined string that uniquely identifies the Task Channel, such as `voice` or `sms`." }, "workspace_sid": { "type": "string", @@ -364,24 +364,24 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the Task Channel" + "description": "The SID of the Workspace that contains the Task Channel." }, "channel_optimized_routing": { "type": "boolean", "nullable": true, - "description": "Whether the Task Channel will prioritize Workers that have been idle" + "description": "Whether the Task Channel will prioritize Workers that have been idle. When `true`, Workers that have been idle the longest are prioritized." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Task Channel resource" + "description": "The absolute URL of the Task Channel resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -394,7 +394,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource." }, "assignment_activity_sid": { "type": "string", @@ -402,34 +402,34 @@ "maxLength": 34, "pattern": "^WA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Activity to assign Workers when a task is assigned for them" + "description": "The SID of the Activity to assign Workers when a task is assigned for them." }, "assignment_activity_name": { "type": "string", "nullable": true, - "description": "The name of the Activity to assign Workers when a task is assigned for them" + "description": "The name of the Activity to assign Workers when a task is assigned for them." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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" + "description": "The string that you assigned to describe the resource." }, "max_reserved_workers": { "type": "integer", "nullable": true, - "description": "The maximum number of Workers to reserve" + "description": "The maximum number of Workers to reserve for the assignment of a task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1." }, "reservation_activity_sid": { "type": "string", @@ -437,12 +437,12 @@ "maxLength": 34, "pattern": "^WA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Activity to assign Workers once a task is reserved for them" + "description": "The SID of the Activity to assign Workers once a task is reserved for them." }, "reservation_activity_name": { "type": "string", "nullable": true, - "description": "The name of the Activity to assign Workers once a task is reserved for them" + "description": "The name of the Activity to assign Workers once a task is reserved for them." }, "sid": { "type": "string", @@ -450,24 +450,24 @@ "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the TaskQueue resource." }, "target_workers": { "type": "string", "nullable": true, - "description": "A string describing the Worker selection criteria for any Tasks that enter the TaskQueue" + "description": "A string describing the Worker selection criteria for any Tasks that enter the TaskQueue. For example `'\"language\" == \"spanish\"'` If no TargetWorkers parameter is provided, Tasks will wait in the TaskQueue until they are either deleted or moved to another TaskQueue. Additional examples on how to describing Worker selection criteria below. Defaults to 1==1." }, "task_order": { "type": "string", "$ref": "#/components/schemas/task_queue_enum_task_order", "nullable": true, - "description": "How Tasks will be assigned to Workers" + "description": "How Tasks will be assigned to Workers. Set this parameter to `LIFO` to assign most recently created Task first or `FIFO` to assign the oldest Task. Default is FIFO. [Click here](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo) to learn more." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the TaskQueue resource" + "description": "The absolute URL of the TaskQueue resource." }, "workspace_sid": { "type": "string", @@ -475,13 +475,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the TaskQueue" + "description": "The SID of the Workspace that contains the TaskQueue." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -501,58 +501,58 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource." }, "avg_task_acceptance_time": { "type": "integer", "nullable": true, - "description": "The average time in seconds between Task creation and acceptance" + "description": "The average time in seconds between Task creation and acceptance." }, "start_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The beginning of the interval during which these statistics were calculated" + "description": "The beginning of the interval during which these statistics were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The end of the interval during which these statistics were calculated" + "description": "The end of the interval during which these statistics were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "reservations_created": { "type": "integer", "nullable": true, - "description": "The total number of Reservations created for Tasks in the TaskQueue" + "description": "The total number of Reservations created for Tasks in the TaskQueue." }, "reservations_accepted": { "type": "integer", "nullable": true, - "description": "The total number of Reservations accepted for Tasks in the TaskQueue" + "description": "The total number of Reservations accepted for Tasks in the TaskQueue." }, "reservations_rejected": { "type": "integer", "nullable": true, - "description": "The total number of Reservations rejected for Tasks in the TaskQueue" + "description": "The total number of Reservations rejected for Tasks in the TaskQueue." }, "reservations_timed_out": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that timed out for Tasks in the TaskQueue" + "description": "The total number of Reservations that timed out for Tasks in the TaskQueue." }, "reservations_canceled": { "type": "integer", "nullable": true, - "description": "The total number of Reservations canceled for Tasks in the TaskQueue" + "description": "The total number of Reservations canceled for Tasks in the TaskQueue." }, "reservations_rescinded": { "type": "integer", "nullable": true, - "description": "The total number of Reservations rescinded" + "description": "The total number of Reservations rescinded." }, "split_by_wait_time": { "nullable": true, - "description": "A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds" + "description": "A list of objects that describe the number of Tasks canceled and reservations accepted above and below the thresholds specified in seconds." }, "task_queue_sid": { "type": "string", @@ -560,44 +560,44 @@ "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the TaskQueue from which these statistics were calculated" + "description": "The SID of the TaskQueue from which these statistics were calculated." }, "wait_duration_until_accepted": { "nullable": true, - "description": "The wait duration statistics for Tasks accepted while in the TaskQueue" + "description": "The wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks accepted while in the TaskQueue. Calculation is based on the time when the Tasks were created. For transfers, the wait duration is counted from the moment ***the Task was created***, and not from when the transfer was initiated." }, "wait_duration_until_canceled": { "nullable": true, - "description": "The wait duration statistics for Tasks canceled while in the TaskQueue" + "description": "The wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks canceled while in the TaskQueue." }, "wait_duration_in_queue_until_accepted": { "nullable": true, - "description": "The relative wait duration statistics for Tasks accepted while in the TaskQueue" + "description": "The relative wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks accepted while in the TaskQueue. Calculation is based on the time when the Tasks entered the TaskQueue." }, "tasks_canceled": { "type": "integer", "nullable": true, - "description": "The total number of Tasks canceled in the TaskQueue" + "description": "The total number of Tasks canceled in the TaskQueue." }, "tasks_completed": { "type": "integer", "nullable": true, - "description": "The total number of Tasks completed in the TaskQueue" + "description": "The total number of Tasks completed in the TaskQueue." }, "tasks_deleted": { "type": "integer", "nullable": true, - "description": "The total number of Tasks deleted in the TaskQueue" + "description": "The total number of Tasks deleted in the TaskQueue." }, "tasks_entered": { "type": "integer", "nullable": true, - "description": "The total number of Tasks entered into the TaskQueue" + "description": "The total number of Tasks entered into the TaskQueue." }, "tasks_moved": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that were moved from one queue to another" + "description": "The total number of Tasks that were moved from one queue to another." }, "workspace_sid": { "type": "string", @@ -605,13 +605,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the TaskQueue" + "description": "The SID of the Workspace that contains the TaskQueue." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the TaskQueue statistics resource" + "description": "The absolute URL of the TaskQueue statistics resource." } } }, @@ -624,18 +624,18 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource." }, "activity_statistics": { "type": "array", "items": {}, "nullable": true, - "description": "The number of current Workers by Activity" + "description": "The number of current Workers by Activity." }, "longest_task_waiting_age": { "type": "integer", "nullable": true, - "description": "The age of the longest waiting Task" + "description": "The age of the longest waiting Task." }, "longest_task_waiting_sid": { "type": "string", @@ -643,12 +643,12 @@ "maxLength": 34, "pattern": "^WT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the longest waiting Task" + "description": "The SID of the longest waiting Task." }, "longest_relative_task_age_in_queue": { "type": "integer", "nullable": true, - "description": "The relative age in the TaskQueue for the longest waiting Task." + "description": "The relative age in the TaskQueue for the longest waiting Task. Calculation is based on the time when the Task entered the TaskQueue." }, "longest_relative_task_sid_in_queue": { "type": "string", @@ -656,7 +656,7 @@ "maxLength": 34, "pattern": "^WT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Task waiting in the TaskQueue the longest." + "description": "The Task SID of the Task waiting in the TaskQueue the longest. Calculation is based on the time when the Task entered the TaskQueue." }, "task_queue_sid": { "type": "string", @@ -664,30 +664,30 @@ "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the TaskQueue from which these statistics were calculated" + "description": "The SID of the TaskQueue from which these statistics were calculated." }, "tasks_by_priority": { "nullable": true, - "description": "The number of Tasks by priority" + "description": "The number of Tasks by priority. For example: `{\"0\": \"10\", \"99\": \"5\"}` shows 10 Tasks at priority 0 and 5 at priority 99." }, "tasks_by_status": { "nullable": true, - "description": "The number of Tasks by their current status" + "description": "The number of Tasks by their current status. For example: `{\"pending\": \"1\", \"reserved\": \"3\", \"assigned\": \"2\", \"completed\": \"5\"}`." }, "total_available_workers": { "type": "integer", "nullable": true, - "description": "The total number of Workers available for Tasks in the TaskQueue" + "description": "The total number of Workers available for Tasks in the TaskQueue." }, "total_eligible_workers": { "type": "integer", "nullable": true, - "description": "The total number of Workers eligible for Tasks in the TaskQueue, independent of their Activity state" + "description": "The total number of Workers eligible for Tasks in the TaskQueue, independent of their Activity state." }, "total_tasks": { "type": "integer", "nullable": true, - "description": "The total number of Tasks" + "description": "The total number of Tasks." }, "workspace_sid": { "type": "string", @@ -695,13 +695,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the TaskQueue" + "description": "The SID of the Workspace that contains the TaskQueue." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the TaskQueue statistics resource" + "description": "The absolute URL of the TaskQueue statistics resource." } } }, @@ -714,15 +714,15 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource." }, "cumulative": { "nullable": true, - "description": "An object that contains the cumulative statistics for the TaskQueue" + "description": "An object that contains the cumulative statistics for the TaskQueue." }, "realtime": { "nullable": true, - "description": "An object that contains the real-time statistics for the TaskQueue" + "description": "An object that contains the real-time statistics for the TaskQueue." }, "task_queue_sid": { "type": "string", @@ -730,7 +730,7 @@ "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the TaskQueue from which these statistics were calculated" + "description": "The SID of the TaskQueue from which these statistics were calculated." }, "workspace_sid": { "type": "string", @@ -738,13 +738,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the TaskQueue" + "description": "The SID of the Workspace that contains the TaskQueue." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the TaskQueue statistics resource" + "description": "The absolute URL of the TaskQueue statistics resource." } } }, @@ -757,15 +757,15 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource." }, "cumulative": { "nullable": true, - "description": "An object that contains the cumulative statistics for the TaskQueues" + "description": "An object that contains the cumulative statistics for the TaskQueues." }, "realtime": { "nullable": true, - "description": "An object that contains the real-time statistics for the TaskQueues" + "description": "An object that contains the real-time statistics for the TaskQueues." }, "task_queue_sid": { "type": "string", @@ -773,7 +773,7 @@ "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the TaskQueue from which these statistics were calculated" + "description": "The SID of the TaskQueue from which these statistics were calculated." }, "workspace_sid": { "type": "string", @@ -781,7 +781,7 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the TaskQueues" + "description": "The SID of the Workspace that contains the TaskQueues." } } }, @@ -794,25 +794,25 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskReservation resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "reservation_status": { "type": "string", "$ref": "#/components/schemas/task_reservation_enum_status", "nullable": true, - "description": "The current status of the reservation" + "description": "The current status of the reservation. Can be: `pending`, `accepted`, `rejected`, or `timeout`." }, "sid": { "type": "string", @@ -820,7 +820,7 @@ "maxLength": 34, "pattern": "^WR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the TaskReservation resource." }, "task_sid": { "type": "string", @@ -828,12 +828,12 @@ "maxLength": 34, "pattern": "^WT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the reserved Task resource" + "description": "The SID of the reserved Task resource." }, "worker_name": { "type": "string", "nullable": true, - "description": "The friendly_name of the Worker that is reserved" + "description": "The `friendly_name` of the Worker that is reserved." }, "worker_sid": { "type": "string", @@ -841,7 +841,7 @@ "maxLength": 34, "pattern": "^WK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the reserved Worker resource" + "description": "The SID of the reserved Worker resource." }, "workspace_sid": { "type": "string", @@ -855,13 +855,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the TaskReservation reservation" + "description": "The absolute URL of the TaskReservation reservation." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -916,12 +916,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Worker resource." }, "activity_name": { "type": "string", "nullable": true, - "description": "The friendly_name of the Worker's current Activity" + "description": "The `friendly_name` of the Worker's current Activity." }, "activity_sid": { "type": "string", @@ -929,40 +929,40 @@ "maxLength": 34, "pattern": "^WA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Worker's current Activity" + "description": "The SID of the Worker's current Activity." }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that describes 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." }, "available": { "type": "boolean", "nullable": true, - "description": "Whether the Worker is available to perform tasks" + "description": "Whether the Worker is available to perform tasks." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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_status_changed": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date and time in GMT of the last change to the Worker's activity" + "description": "The date and time in GMT of the last change to the Worker's activity specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Used to calculate Workflow statistics." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "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. Friendly names are case insensitive, and unique within the TaskRouter Workspace." }, "sid": { "type": "string", @@ -970,7 +970,7 @@ "maxLength": 34, "pattern": "^WK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Worker resource." }, "workspace_sid": { "type": "string", @@ -978,19 +978,19 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the Worker" + "description": "The SID of the Workspace that contains the Worker." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Worker resource" + "description": "The absolute URL of the Worker resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -1003,39 +1003,39 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Worker resource." }, "assigned_tasks": { "type": "integer", "nullable": true, - "description": "The total number of Tasks assigned to Worker for the TaskChannel type" + "description": "The total number of Tasks assigned to Worker for the TaskChannel type." }, "available": { "type": "boolean", "nullable": true, - "description": "Whether the Worker should receive Tasks of the TaskChannel type" + "description": "Whether the Worker should receive Tasks of the TaskChannel type." }, "available_capacity_percentage": { "type": "integer", "nullable": true, - "description": "The current available capacity between 0 to 100 for the TaskChannel" + "description": "The current percentage of capacity the TaskChannel has available. Can be a number between `0` and `100`. A value of `0` indicates that TaskChannel has no capacity available and a value of `100` means the Worker is available to receive any Tasks of this TaskChannel type." }, "configured_capacity": { "type": "integer", "nullable": true, - "description": "The current configured capacity for the WorkerChannel" + "description": "The current configured capacity for the WorkerChannel. TaskRouter will not create any reservations after the assigned Tasks for the Worker reaches the value." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "sid": { "type": "string", @@ -1043,7 +1043,7 @@ "maxLength": 34, "pattern": "^WC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the WorkerChannel resource." }, "task_channel_sid": { "type": "string", @@ -1051,12 +1051,12 @@ "maxLength": 34, "pattern": "^TC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the TaskChannel" + "description": "The SID of the TaskChannel." }, "task_channel_unique_name": { "type": "string", "nullable": true, - "description": "The unique name of the TaskChannel, such as 'voice' or 'sms'" + "description": "The unique name of the TaskChannel, such as `voice` or `sms`." }, "worker_sid": { "type": "string", @@ -1064,7 +1064,7 @@ "maxLength": 34, "pattern": "^WK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Worker that contains the WorkerChannel" + "description": "The SID of the Worker that contains the WorkerChannel." }, "workspace_sid": { "type": "string", @@ -1072,13 +1072,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the WorkerChannel" + "description": "The SID of the Workspace that contains the WorkerChannel." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the WorkerChannel resource" + "description": "The absolute URL of the WorkerChannel resource." } } }, @@ -1091,11 +1091,11 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Worker resource." }, "cumulative": { "nullable": true, - "description": "An object that contains the cumulative statistics for the Worker" + "description": "An object that contains the cumulative statistics for the Worker." }, "worker_sid": { "type": "string", @@ -1103,7 +1103,7 @@ "maxLength": 34, "pattern": "^WK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Worker that contains the WorkerChannel" + "description": "The SID of the Worker that contains the WorkerChannel." }, "workspace_sid": { "type": "string", @@ -1111,13 +1111,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the WorkerChannel" + "description": "The SID of the Workspace that contains the WorkerChannel." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the WorkerChannel statistics resource" + "description": "The absolute URL of the WorkerChannel statistics resource." } } }, @@ -1130,25 +1130,25 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the WorkerReservation resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "reservation_status": { "type": "string", "$ref": "#/components/schemas/worker_reservation_enum_status", "nullable": true, - "description": "The current status of the reservation" + "description": "The current status of the reservation. Can be: `pending`, `accepted`, `rejected`, `timeout`, `canceled`, or `rescinded`." }, "sid": { "type": "string", @@ -1156,7 +1156,7 @@ "maxLength": 34, "pattern": "^WR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the WorkerReservation resource." }, "task_sid": { "type": "string", @@ -1164,12 +1164,12 @@ "maxLength": 34, "pattern": "^WT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the reserved Task resource" + "description": "The SID of the reserved Task resource." }, "worker_name": { "type": "string", "nullable": true, - "description": "The friendly_name of the Worker that is reserved" + "description": "The `friendly_name` of the Worker that is reserved." }, "worker_sid": { "type": "string", @@ -1177,7 +1177,7 @@ "maxLength": 34, "pattern": "^WK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the reserved Worker resource" + "description": "The SID of the reserved Worker resource." }, "workspace_sid": { "type": "string", @@ -1191,13 +1191,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the WorkerReservation resource" + "description": "The absolute URL of the WorkerReservation resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -1240,11 +1240,11 @@ "properties": { "realtime": { "nullable": true, - "description": "An object that contains the real-time statistics for the Worker" + "description": "An object that contains the real-time statistics for the Worker." }, "cumulative": { "nullable": true, - "description": "An object that contains the cumulative statistics for the Worker" + "description": "An object that contains the cumulative statistics for the Worker." }, "account_sid": { "type": "string", @@ -1252,7 +1252,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Worker resource." }, "workspace_sid": { "type": "string", @@ -1260,13 +1260,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the Worker" + "description": "The SID of the Workspace that contains the Worker." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Worker statistics resource" + "description": "The absolute URL of the Worker statistics resource." } } }, @@ -1279,55 +1279,55 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Worker resource." }, "start_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The beginning of the interval during which these statistics were calculated" + "description": "The beginning of the interval during which these statistics were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The end of the interval during which these statistics were calculated" + "description": "The end of the interval during which these statistics were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "activity_durations": { "type": "array", "items": {}, "nullable": true, - "description": "The minimum, average, maximum, and total time that Workers spent in each Activity" + "description": "The minimum, average, maximum, and total time (in seconds) that Workers spent in each Activity." }, "reservations_created": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were created" + "description": "The total number of Reservations that were created." }, "reservations_accepted": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were accepted" + "description": "The total number of Reservations that were accepted." }, "reservations_rejected": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were rejected" + "description": "The total number of Reservations that were rejected." }, "reservations_timed_out": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were timed out" + "description": "The total number of Reservations that were timed out." }, "reservations_canceled": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were canceled" + "description": "The total number of Reservations that were canceled." }, "reservations_rescinded": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were rescinded" + "description": "The total number of Reservations that were rescinded." }, "workspace_sid": { "type": "string", @@ -1335,13 +1335,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the Workers" + "description": "The SID of the Workspace that contains the Workers." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Workers statistics resource" + "description": "The absolute URL of the Workers statistics resource." } } }, @@ -1354,18 +1354,18 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Worker resource." }, "activity_statistics": { "type": "array", "items": {}, "nullable": true, - "description": "The number of current Workers by Activity" + "description": "The number of current Workers by Activity." }, "total_workers": { "type": "integer", "nullable": true, - "description": "The total number of Workers" + "description": "The total number of Workers." }, "workspace_sid": { "type": "string", @@ -1373,13 +1373,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the Workers" + "description": "The SID of the Workspace that contains the Workers." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Workers statistics resource" + "description": "The absolute URL of the Workers statistics resource." } } }, @@ -1392,46 +1392,46 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workflow resource." }, "assignment_callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when a task managed by the Workflow is assigned to a Worker" + "description": "The URL that we call when a task managed by the Workflow is assigned to a Worker. See Assignment Callback URL for more information." }, "configuration": { "type": "string", "nullable": true, - "description": "A JSON string that contains the Workflow's configuration" + "description": "A JSON string that contains the Workflow's configuration. See [Configuring Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for more information." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "document_content_type": { "type": "string", "nullable": true, - "description": "The MIME type of the document" + "description": "The MIME type of the document." }, "fallback_assignment_callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when a call to the `assignment_callback_url` fails" + "description": "The URL that we call when a call to the `assignment_callback_url` fails." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Workflow resource" + "description": "The string that you assigned to describe the Workflow resource. For example, `Customer Support` or `2014 Election Campaign`." }, "sid": { "type": "string", @@ -1439,12 +1439,12 @@ "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Workflow resource." }, "task_reservation_timeout": { "type": "integer", "nullable": true, - "description": "How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker" + "description": "How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` (24 hours) and the default is `120`." }, "workspace_sid": { "type": "string", @@ -1452,19 +1452,19 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the Workflow" + "description": "The SID of the Workspace that contains the Workflow." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Workflow resource" + "description": "The absolute URL of the Workflow resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -1477,96 +1477,96 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workflow resource." }, "avg_task_acceptance_time": { "type": "integer", "nullable": true, - "description": "The average time in seconds between Task creation and acceptance" + "description": "The average time in seconds between Task creation and acceptance." }, "start_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The beginning of the interval during which these statistics were calculated" + "description": "The beginning of the interval during which these statistics were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The end of the interval during which these statistics were calculated" + "description": "The end of the interval during which these statistics were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "reservations_created": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were created for Workers" + "description": "The total number of Reservations that were created for Workers." }, "reservations_accepted": { "type": "integer", "nullable": true, - "description": "The total number of Reservations accepted by Workers" + "description": "The total number of Reservations accepted by Workers." }, "reservations_rejected": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were rejected" + "description": "The total number of Reservations that were rejected." }, "reservations_timed_out": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were timed out" + "description": "The total number of Reservations that were timed out." }, "reservations_canceled": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were canceled" + "description": "The total number of Reservations that were canceled." }, "reservations_rescinded": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were rescinded" + "description": "The total number of Reservations that were rescinded." }, "split_by_wait_time": { "nullable": true, - "description": "A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds" + "description": "A list of objects that describe the number of Tasks canceled and reservations accepted above and below the thresholds specified in seconds." }, "wait_duration_until_accepted": { "nullable": true, - "description": "The wait duration statistics for Tasks that were accepted" + "description": "The wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks that were accepted." }, "wait_duration_until_canceled": { "nullable": true, - "description": "The wait duration statistics for Tasks that were canceled" + "description": "The wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks that were canceled." }, "tasks_canceled": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that were canceled" + "description": "The total number of Tasks that were canceled." }, "tasks_completed": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that were completed" + "description": "The total number of Tasks that were completed." }, "tasks_entered": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that entered the Workflow" + "description": "The total number of Tasks that entered the Workflow." }, "tasks_deleted": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that were deleted" + "description": "The total number of Tasks that were deleted." }, "tasks_moved": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that were moved from one queue to another" + "description": "The total number of Tasks that were moved from one queue to another." }, "tasks_timed_out_in_workflow": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that were timed out of their Workflows" + "description": "The total number of Tasks that were timed out of their Workflows (and deleted)." }, "workflow_sid": { "type": "string", @@ -1574,7 +1574,7 @@ "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$", "nullable": true, - "description": "Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value" + "description": "Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value." }, "workspace_sid": { "type": "string", @@ -1588,7 +1588,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Workflow statistics resource" + "description": "The absolute URL of the Workflow statistics resource." } } }, @@ -1601,12 +1601,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workflow resource." }, "longest_task_waiting_age": { "type": "integer", "nullable": true, - "description": "The age of the longest waiting Task" + "description": "The age of the longest waiting Task." }, "longest_task_waiting_sid": { "type": "string", @@ -1614,20 +1614,20 @@ "maxLength": 34, "pattern": "^WT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the longest waiting Task" + "description": "The SID of the longest waiting Task." }, "tasks_by_priority": { "nullable": true, - "description": "The number of Tasks by priority" + "description": "The number of Tasks by priority. For example: `{\"0\": \"10\", \"99\": \"5\"}` shows 10 Tasks at priority 0 and 5 at priority 99." }, "tasks_by_status": { "nullable": true, - "description": "The number of Tasks by their current status" + "description": "The number of Tasks by their current status. For example: `{\"pending\": \"1\", \"reserved\": \"3\", \"assigned\": \"2\", \"completed\": \"5\"}`." }, "total_tasks": { "type": "integer", "nullable": true, - "description": "The total number of Tasks" + "description": "The total number of Tasks." }, "workflow_sid": { "type": "string", @@ -1635,7 +1635,7 @@ "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$", "nullable": true, - "description": "Returns the list of Tasks that are being controlled by the Workflow with the specified SID value" + "description": "Returns the list of Tasks that are being controlled by the Workflow with the specified SID value." }, "workspace_sid": { "type": "string", @@ -1649,7 +1649,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Workflow statistics resource" + "description": "The absolute URL of the Workflow statistics resource." } } }, @@ -1662,15 +1662,15 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workflow resource." }, "cumulative": { "nullable": true, - "description": "An object that contains the cumulative statistics for the Workflow" + "description": "An object that contains the cumulative statistics for the Workflow." }, "realtime": { "nullable": true, - "description": "An object that contains the real-time statistics for the Workflow" + "description": "An object that contains the real-time statistics for the Workflow." }, "workflow_sid": { "type": "string", @@ -1678,7 +1678,7 @@ "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$", "nullable": true, - "description": "Returns the list of Tasks that are being controlled by the Workflow with the specified SID value" + "description": "Returns the list of Tasks that are being controlled by the Workflow with the specified SID value." }, "workspace_sid": { "type": "string", @@ -1686,13 +1686,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace that contains the Workflow" + "description": "The SID of the Workspace that contains the Workflow." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Workflow statistics resource" + "description": "The absolute URL of the Workflow statistics resource." } } }, @@ -1705,24 +1705,24 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workspace resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "default_activity_name": { "type": "string", "nullable": true, - "description": "The name of the default activity" + "description": "The name of the default activity." }, "default_activity_sid": { "type": "string", @@ -1730,28 +1730,28 @@ "maxLength": 34, "pattern": "^WA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Activity that will be used when new Workers are created in the Workspace" + "description": "The SID of the Activity that will be used when new Workers are created in the Workspace." }, "event_callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when an event occurs" + "description": "The URL we call when an event occurs. If provided, the Workspace will publish events to this URL, for example, to collect data for reporting. See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for more information. This parameter supports Twilio's [Webhooks (HTTP callbacks) Connection Overrides](https://www.twilio.com/docs/usage/webhooks/webhooks-connection-overrides)." }, "events_filter": { "type": "string", "nullable": true, - "description": "The list of Workspace events for which to call event_callback_url" + "description": "The list of Workspace events for which to call `event_callback_url`. For example, if `EventsFilter=task.created, task.canceled, worker.activity.update`, then TaskRouter will call event_callback_url only when a task is created, canceled, or a Worker activity is updated." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Workspace resource" + "description": "The string that you assigned to describe the Workspace resource. For example `Customer Support` or `2014 Election Campaign`." }, "multi_task_enabled": { "type": "boolean", "nullable": true, - "description": "Whether multi-tasking is enabled" + "description": "Whether multi-tasking is enabled. The default is `true`, which enables multi-tasking. Multi-tasking allows Workers to handle multiple Tasks simultaneously. When enabled (`true`), each Worker can receive parallel reservations up to the per-channel maximums defined in the Workers section. In single-tasking each Worker would only receive a new reservation when the previous task is completed. Learn more at [Multitasking](https://www.twilio.com/docs/taskrouter/multitasking)." }, "sid": { "type": "string", @@ -1759,12 +1759,12 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Workspace resource." }, "timeout_activity_name": { "type": "string", "nullable": true, - "description": "The name of the timeout activity" + "description": "The name of the timeout activity." }, "timeout_activity_sid": { "type": "string", @@ -1772,25 +1772,25 @@ "maxLength": 34, "pattern": "^WA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response" + "description": "The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response." }, "prioritize_queue_order": { "type": "string", "$ref": "#/components/schemas/workspace_enum_queue_order", "nullable": true, - "description": "The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues" + "description": "The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo)." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Workspace resource" + "description": "The absolute URL of the Workspace resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -1810,96 +1810,96 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workspace resource." }, "avg_task_acceptance_time": { "type": "integer", "nullable": true, - "description": "The average time in seconds between Task creation and acceptance" + "description": "The average time in seconds between Task creation and acceptance." }, "start_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The beginning of the interval during which these statistics were calculated" + "description": "The beginning of the interval during which these statistics were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The end of the interval during which these statistics were calculated" + "description": "The end of the interval during which these statistics were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "reservations_created": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were created for Workers" + "description": "The total number of Reservations that were created for Workers." }, "reservations_accepted": { "type": "integer", "nullable": true, - "description": "The total number of Reservations accepted by Workers" + "description": "The total number of Reservations accepted by Workers." }, "reservations_rejected": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were rejected" + "description": "The total number of Reservations that were rejected." }, "reservations_timed_out": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were timed out" + "description": "The total number of Reservations that were timed out." }, "reservations_canceled": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were canceled" + "description": "The total number of Reservations that were canceled." }, "reservations_rescinded": { "type": "integer", "nullable": true, - "description": "The total number of Reservations that were rescinded" + "description": "The total number of Reservations that were rescinded." }, "split_by_wait_time": { "nullable": true, - "description": "A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds" + "description": "A list of objects that describe the number of Tasks canceled and reservations accepted above and below the thresholds specified in seconds." }, "wait_duration_until_accepted": { "nullable": true, - "description": "The wait duration statistics for Tasks that were accepted" + "description": "The wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks that were accepted." }, "wait_duration_until_canceled": { "nullable": true, - "description": "The wait duration statistics for Tasks that were canceled" + "description": "The wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks that were canceled." }, "tasks_canceled": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that were canceled" + "description": "The total number of Tasks that were canceled." }, "tasks_completed": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that were completed" + "description": "The total number of Tasks that were completed." }, "tasks_created": { "type": "integer", "nullable": true, - "description": "The total number of Tasks created" + "description": "The total number of Tasks created." }, "tasks_deleted": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that were deleted" + "description": "The total number of Tasks that were deleted." }, "tasks_moved": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that were moved from one queue to another" + "description": "The total number of Tasks that were moved from one queue to another." }, "tasks_timed_out_in_workflow": { "type": "integer", "nullable": true, - "description": "The total number of Tasks that were timed out of their Workflows" + "description": "The total number of Tasks that were timed out of their Workflows (and deleted)." }, "workspace_sid": { "type": "string", @@ -1907,13 +1907,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace" + "description": "The SID of the Workspace." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Workspace statistics resource" + "description": "The absolute URL of the Workspace statistics resource." } } }, @@ -1926,18 +1926,18 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workspace resource." }, "activity_statistics": { "type": "array", "items": {}, "nullable": true, - "description": "The number of current Workers by Activity" + "description": "The number of current Workers by Activity." }, "longest_task_waiting_age": { "type": "integer", "nullable": true, - "description": "The age of the longest waiting Task" + "description": "The age of the longest waiting Task." }, "longest_task_waiting_sid": { "type": "string", @@ -1945,25 +1945,25 @@ "maxLength": 34, "pattern": "^WT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the longest waiting Task" + "description": "The SID of the longest waiting Task." }, "tasks_by_priority": { "nullable": true, - "description": "The number of Tasks by priority" + "description": "The number of Tasks by priority. For example: `{\"0\": \"10\", \"99\": \"5\"}` shows 10 Tasks at priority 0 and 5 at priority 99." }, "tasks_by_status": { "nullable": true, - "description": "The number of Tasks by their current status" + "description": "The number of Tasks by their current status. For example: `{\"pending\": \"1\", \"reserved\": \"3\", \"assigned\": \"2\", \"completed\": \"5\"}`." }, "total_tasks": { "type": "integer", "nullable": true, - "description": "The total number of Tasks" + "description": "The total number of Tasks." }, "total_workers": { "type": "integer", "nullable": true, - "description": "The total number of Workers in the Workspace" + "description": "The total number of Workers in the Workspace." }, "workspace_sid": { "type": "string", @@ -1971,13 +1971,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace" + "description": "The SID of the Workspace." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Workspace statistics resource" + "description": "The absolute URL of the Workspace statistics resource." } } }, @@ -1986,11 +1986,11 @@ "properties": { "realtime": { "nullable": true, - "description": "n object that contains the real-time statistics for the Workspace" + "description": "An object that contains the real-time statistics for the Workspace." }, "cumulative": { "nullable": true, - "description": "An object that contains the cumulative statistics for the Workspace" + "description": "An object that contains the cumulative statistics for the Workspace." }, "account_sid": { "type": "string", @@ -1998,7 +1998,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workspace resource." }, "workspace_sid": { "type": "string", @@ -2006,13 +2006,13 @@ "maxLength": 34, "pattern": "^WS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Workspace" + "description": "The SID of the Workspace." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Workspace statistics resource" + "description": "The absolute URL of the Workspace statistics resource." } } } diff --git a/spec/json/twilio_trunking_v1.json b/spec/json/twilio_trunking_v1.json index 555e2af7..d2410bc4 100644 --- a/spec/json/twilio_trunking_v1.json +++ b/spec/json/twilio_trunking_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialList resource." }, "sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^CL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the CredentialList resource." }, "trunk_sid": { "type": "string", @@ -26,30 +26,30 @@ "maxLength": 34, "pattern": "^TK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Trunk the credential list in associated with" + "description": "The SID of the Trunk the credential list in associated with." }, "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -62,7 +62,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IpAccessControlList resource." }, "sid": { "type": "string", @@ -70,7 +70,7 @@ "maxLength": 34, "pattern": "^AL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the IpAccessControlList resource." }, "trunk_sid": { "type": "string", @@ -78,30 +78,30 @@ "maxLength": 34, "pattern": "^TK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Trunk the resource is associated with" + "description": "The SID of the Trunk the resource is associated with." }, "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -114,7 +114,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OriginationUrl resource." }, "sid": { "type": "string", @@ -122,7 +122,7 @@ "maxLength": 34, "pattern": "^OU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the OriginationUrl resource." }, "trunk_sid": { "type": "string", @@ -130,51 +130,51 @@ "maxLength": 34, "pattern": "^TK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Trunk that owns the Origination URL" + "description": "The SID of the Trunk that owns the Origination URL." }, "weight": { "type": "integer", "nullable": true, - "description": "The value that determines the relative load the URI should receive compared to others with the same priority" + "description": "The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority." }, "enabled": { "type": "boolean", "nullable": true, - "description": "Whether the URL is enabled" + "description": "Whether the URL is enabled. The default is `true`." }, "sip_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The SIP address you want Twilio to route your Origination calls to" + "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema." }, "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." }, "priority": { "type": "integer", "nullable": true, - "description": "The relative importance of the URI" + "description": "The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -187,58 +187,58 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the PhoneNumber resource." }, "address_requirements": { "type": "string", "$ref": "#/components/schemas/phone_number_enum_address_requirement", "nullable": true, - "description": "Whether the phone number requires an Address registered with Twilio" + "description": "Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) registered with Twilio and, if so, what type. Can be: `none`, `any`, `local`, or `foreign`." }, "api_version": { "type": "string", "nullable": true, - "description": "The API version used to start a new TwiML session" + "description": "The API version used to start a new TwiML session." }, "beta": { "type": "boolean", "nullable": true, - "description": "Whether the phone number is new to the Twilio platform" + "description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`." }, "capabilities": { "type": "object", "format": "string-map", "nullable": true, - "description": "Indicate if a phone can receive calls or messages" + "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`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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" + "description": "The string that you assigned to describe the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in E.164 format" + "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." }, "sid": { "type": "string", @@ -246,7 +246,7 @@ "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the PhoneNumber resource." }, "sms_application_sid": { "type": "string", @@ -254,7 +254,7 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the application that handles SMS messages sent to the phone number" + "description": "The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application." }, "sms_fallback_method": { "type": "string", @@ -268,13 +268,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with sms_fallback_url" + "description": "The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`." }, "sms_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML" + "description": "The URL that we call using the `sms_fallback_method` when an error occurs while retrieving or executing the TwiML from `sms_url`." }, "sms_method": { "type": "string", @@ -288,19 +288,19 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method to use with sms_url" + "description": "The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`." }, "sms_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives an incoming SMS message" + "description": "The URL we call using the `sms_method` when the phone number receives an incoming SMS message." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to send status information to your application" + "description": "The URL we call using the `status_callback_method` to send status information to your application." }, "status_callback_method": { "type": "string", @@ -314,7 +314,7 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call status_callback" + "description": "The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`." }, "trunk_sid": { "type": "string", @@ -322,13 +322,13 @@ "maxLength": 34, "pattern": "^TK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Trunk that handles calls to the phone number" + "description": "The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice URLs and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "voice_application_sid": { "type": "string", @@ -336,12 +336,12 @@ "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the application that handles calls to the phone number" + "description": "The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice URLs and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa." }, "voice_caller_id_lookup": { "type": "boolean", "nullable": true, - "description": "Whether to lookup the caller's name" + "description": "Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: `true` or `false`." }, "voice_fallback_method": { "type": "string", @@ -355,13 +355,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method that we use to call voice_fallback_url" + "description": "The HTTP method that we use to call `voice_fallback_url`. Can be: `GET` or `POST`." }, "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when an error occurs in TwiML" + "description": "The URL that we call using the `voice_fallback_method` when an error occurs retrieving or executing the TwiML requested by `url`." }, "voice_method": { "type": "string", @@ -375,13 +375,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with the voice_url" + "description": "The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`." }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the phone number receives a call" + "description": "The URL we call using the `voice_method` when the phone number receives a call. The `voice_url` is not be used if a `voice_application_sid` or a `trunk_sid` is set." } } }, @@ -401,13 +401,13 @@ "type": "string", "$ref": "#/components/schemas/recording_enum_recording_mode", "nullable": true, - "description": "The recording mode for the trunk." + "description": "The recording mode for the trunk. Can be do-not-record (default), record-from-ringing, record-from-answer, record-from-ringing-dual, or record-from-answer-dual." }, "trim": { "type": "string", "$ref": "#/components/schemas/recording_enum_recording_trim", "nullable": true, - "description": "The recording trim setting for the trunk." + "description": "The recording trim setting for the trunk. Can be do-not-trim (default) or trim-silence." } } }, @@ -437,12 +437,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Trunk resource." }, "domain_name": { "type": "string", "nullable": true, - "description": "The unique address you reserve on Twilio to which you route your SIP traffic" + "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and `-` and must end with `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) for more information." }, "disaster_recovery_method": { "type": "string", @@ -456,49 +456,49 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call the disaster_recovery_url" + "description": "The HTTP method we use to call the `disaster_recovery_url`. Can be: `GET` or `POST`." }, "disaster_recovery_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The HTTP URL that we call if an error occurs while sending SIP traffic towards your configured Origination URL" + "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." }, "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." }, "secure": { "type": "boolean", "nullable": true, - "description": "Whether Secure Trunking is enabled for the trunk" + "description": "Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more information." }, "recording": { "nullable": true, - "description": "The recording settings for the trunk" + "description": "The recording settings for the trunk. Can be: `do-not-record`, `record-from-ringing`, `record-from-answer`. If set to `record-from-ringing` or `record-from-answer`, all calls going through the trunk will be recorded. The only way to change recording parameters is on a sub-resource of a Trunk after it has been created. e.g.`/Trunks/[Trunk_SID]/Recording -XPOST -d'Mode=record-from-answer'`. See [Recording](https://www.twilio.com/docs/sip-trunking#recording) for more information." }, "transfer_mode": { "type": "string", "$ref": "#/components/schemas/trunk_enum_transfer_setting", "nullable": true, - "description": "The call transfer settings for the trunk" + "description": "The call transfer settings for the trunk. Can be: `enable-all`, `sip-only` and `disable-all`. See [Transfer](https://www.twilio.com/docs/sip-trunking/call-transfer) for more information." }, "transfer_caller_id": { "type": "string", "$ref": "#/components/schemas/trunk_enum_transfer_caller_id", "nullable": true, - "description": "Caller Id for transfer target" + "description": "Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`." }, "cnam_lookup_enabled": { "type": "boolean", "nullable": true, - "description": "Whether Caller ID Name (CNAM) lookup is enabled for the trunk" + "description": "Whether Caller ID Name (CNAM) lookup is enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information." }, "auth_type": { "type": "string", "nullable": true, - "description": "The types of authentication mapped to the domain" + "description": "The types of authentication mapped to the domain. Can be: `IP_ACL` and `CREDENTIAL_LIST`. If both are mapped, the values are returned in a comma delimited list. If empty, the domain will not receive any traffic." }, "auth_type_set": { "type": "array", @@ -506,19 +506,19 @@ "type": "string" }, "nullable": true, - "description": "Reserved" + "description": "Reserved." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "sid": { "type": "string", @@ -526,19 +526,19 @@ "maxLength": 34, "pattern": "^TK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Trunk resource." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, diff --git a/spec/json/twilio_trusthub_v1.json b/spec/json/twilio_trusthub_v1.json index afbbc862..feb6509d 100644 --- a/spec/json/twilio_trusthub_v1.json +++ b/spec/json/twilio_trusthub_v1.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource." + "description": "The unique string that we created to identify the Customer-Profile resource." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Customer-Profile resource." }, "policy_sid": { "type": "string", @@ -26,29 +26,29 @@ "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string of a policy." + "description": "The unique string of a policy that is associated to the Customer-Profile resource." }, "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." }, "status": { "type": "string", "$ref": "#/components/schemas/customer_profile_enum_status", "nullable": true, - "description": "The verification status of the Customer-Profile resource" + "description": "The verification status of the Customer-Profile resource." }, "valid_until": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource will be valid until." + "description": "The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until." }, "email": { "type": "string", "nullable": true, - "description": "The email address" + "description": "The email address that will receive updates when the Customer-Profile resource changes status." }, "status_callback": { "type": "string", @@ -60,25 +60,25 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 Customer-Profile resource" + "description": "The absolute URL of the Customer-Profile resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the Assigned Items of the Customer-Profile resource" + "description": "The URLs of the Assigned Items of the Customer-Profile resource." } } }, @@ -108,7 +108,7 @@ "maxLength": 34, "pattern": "^RA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Item Assignment resource." }, "customer_profile_sid": { "type": "string", @@ -116,7 +116,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the CustomerProfile resource." + "description": "The unique string that we created to identify the CustomerProfile resource." }, "account_sid": { "type": "string", @@ -124,12 +124,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource." }, "channel_endpoint_type": { "type": "string", "nullable": true, - "description": "The type of channel endpoint" + "description": "The type of channel endpoint. eg: phone-number" }, "channel_endpoint_sid": { "type": "string", @@ -137,19 +137,19 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The sid of an channel endpoint" + "description": "The SID of an channel endpoint" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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" + "description": "The absolute URL of the Identity resource." } } }, @@ -162,7 +162,7 @@ "maxLength": 34, "pattern": "^BV[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Item Assignment resource." }, "customer_profile_sid": { "type": "string", @@ -170,7 +170,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the CustomerProfile resource." + "description": "The unique string that we created to identify the CustomerProfile resource." }, "account_sid": { "type": "string", @@ -178,7 +178,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource." }, "object_sid": { "type": "string", @@ -186,19 +186,19 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The sid of an object bag" + "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 ISO 8601 date and time in GMT when the resource was created" + "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" + "description": "The absolute URL of the Identity resource." } } }, @@ -211,7 +211,7 @@ "maxLength": 34, "pattern": "^EL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Evaluation resource" + "description": "The unique string that identifies the Evaluation resource." }, "account_sid": { "type": "string", @@ -219,7 +219,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the customer_profile resource." }, "policy_sid": { "type": "string", @@ -227,7 +227,7 @@ "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string of a policy" + "description": "The unique string of a policy that is associated to the customer_profile resource." }, "customer_profile_sid": { "type": "string", @@ -235,19 +235,19 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the customer_profile resource." }, "status": { "type": "string", "$ref": "#/components/schemas/customer_profile_evaluation_enum_status", "nullable": true, - "description": "The compliance status of the Evaluation resource" + "description": "The compliance status of the Evaluation resource." }, "results": { "type": "array", "items": {}, "nullable": true, - "description": "The results of the Evaluation resource" + "description": "The results of the Evaluation which includes the valid and invalid attributes." }, "date_created": { "type": "string", @@ -277,7 +277,7 @@ "maxLength": 34, "pattern": "^IT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string created by Twilio to identify the End User resource." }, "account_sid": { "type": "string", @@ -285,39 +285,39 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the End User resource." }, "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." }, "type": { "type": "string", "nullable": true, - "description": "The type of end user of the Bundle resource" + "description": "The type of end user of the Bundle resource - can be `individual` or `business`." }, "attributes": { "nullable": true, - "description": "The set of parameters that compose the End Users resource" + "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 End User resource" + "description": "The absolute URL of the End User resource." } } }, @@ -330,29 +330,29 @@ "maxLength": 34, "pattern": "^OY[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the End-User Type resource" + "description": "The unique string that identifies the End-User Type resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human-readable description of the End-User Type resource" + "description": "A human-readable description that is assigned to describe the End-User Type resource. Examples can include first name, last name, email, business name, etc" }, "machine_name": { "type": "string", "nullable": true, - "description": "A machine-readable description of the End-User Type resource" + "description": "A machine-readable description of the End-User Type resource. Examples can include first_name, last_name, email, business_name, etc." }, "fields": { "type": "array", "items": {}, "nullable": true, - "description": "The required information for creating an End-User." + "description": "The required information for creating an End-User. The required fields will change as regulatory needs change and will differ for businesses and individuals." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the End-User Type resource" + "description": "The absolute URL of the End-User Type resource." } } }, @@ -365,22 +365,22 @@ "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Policy resource" + "description": "The unique string that identifies the Policy resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human-readable description of the Policy resource" + "description": "A human-readable description that is assigned to describe the Policy resource. Examples can include Primary Customer profile policy" }, "requirements": { "nullable": true, - "description": "The sid of a Policy object that dictates requirements" + "description": "The SID of an object that holds the policy information" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Policy resource" + "description": "The absolute URL of the Policy resource." } } }, @@ -400,7 +400,7 @@ "maxLength": 34, "pattern": "^RD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string created by Twilio to identify the Supporting Document resource." }, "account_sid": { "type": "string", @@ -408,50 +408,50 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource." }, "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." }, "mime_type": { "type": "string", "nullable": true, - "description": "The image type of the file" + "description": "The image type uploaded in the Supporting Document container." }, "status": { "type": "string", "$ref": "#/components/schemas/supporting_document_enum_status", "nullable": true, - "description": "The verification status of the Supporting Document resource" + "description": "The verification status of the Supporting Document resource." }, "type": { "type": "string", "nullable": true, - "description": "The type of the Supporting Document" + "description": "The type of the Supporting Document." }, "attributes": { "nullable": true, - "description": "The set of parameters that compose the Supporting Documents resource" + "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 Supporting Document resource" + "description": "The absolute URL of the Supporting Document resource." } } }, @@ -475,29 +475,29 @@ "maxLength": 34, "pattern": "^OY[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Supporting Document Type resource" + "description": "The unique string that identifies the Supporting Document Type resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human-readable description of the Supporting Document Type resource" + "description": "A human-readable description of the Supporting Document Type resource." }, "machine_name": { "type": "string", "nullable": true, - "description": "The machine-readable description of the Supporting Document Type resource" + "description": "The machine-readable description of the Supporting Document Type resource." }, "fields": { "type": "array", "items": {}, "nullable": true, - "description": "The required information for creating a Supporting Document" + "description": "The required information for creating a Supporting Document. The required fields will change as regulatory needs change and will differ for businesses and individuals." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Supporting Document Type resource" + "description": "The absolute URL of the Supporting Document Type resource." } } }, @@ -510,7 +510,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource." + "description": "The unique string that we created to identify the Customer-Profile resource." }, "account_sid": { "type": "string", @@ -518,7 +518,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Customer-Profile resource." }, "policy_sid": { "type": "string", @@ -526,29 +526,29 @@ "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string of a policy." + "description": "The unique string of a policy that is associated to the Customer-Profile resource." }, "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." }, "status": { "type": "string", "$ref": "#/components/schemas/trust_product_enum_status", "nullable": true, - "description": "The verification status of the Customer-Profile resource" + "description": "The verification status of the Customer-Profile resource." }, "valid_until": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource will be valid until." + "description": "The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until." }, "email": { "type": "string", "nullable": true, - "description": "The email address" + "description": "The email address that will receive updates when the Customer-Profile resource changes status." }, "status_callback": { "type": "string", @@ -560,25 +560,25 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 Customer-Profile resource" + "description": "The absolute URL of the Customer-Profile resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of the Assigned Items of the Customer-Profile resource" + "description": "The URLs of the Assigned Items of the Customer-Profile resource." } } }, @@ -608,7 +608,7 @@ "maxLength": 34, "pattern": "^RA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Item Assignment resource." }, "trust_product_sid": { "type": "string", @@ -616,7 +616,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the CustomerProfile resource." + "description": "The unique string that we created to identify the CustomerProfile resource." }, "account_sid": { "type": "string", @@ -624,12 +624,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource." }, "channel_endpoint_type": { "type": "string", "nullable": true, - "description": "The type of channel endpoint" + "description": "The type of channel endpoint. eg: phone-number" }, "channel_endpoint_sid": { "type": "string", @@ -637,19 +637,19 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The sid of an channel endpoint" + "description": "The SID of an channel endpoint" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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" + "description": "The absolute URL of the Identity resource." } } }, @@ -662,7 +662,7 @@ "maxLength": 34, "pattern": "^BV[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Item Assignment resource." }, "trust_product_sid": { "type": "string", @@ -670,7 +670,7 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the TrustProduct resource." + "description": "The unique string that we created to identify the TrustProduct resource." }, "account_sid": { "type": "string", @@ -678,7 +678,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource." }, "object_sid": { "type": "string", @@ -686,19 +686,19 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The sid of an object bag" + "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 ISO 8601 date and time in GMT when the resource was created" + "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" + "description": "The absolute URL of the Identity resource." } } }, @@ -711,7 +711,7 @@ "maxLength": 34, "pattern": "^EL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Evaluation resource" + "description": "The unique string that identifies the Evaluation resource." }, "account_sid": { "type": "string", @@ -719,7 +719,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the trust_product resource." }, "policy_sid": { "type": "string", @@ -727,7 +727,7 @@ "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string of a policy" + "description": "The unique string of a policy that is associated to the trust_product resource." }, "trust_product_sid": { "type": "string", @@ -735,19 +735,19 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the trust_product resource." }, "status": { "type": "string", "$ref": "#/components/schemas/trust_product_evaluation_enum_status", "nullable": true, - "description": "The compliance status of the Evaluation resource" + "description": "The compliance status of the Evaluation resource." }, "results": { "type": "array", "items": {}, "nullable": true, - "description": "The results of the Evaluation resource" + "description": "The results of the Evaluation which includes the valid and invalid attributes." }, "date_created": { "type": "string", diff --git a/spec/json/twilio_verify_v2.json b/spec/json/twilio_verify_v2.json index 8e1db130..56220692 100644 --- a/spec/json/twilio_verify_v2.json +++ b/spec/json/twilio_verify_v2.json @@ -10,7 +10,7 @@ "maxLength": 34, "pattern": "^YK[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Access Token." + "description": "A 34 character string that uniquely identifies this Access Token." }, "account_sid": { "type": "string", @@ -18,7 +18,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account Sid." + "description": "The unique SID identifier of the Account." }, "service_sid": { "type": "string", @@ -26,28 +26,28 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Verify Service Sid." + "description": "The unique SID identifier of the Verify Service." }, "entity_identity": { "type": "string", "nullable": true, - "description": "Unique external identifier of the Entity" + "description": "The unique external identifier for the Entity of the Service." }, "factor_type": { "type": "string", "$ref": "#/components/schemas/access_token_enum_factor_types", "nullable": true, - "description": "The Type of the Factor" + "description": "The Type of the Factor. Currently only `push` is supported." }, "factor_friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this factor." + "description": "A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name." }, "token": { "type": "string", "nullable": true, - "description": "Generated access token." + "description": "The access token generated for enrollment, this is an encrypted json web token." }, "url": { "type": "string", @@ -58,13 +58,13 @@ "ttl": { "type": "integer", "nullable": true, - "description": "How long, in seconds, the access token is valid." + "description": "How long, in seconds, the access token is valid. Max: 5 minutes" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this access token was created" + "description": "The date that this access token was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." } } }, @@ -83,7 +83,7 @@ "maxLength": 34, "pattern": "^BL[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Bucket." + "description": "A 34 character string that uniquely identifies this Bucket." }, "rate_limit_sid": { "type": "string", @@ -91,7 +91,7 @@ "maxLength": 34, "pattern": "^RK[0-9a-fA-F]{32}$", "nullable": true, - "description": "Rate Limit Sid." + "description": "The Twilio-provided string that uniquely identifies the Rate Limit resource." }, "service_sid": { "type": "string", @@ -99,7 +99,7 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with." }, "account_sid": { "type": "string", @@ -107,12 +107,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Rate Limit resource." }, "max": { "type": "integer", "nullable": true, - "description": "Max number of requests." + "description": "Maximum number of requests permitted in during the interval." }, "interval": { "type": "integer", @@ -123,13 +123,13 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", @@ -148,7 +148,7 @@ "maxLength": 34, "pattern": "^YC[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Challenge." + "description": "A 34 character string that uniquely identifies this Challenge." }, "account_sid": { "type": "string", @@ -156,7 +156,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account Sid." + "description": "The unique SID identifier of the Account." }, "service_sid": { "type": "string", @@ -164,7 +164,7 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Service Sid." + "description": "The unique SID identifier of the Service." }, "entity_sid": { "type": "string", @@ -172,12 +172,12 @@ "maxLength": 34, "pattern": "^YE[0-9a-fA-F]{32}$", "nullable": true, - "description": "Entity Sid." + "description": "The unique SID identifier of the Entity." }, "identity": { "type": "string", "nullable": true, - "description": "Unique external identifier of the Entity" + "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." }, "factor_sid": { "type": "string", @@ -185,61 +185,61 @@ "maxLength": 34, "pattern": "^YF[0-9a-fA-F]{32}$", "nullable": true, - "description": "Factor Sid." + "description": "The unique SID identifier of the Factor." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Challenge was created" + "description": "The date that this Challenge was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Challenge was updated" + "description": "The date that this Challenge was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_responded": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Challenge was responded" + "description": "The date that this Challenge was responded, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "expiration_date": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date-time when this Challenge expires" + "description": "The date-time when this Challenge expires, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation." }, "status": { "type": "string", "$ref": "#/components/schemas/challenge_enum_challenge_statuses", "nullable": true, - "description": "The Status of this Challenge" + "description": "The Status of this Challenge. One of `pending`, `expired`, `approved` or `denied`." }, "responded_reason": { "type": "string", "$ref": "#/components/schemas/challenge_enum_challenge_reasons", "nullable": true, - "description": "The Reason of this Challenge `status`" + "description": "Reason for the Challenge to be in certain `status`. One of `none`, `not_needed` or `not_requested`." }, "details": { "nullable": true, - "description": "Details about the Challenge." + "description": "Details provided to give context about the Challenge. Intended to be shown to the end user." }, "hidden_details": { "nullable": true, - "description": "Hidden details about the Challenge" + "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\"}`" }, "metadata": { "nullable": true, - "description": "Metadata of the challenge." + "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." }, "factor_type": { "type": "string", "$ref": "#/components/schemas/challenge_enum_factor_types", "nullable": true, - "description": "The Factor Type of this Challenge" + "description": "The Factor Type of this Challenge. Currently `push` and `totp` are supported." }, "url": { "type": "string", @@ -251,7 +251,7 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs." + "description": "Contains a dictionary of URL links to nested resources of this Challenge." } } }, @@ -295,12 +295,12 @@ "maxLength": 34, "pattern": "^YE[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Entity." + "description": "A 34 character string that uniquely identifies this Entity." }, "identity": { "type": "string", "nullable": true, - "description": "Unique external identifier of the Entity" + "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." }, "account_sid": { "type": "string", @@ -308,7 +308,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account Sid." + "description": "The unique SID identifier of the Account." }, "service_sid": { "type": "string", @@ -316,19 +316,19 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Service Sid." + "description": "The unique SID identifier of the Service." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Entity was created" + "description": "The date that this Entity was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Entity was updated" + "description": "The date that this Entity was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", @@ -340,7 +340,7 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "Nested resource URLs." + "description": "Contains a dictionary of URL links to nested resources of this Entity." } } }, @@ -353,7 +353,7 @@ "maxLength": 34, "pattern": "^YF[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Factor." + "description": "A 34 character string that uniquely identifies this Factor." }, "account_sid": { "type": "string", @@ -361,7 +361,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account Sid." + "description": "The unique SID identifier of the Account." }, "service_sid": { "type": "string", @@ -369,7 +369,7 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Service Sid." + "description": "The unique SID identifier of the Service." }, "entity_sid": { "type": "string", @@ -377,49 +377,49 @@ "maxLength": 34, "pattern": "^YE[0-9a-fA-F]{32}$", "nullable": true, - "description": "Entity Sid." + "description": "The unique SID identifier of the Entity." }, "identity": { "type": "string", "nullable": true, - "description": "Unique external identifier of the Entity" + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Factor was created" + "description": "The date that this Factor was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Factor was updated" + "description": "The date that this Factor was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this resource." + "description": "A human readable description of this resource, up to 64 characters. For a push factor, this can be the device's name." }, "status": { "type": "string", "$ref": "#/components/schemas/factor_enum_factor_statuses", "nullable": true, - "description": "The Status of this Factor" + "description": "The Status of this Factor. One of `unverified` or `verified`." }, "factor_type": { "type": "string", "$ref": "#/components/schemas/factor_enum_factor_types", "nullable": true, - "description": "The Type of this Factor" + "description": "The Type of this Factor. Currently `push` and `totp` are supported." }, "config": { "nullable": true, - "description": "Configurations for a `factor_type`." + "description": "An object that contains configurations specific to a `factor_type`." }, "metadata": { "nullable": true, - "description": "Metadata of the factor." + "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." }, "url": { "type": "string", @@ -466,15 +466,15 @@ "type": "string", "$ref": "#/components/schemas/form_enum_form_types", "nullable": true, - "description": "The Type of this Form" + "description": "The Type of this Form. Currently only `form-push` is supported." }, "forms": { "nullable": true, - "description": "Object that contains the available forms for this type." + "description": "Object that contains the available forms for this type. This available forms are given in the standard [JSON Schema](https://json-schema.org/) format" }, "form_meta": { "nullable": true, - "description": "Additional information for the available forms for this type." + "description": "Additional information for the available forms for this type. E.g. The separator string used for `binding` in a Factor push." }, "url": { "type": "string", @@ -499,7 +499,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource." }, "service_sid": { "type": "string", @@ -507,12 +507,12 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with." }, "country": { "type": "string", "nullable": true, - "description": "The ISO-3166-1 country code of the country or `all`." + "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`." }, "messaging_service_sid": { "type": "string", @@ -520,19 +520,19 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Messaging Service used for this configuration." + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", @@ -551,7 +551,7 @@ "maxLength": 34, "pattern": "^YF[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Factor." + "description": "A 34 character string that uniquely identifies this Factor." }, "account_sid": { "type": "string", @@ -559,7 +559,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account Sid." + "description": "The unique SID identifier of the Account." }, "service_sid": { "type": "string", @@ -567,7 +567,7 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Service Sid." + "description": "The unique SID identifier of the Service." }, "entity_sid": { "type": "string", @@ -575,53 +575,53 @@ "maxLength": 34, "pattern": "^YE[0-9a-fA-F]{32}$", "nullable": true, - "description": "Entity Sid." + "description": "The unique SID identifier of the Entity." }, "identity": { "type": "string", "nullable": true, - "description": "Unique external identifier of the Entity" + "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." }, "binding": { "nullable": true, - "description": "Binding of the factor" + "description": "Contains the `factor_type` specific secret and metadata.\nFor push, this is `binding.public_key` and `binding.alg`.\nFor totp, this is `binding.secret` and `binding.uri`. The `binding.uri` property is generated following the [google authenticator key URI format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format), and `Factor.friendly_name` is used for the \u201caccountname\u201d value and `Service.friendly_name` or `Service.totp.issuer` is used for the `issuer` value.\n\n\nThe Binding property is ONLY returned upon Factor creation." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Factor was created" + "description": "The date that this Factor was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Factor was updated" + "description": "The date that this Factor was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this resource." + "description": "The friendly name of this Factor. This can be any string up to 64 characters, meant for humans to distinguish between Factors.\nFor `factor_type` `push`, this could be a device name.\nFor `factor_type` `totp`, this value is used as the \u201caccount name\u201d in constructing the `binding.uri` property.\nAt the same time, we recommend avoiding providing PII." }, "status": { "type": "string", "$ref": "#/components/schemas/new_factor_enum_factor_statuses", "nullable": true, - "description": "The Status of this Factor" + "description": "The Status of this Factor. One of `unverified` or `verified`." }, "factor_type": { "type": "string", "$ref": "#/components/schemas/new_factor_enum_factor_types", "nullable": true, - "description": "The Type of this Factor" + "description": "The Type of this Factor. Currently `push` and `totp` are supported." }, "config": { "nullable": true, - "description": "Configurations for a `factor_type`." + "description": "An object that contains configurations specific to a `factor_type`." }, "metadata": { "nullable": true, - "description": "Metadata of the factor." + "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." }, "url": { "type": "string", @@ -670,7 +670,7 @@ "maxLength": 34, "pattern": "^NT[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Notification." + "description": "A 34 character string that uniquely identifies this Notification." }, "account_sid": { "type": "string", @@ -678,7 +678,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account Sid." + "description": "The unique SID identifier of the Account." }, "service_sid": { "type": "string", @@ -686,7 +686,7 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Service Sid." + "description": "The unique SID identifier of the Service." }, "entity_sid": { "type": "string", @@ -694,12 +694,12 @@ "maxLength": 34, "pattern": "^YE[0-9a-fA-F]{32}$", "nullable": true, - "description": "Entity Sid." + "description": "The unique SID identifier of the Entity." }, "identity": { "type": "string", "nullable": true, - "description": "Unique external identifier of the Entity" + "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." }, "challenge_sid": { "type": "string", @@ -707,23 +707,23 @@ "maxLength": 34, "pattern": "^YC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Challenge Sid." + "description": "The unique SID identifier of the Challenge." }, "priority": { "type": "string", "nullable": true, - "description": "The priority of the notification." + "description": "The priority of the notification. For `push` Challenges it's always `high` which sends the notification immediately, and can wake up a sleeping device." }, "ttl": { "type": "integer", "nullable": true, - "description": "How long, in seconds, the notification is valid." + "description": "How long, in seconds, the notification is valid. Max: 5 minutes" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Notification was created" + "description": "The date that this Notification was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." } } }, @@ -736,7 +736,7 @@ "maxLength": 34, "pattern": "^RK[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Rate Limit." + "description": "A 34 character string that uniquely identifies this Rate Limit." }, "service_sid": { "type": "string", @@ -744,7 +744,7 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with." }, "account_sid": { "type": "string", @@ -752,12 +752,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Rate Limit resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "A unique, developer assigned name of this Rate Limit." + "description": "Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. **This value should not contain PII.**" }, "description": { "type": "string", @@ -768,13 +768,13 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", @@ -786,7 +786,7 @@ "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -799,7 +799,7 @@ "maxLength": 34, "pattern": "^GN[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource." + "description": "The unique string that we created to identify the SafeList resource." }, "phone_number": { "type": "string", @@ -823,7 +823,7 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Service resource." }, "account_sid": { "type": "string", @@ -831,60 +831,60 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the verification service" + "description": "The string that you assigned to describe the verification service. **This value should not contain PII.**" }, "code_length": { "type": "integer", "nullable": true, - "description": "The length of the verification code" + "description": "The length of the verification code to generate." }, "lookup_enabled": { "type": "boolean", "nullable": true, - "description": "Whether to perform a lookup with each verification" + "description": "Whether to perform a lookup with each verification started and return info about the phone number." }, "psd2_enabled": { "type": "boolean", "nullable": true, - "description": "Whether to pass PSD2 transaction parameters when starting a verification" + "description": "Whether to pass PSD2 transaction parameters when starting a verification." }, "skip_sms_to_landlines": { "type": "boolean", "nullable": true, - "description": "Whether to skip sending SMS verifications to landlines" + "description": "Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`." }, "dtmf_input_required": { "type": "boolean", "nullable": true, - "description": "Whether to ask the user to press a number before delivering the verify code in a phone call" + "description": "Whether to ask the user to press a number before delivering the verify code in a phone call." }, "tts_name": { "type": "string", "nullable": true, - "description": "The name of an alternative text-to-speech service to use in phone calls" + "description": "The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages." }, "do_not_share_warning_enabled": { "type": "boolean", "nullable": true, - "description": "Whether to add a security warning at the end of an SMS." + "description": "Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: `Your AppName verification code is: 1234. Don\u2019t share this code with anyone; our employees will never ask for the code`" }, "custom_code_enabled": { "type": "boolean", "nullable": true, - "description": "Whether to allow sending verifications with a custom code." + "description": "Whether to allow sending verifications with a custom code instead of a randomly generated one. Not available for all customers." }, "push": { "nullable": true, - "description": "The service level configuration of factor push type." + "description": "Configurations for the Push factors (channel) created under this Service." }, "totp": { "nullable": true, - "description": "The service level configuration of factor TOTP type." + "description": "Configurations for the TOTP factors (channel) created under this Service." }, "default_template_sid": { "type": "string", @@ -897,25 +897,25 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -928,7 +928,7 @@ "maxLength": 34, "pattern": "^VE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Verification resource." }, "service_sid": { "type": "string", @@ -936,7 +936,7 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with." }, "account_sid": { "type": "string", @@ -944,70 +944,70 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Verification resource." }, "to": { "type": "string", "nullable": true, - "description": "The phone number or email being verified" + "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)." }, "channel": { "type": "string", "$ref": "#/components/schemas/verification_enum_channel", "nullable": true, - "description": "The verification method used." + "description": "The verification method used. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, or `sna`." }, "status": { "type": "string", "nullable": true, - "description": "The status of the verification resource" + "description": "The status of the verification. One of: `pending`, `approved`, or `canceled`" }, "valid": { "type": "boolean", "nullable": true, - "description": "Whether the verification was successful" + "description": "Use \"status\" instead. Legacy property indicating whether the verification was successful." }, "lookup": { "nullable": true, - "description": "Information about the phone number being verified" + "description": "Information about the phone number being verified." }, "amount": { "type": "string", "nullable": true, - "description": "The amount of the associated PSD2 compliant transaction." + "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." }, "payee": { "type": "string", "nullable": true, - "description": "The payee of the associated PSD2 compliant transaction" + "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." }, "send_code_attempts": { "type": "array", "items": {}, "nullable": true, - "description": "An array of verification attempt objects." + "description": "An array of verification attempt objects containing the channel attempted and the channel-specific transaction SID." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "sna": { "nullable": true, - "description": "The set of fields used for a silent network auth (`sna`) verification" + "description": "The set of fields used for a silent network auth (`sna`) verification. Contains a single field with the URL to be invoked to verify the phone number." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the Verification resource" + "description": "The absolute URL of the Verification resource." } } }, @@ -1037,7 +1037,7 @@ "maxLength": 34, "pattern": "^VL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID that uniquely identifies the verification attempt." + "description": "The SID that uniquely identifies the verification attempt resource." }, "account_sid": { "type": "string", @@ -1045,7 +1045,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the verification." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Verification resource." }, "service_sid": { "type": "string", @@ -1053,7 +1053,7 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the verify service that generated this attempt." + "description": "The SID of the [Service](https://www.twilio.com/docs/verify/api/service) used to generate the attempt." }, "verification_sid": { "type": "string", @@ -1061,35 +1061,35 @@ "maxLength": 34, "pattern": "^VE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the verification that generated this attempt." + "description": "The SID of the [Verification](https://www.twilio.com/docs/verify/api/verification) that generated the attempt." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Attempt was created" + "description": "The date that this Attempt was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this Attempt was updated" + "description": "The date that this Attempt was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "conversion_status": { "type": "string", "$ref": "#/components/schemas/verification_attempt_enum_conversion_status", "nullable": true, - "description": "Status of the conversion for the verification." + "description": "A string specifying the conversion status of the verification. A conversion happens when the user is able to provide the correct code. Possible values are `CONVERTED` and `UNCONVERTED`." }, "channel": { "type": "string", "$ref": "#/components/schemas/verification_attempt_enum_channels", "nullable": true, - "description": "Communication channel used for the attempt." + "description": "A string specifying the communication channel used for the verification attempt. i.e SMS, CALL, etc." }, "price": { "nullable": true, - "description": "An object containing the charge for this verification attempt." + "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)." }, "channel_data": { "nullable": true, @@ -1163,22 +1163,22 @@ "total_attempts": { "type": "integer", "nullable": true, - "description": "Total of attempts made." + "description": "Total of attempts made according to the provided filters" }, "total_converted": { "type": "integer", "nullable": true, - "description": "Total of attempts confirmed by the end user." + "description": "Total of attempts made that were confirmed by the end user, according to the provided filters." }, "total_unconverted": { "type": "integer", "nullable": true, - "description": "Total of attempts made that were not confirmed by the end user." + "description": "Total of attempts made that were not confirmed by the end user, according to the provided filters." }, "conversion_rate_percentage": { "type": "number", "nullable": true, - "description": "Percentage of the confirmed messages over the total." + "description": "Percentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100. " }, "url": { "type": "string", @@ -1205,7 +1205,7 @@ "maxLength": 34, "pattern": "^VE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the VerificationCheck resource." }, "service_sid": { "type": "string", @@ -1213,7 +1213,7 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Service that the resource is associated with" + "description": "The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with." }, "account_sid": { "type": "string", @@ -1221,56 +1221,56 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the VerificationCheck resource." }, "to": { "type": "string", "nullable": true, - "description": "The phone number or email being verified" + "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)." }, "channel": { "type": "string", "$ref": "#/components/schemas/verification_check_enum_channel", "nullable": true, - "description": "The verification method to use" + "description": "The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, or `sna`." }, "status": { "type": "string", "nullable": true, - "description": "The status of the verification resource" + "description": "The status of the verification. Can be: `pending`, `approved`, or `canceled`." }, "valid": { "type": "boolean", "nullable": true, - "description": "Whether the verification was successful" + "description": "Use \"status\" instead. Legacy property indicating whether the verification was successful." }, "amount": { "type": "string", "nullable": true, - "description": "The amount of the associated PSD2 compliant transaction." + "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." }, "payee": { "type": "string", "nullable": true, - "description": "The payee of the associated PSD2 compliant transaction" + "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Verification Check resource was created" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was created." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Verification Check resource was last updated" + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was last updated." }, "sna_attempts_error_codes": { "type": "array", "items": {}, "nullable": true, - "description": "List of error codes as a result of attempting a verification using the `sna` channel." + "description": "List of error codes as a result of attempting a verification using the `sna` channel. The error codes are chronologically ordered, from the first attempt to the latest attempt. This will be an empty list if no errors occured or `null` if the last channel used wasn't `sna`." } } }, @@ -1293,7 +1293,7 @@ "maxLength": 34, "pattern": "^HJ[0-9a-fA-F]{32}$", "nullable": true, - "description": "A string that uniquely identifies this Template" + "description": "A 34 character string that uniquely identifies a Verification Template." }, "account_sid": { "type": "string", @@ -1301,12 +1301,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "Account Sid" + "description": "The unique SID identifier of the Account." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A string to describe the verification template" + "description": "A descriptive string that you create to describe a Template." }, "channels": { "type": "array", @@ -1314,11 +1314,11 @@ "type": "string" }, "nullable": true, - "description": "A list of channels that support the Template" + "description": "A list of channels that support the Template. Can include: sms, voice" }, "translations": { "nullable": true, - "description": "Object with the template translations." + "description": "An object that contains the different translations of the template. Every translation is identified by the language short name and contains its respective information as the approval status, text and created/modified date." } } }, @@ -1331,7 +1331,7 @@ "maxLength": 34, "pattern": "^YW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Webhook resource." }, "service_sid": { "type": "string", @@ -1339,7 +1339,7 @@ "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$", "nullable": true, - "description": "Service Sid." + "description": "The unique SID identifier of the Service." }, "account_sid": { "type": "string", @@ -1347,12 +1347,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the webhook" + "description": "The string that you assigned to describe the webhook. **This value should not contain PII.**" }, "event_types": { "type": "array", @@ -1360,19 +1360,19 @@ "type": "string" }, "nullable": true, - "description": "The array of events that this Webhook is subscribed to." + "description": "The array of events that this Webhook is subscribed to. Possible event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`" }, "status": { "type": "string", "$ref": "#/components/schemas/webhook_enum_status", "nullable": true, - "description": "The webhook status" + "description": "The webhook status. Default value is `enabled`. One of: `enabled` or `disabled`" }, "version": { "type": "string", "$ref": "#/components/schemas/webhook_enum_version", "nullable": true, - "description": "The webhook version" + "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." }, "webhook_url": { "type": "string", @@ -1384,25 +1384,25 @@ "type": "string", "$ref": "#/components/schemas/webhook_enum_methods", "nullable": true, - "description": "The method used when calling the webhook's URL." + "description": "The method to be used when calling the webhook's URL." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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 Webhook resource" + "description": "The absolute URL of the Webhook resource." } } }, diff --git a/spec/json/twilio_video_v1.json b/spec/json/twilio_video_v1.json index 2715b75c..49485598 100644 --- a/spec/json/twilio_video_v1.json +++ b/spec/json/twilio_video_v1.json @@ -10,31 +10,31 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Composition resource." }, "status": { "type": "string", "$ref": "#/components/schemas/composition_enum_status", "nullable": true, - "description": "The status of the composition" + "description": "The status of the composition. Can be: `enqueued`, `processing`, `completed`, `deleted` or `failed`. `enqueued` is the initial state and indicates that the composition request has been received and is scheduled for processing; `processing` indicates the composition is being processed; `completed` indicates the composition has been completed and is available for download; `deleted` means the composition media has been deleted from the system, but its metadata is still available for 30 days; `failed` indicates the composition failed to execute the media processing task." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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_completed": { "type": "string", "format": "date-time", "nullable": true, - "description": "Date when the media processing task finished" + "description": "The date and time in GMT when the composition's media processing task finished, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_deleted": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the composition generated media was deleted" + "description": "The date and time in GMT when the composition generated media was deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "sid": { "type": "string", @@ -42,7 +42,7 @@ "maxLength": 34, "pattern": "^CJ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Composition resource." }, "room_sid": { "type": "string", @@ -50,7 +50,7 @@ "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Group Room that generated the audio and video tracks used in the composition" + "description": "The SID of the Group Room that generated the audio and video tracks used in the composition. All media sources included in a composition must belong to the same Group Room." }, "audio_sources": { "type": "array", @@ -58,7 +58,7 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to include in the composition" + "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`." }, "audio_sources_excluded": { "type": "array", @@ -66,55 +66,55 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to exclude from the composition" + "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." }, "video_layout": { "nullable": true, - "description": "An object that describes the video layout of the composition" + "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." }, "resolution": { "type": "string", "nullable": true, - "description": "The dimensions of the video image in pixels expressed as columns (width) and rows (height)" + "description": "The dimensions of the video image in pixels expressed as columns (width) and rows (height). The string's format is `{width}x{height}`, such as `640x480`." }, "trim": { "type": "boolean", "nullable": true, - "description": "Whether to remove intervals with no media" + "description": "Whether to remove intervals with no media, as specified in the POST request that created the composition. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." }, "format": { "type": "string", "$ref": "#/components/schemas/composition_enum_format", "nullable": true, - "description": "The container format of the composition's media files as specified in the POST request that created the Composition resource" + "description": "The container format of the composition's media files as specified in the POST request that created the Composition resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information." }, "bitrate": { "type": "integer", "nullable": true, - "description": "The average bit rate of the composition's media" + "description": "The average bit rate of the composition's media." }, "size": { "type": "integer", "format": "int64", "nullable": true, - "description": "The size of the composed media file in bytes" + "description": "The size of the composed media file in bytes." }, "duration": { "type": "integer", "nullable": true, - "description": "The duration of the composition's media file in seconds" + "description": "The duration of the composition's media file in seconds." }, "media_external_location": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the media file associated with the composition when stored externally" + "description": "The URL of the media file associated with the composition when stored externally. See [External S3 Compositions](/docs/video/api/external-s3-compositions) for more details." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL called to send status information on every composition event." + "description": "The URL called using the `status_callback_method` to send status information on every composition event." }, "status_callback_method": { "type": "string", @@ -128,19 +128,19 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used to call `status_callback`" + "description": "The HTTP method used to call `status_callback`. Can be: `POST` or `GET`, defaults to `POST`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URL of the media file associated with the composition" + "description": "The URL of the media file associated with the composition." } } }, @@ -170,29 +170,29 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CompositionHook resource." }, "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. Can be up to 100 characters long and must be unique within the account." }, "enabled": { "type": "boolean", "nullable": true, - "description": "Whether the CompositionHook is active" + "description": "Whether the CompositionHook is active. When `true`, the CompositionHook is triggered for every completed Group Room on the account. When `false`, the CompositionHook is never triggered." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "sid": { "type": "string", @@ -200,7 +200,7 @@ "maxLength": 34, "pattern": "^HK[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the CompositionHook resource." }, "audio_sources": { "type": "array", @@ -208,7 +208,7 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to include in the compositions created by the composition hook" + "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" }, "audio_sources_excluded": { "type": "array", @@ -216,33 +216,33 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to exclude from the compositions created by the composition hook" + "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." }, "video_layout": { "nullable": true, - "description": "A JSON object that describes the video layout of the Composition" + "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" }, "resolution": { "type": "string", "nullable": true, - "description": "The dimensions of the video image in pixels expressed as columns (width) and rows (height)" + "description": "The dimensions of the video image in pixels expressed as columns (width) and rows (height). The string's format is `{width}x{height}`, such as `640x480`." }, "trim": { "type": "boolean", "nullable": true, - "description": "Whether intervals with no media are clipped" + "description": "Whether intervals with no media are clipped, as specified in the POST request that created the CompositionHook resource. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." }, "format": { "type": "string", "$ref": "#/components/schemas/composition_hook_enum_format", "nullable": true, - "description": "The container format of the media files used by the compositions created by the composition hook" + "description": "The container format of the media files used by the compositions created by the composition hook. If `mp4` or `webm`, `audio_sources` must have one or more tracks and/or a `video_layout` element must contain a valid `video_sources` list, otherwise an error occurs." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to send status information to your application" + "description": "The URL we call using the `status_callback_method` to send status information to your application." }, "status_callback_method": { "type": "string", @@ -256,13 +256,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we should use to call status_callback" + "description": "The HTTP method we should use to call `status_callback`. Can be `POST` or `GET` and defaults to `POST`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -282,12 +282,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CompositionSettings resource." }, "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 and that will be shown in the console" }, "aws_credentials_sid": { "type": "string", @@ -295,18 +295,18 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the stored Credential resource" + "description": "The SID of the stored Credential resource." }, "aws_s3_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the AWS S3 bucket where the compositions are stored" + "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." }, "aws_storage_enabled": { "type": "boolean", "nullable": true, - "description": "Whether all compositions are written to the aws_s3_url" + "description": "Whether all compositions are written to the `aws_s3_url`. When `false`, all compositions are stored in our cloud." }, "encryption_key_sid": { "type": "string", @@ -314,18 +314,18 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Public Key resource used for encryption" + "description": "The SID of the Public Key resource used for encryption." }, "encryption_enabled": { "type": "boolean", "nullable": true, - "description": "Whether all compositions are stored in an encrypted form" + "description": "Whether all compositions are stored in an encrypted form. The default is `false`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -338,19 +338,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource." }, "status": { "type": "string", "$ref": "#/components/schemas/recording_enum_status", "nullable": true, - "description": "The status of the recording" + "description": "The status of the recording. Can be: `processing`, `completed`, or `deleted`. `processing` indicates the recording is still being captured; `completed` indicates the recording has been captured and is now available for download. `deleted` means the recording media has been deleted from the system, but its metadata is still available." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "sid": { "type": "string", @@ -358,7 +358,7 @@ "maxLength": 34, "pattern": "^RT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Recording resource." }, "source_sid": { "type": "string", @@ -366,69 +366,69 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the recording source" + "description": "The SID of the recording source. For a Room Recording, this value is a `track_sid`." }, "size": { "type": "integer", "format": "int64", "nullable": true, - "description": "The size of the recorded track, in bytes" + "description": "The size of the recorded track, in bytes." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "type": { "type": "string", "$ref": "#/components/schemas/recording_enum_type", "nullable": true, - "description": "The recording's media type" + "description": "The recording's media type. Can be: `audio` or `video`." }, "duration": { "type": "integer", "nullable": true, - "description": "The duration of the recording in seconds" + "description": "The duration of the recording in seconds rounded to the nearest second. Sub-second tracks have a `Duration` property of 1 second" }, "container_format": { "type": "string", "$ref": "#/components/schemas/recording_enum_format", "nullable": true, - "description": "The file format for the recording" + "description": "The file format for the recording. Can be: `mka` or `mkv`. Video Room recordings are captured in [Matroska container format](https://matroska.org/), `mka` is for audio files and `mkv` for video files." }, "codec": { "type": "string", "$ref": "#/components/schemas/recording_enum_codec", "nullable": true, - "description": "The codec used to encode the track" + "description": "The codec used to encode the track. Can be: `VP8`, `H264`, `OPUS`, and `PCMU`." }, "grouping_sids": { "nullable": true, - "description": "A list of SIDs related to the recording" + "description": "A list of SIDs related to the recording. Includes the `room_sid` and `participant_sid`." }, "track_name": { "type": "string", "nullable": true, - "description": "The name that was given to the source track of the recording" + "description": "The name that was given to the source track of the recording. If no name is given, the `source_sid` is used." }, "offset": { "type": "integer", "format": "int64", "nullable": true, - "description": "The number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started" + "description": "The time in milliseconds elapsed between an arbitrary point in time, common to all group rooms, and the moment when the source room of this track started. This information provides a synchronization mechanism for recordings belonging to the same room." }, "media_external_location": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the media file associated with the recording when stored externally" + "description": "The URL of the media file associated with the recording when stored externally. See [External S3 Recordings](/docs/video/api/external-s3-recordings) for more details." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL called to send status information on every recording event." + "description": "The URL called using the `status_callback_method` to send status information on every recording event." }, "status_callback_method": { "type": "string", @@ -442,13 +442,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used to call `status_callback`" + "description": "The HTTP method used to call `status_callback`. Can be: `POST` or `GET`, defaults to `POST`." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -494,12 +494,12 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the RecordingSettings resource." }, "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 and show the user in the console" }, "aws_credentials_sid": { "type": "string", @@ -507,18 +507,18 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the stored Credential resource" + "description": "The SID of the stored Credential resource." }, "aws_s3_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the AWS S3 bucket where the recordings are stored" + "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." }, "aws_storage_enabled": { "type": "boolean", "nullable": true, - "description": "Whether all recordings are written to the aws_s3_url" + "description": "Whether all recordings are written to the `aws_s3_url`. When `false`, all recordings are stored in our cloud." }, "encryption_key_sid": { "type": "string", @@ -526,18 +526,18 @@ "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Public Key resource used for encryption" + "description": "The SID of the Public Key resource used for encryption." }, "encryption_enabled": { "type": "boolean", "nullable": true, - "description": "Whether all recordings are stored in an encrypted form" + "description": "Whether all recordings are stored in an encrypted form. The default is `false`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -550,25 +550,25 @@ "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Room resource." }, "status": { "type": "string", "$ref": "#/components/schemas/room_enum_room_status", "nullable": true, - "description": "The status of the room" + "description": "The status of the room. Can be: `in-progress`, `failed`, or `completed`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "account_sid": { "type": "string", @@ -576,23 +576,23 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Room resource." }, "enable_turn": { "type": "boolean", "nullable": true, - "description": "Enable Twilio's Network Traversal TURN service" + "description": "Deprecated, now always considered to be true." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource" + "description": "An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource's `sid` in the URL to address the resource, assuming it does not contain any [reserved characters](https://tools.ietf.org/html/rfc3986#section-2.2) that would need to be URL encoded. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL to send status information to your application" + "description": "The URL we call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info." }, "status_callback_method": { "type": "string", @@ -606,44 +606,44 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call status_callback" + "description": "The HTTP method we use to call `status_callback`. Can be `POST` or `GET` and defaults to `POST`." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The UTC end time of the room in UTC ISO 8601 format" + "description": "The UTC end time of the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "duration": { "type": "integer", "nullable": true, - "description": "The duration of the room in seconds" + "description": "The duration of the room in seconds." }, "type": { "type": "string", "$ref": "#/components/schemas/room_enum_room_type", "nullable": true, - "description": "The type of room" + "description": "The type of room. Can be: `go`, `peer-to-peer`, `group-small`, or `group`. The default value is `group`." }, "max_participants": { "type": "integer", "nullable": true, - "description": "The maximum number of concurrent Participants allowed in the room" + "description": "The maximum number of concurrent Participants allowed in the room. " }, "max_participant_duration": { "type": "integer", "nullable": true, - "description": "The maximum number of seconds a Participant can be connected to the room" + "description": "The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours)." }, "max_concurrent_published_tracks": { "type": "integer", "nullable": true, - "description": "The maximum number of published tracks allowed in the room at the same time" + "description": "The maximum number of published audio, video, and data tracks all participants combined are allowed to publish in the room at the same time. Check [Programmable Video Limits](https://www.twilio.com/docs/video/programmable-video-limits) for more details. If it is set to 0 it means unconstrained." }, "record_participants_on_connect": { "type": "boolean", "nullable": true, - "description": "Whether to start recording when Participants connect" + "description": "Whether to start recording when Participants connect. ***This feature is not available in `peer-to-peer` rooms.***" }, "video_codecs": { "type": "array", @@ -652,27 +652,27 @@ "$ref": "#/components/schemas/room_enum_video_codec" }, "nullable": true, - "description": "An array of the video codecs that are supported when publishing a track in the room" + "description": "An array of the video codecs that are supported when publishing a track in the room. Can be: `VP8` and `H264`. ***This feature is not available in `peer-to-peer` rooms***" }, "media_region": { "type": "string", "nullable": true, - "description": "The region for the media server in Group 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-address-whitelisting#media-servers). ***This feature is not available in `peer-to-peer` rooms.***" }, "audio_only": { "type": "boolean", "nullable": true, - "description": "Indicates whether the room will only contain audio track participants for group rooms." + "description": "When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed. Group rooms only." }, "empty_room_timeout": { "type": "integer", "nullable": true, - "description": "The time a room will remain active after last participant leaves." + "description": "Specifies how long (in minutes) a room will remain active after last participant leaves. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed." }, "unused_room_timeout": { "type": "integer", "nullable": true, - "description": "The time a room will remain active when no one joins." + "description": "Specifies how long (in minutes) a room will remain active if no one joins. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed." }, "large_room": { "type": "boolean", @@ -683,13 +683,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -726,7 +726,7 @@ "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the RoomParticipant resource." }, "room_sid": { "type": "string", @@ -734,7 +734,7 @@ "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the participant's room" + "description": "The SID of the participant's room." }, "account_sid": { "type": "string", @@ -742,59 +742,59 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the RoomParticipant resource." }, "status": { "type": "string", "$ref": "#/components/schemas/room_participant_enum_status", "nullable": true, - "description": "The status of the Participant" + "description": "The status of the Participant. Can be: `connected` or `disconnected`." }, "identity": { "type": "string", "nullable": true, - "description": "The string that identifies the resource's User" + "description": "The application-defined string that uniquely identifies the resource's User within a Room. If a client joins with an existing Identity, the existing client is disconnected. See [access tokens](https://www.twilio.com/docs/video/tutorials/user-identity-access-tokens) and [limits](https://www.twilio.com/docs/video/programmable-video-limits) for more info. " }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "start_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The time of participant connected to the room in ISO 8601 format" + "description": "The time of participant connected to the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The time when the participant disconnected from the room in ISO 8601 format" + "description": "The time when the participant disconnected from the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "duration": { "type": "integer", "nullable": true, - "description": "Duration of time in seconds the participant was connected" + "description": "The duration in seconds that the participant was `connected`. Populated only after the participant is `disconnected`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -814,7 +814,7 @@ "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the RoomParticipant resource." }, "room_sid": { "type": "string", @@ -822,7 +822,7 @@ "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the participant's room" + "description": "The SID of the participant's room." }, "account_sid": { "type": "string", @@ -830,13 +830,13 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the RoomParticipant resource." }, "status": { "type": "string", "$ref": "#/components/schemas/room_participant_anonymize_enum_status", "nullable": true, - "description": "The status of the Participant" + "description": "The status of the Participant. Can be: `connected` or `disconnected`." }, "identity": { "type": "string", @@ -844,42 +844,42 @@ "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the participant" + "description": "The SID of the participant." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "start_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The time of participant connected to the room in ISO 8601 format" + "description": "The time of participant connected to the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, - "description": "The time when the participant disconnected from the room in ISO 8601 format" + "description": "The time when the participant disconnected from the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "duration": { "type": "integer", "nullable": true, - "description": "Duration of time in seconds the participant was connected" + "description": "The duration in seconds that the participant was `connected`. Populated only after the participant is `disconnected`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -899,7 +899,7 @@ "maxLength": 34, "pattern": "^MT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the RoomParticipantPublishedTrack resource." }, "participant_sid": { "type": "string", @@ -907,7 +907,7 @@ "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Participant resource with the published track" + "description": "The SID of the Participant resource with the published track." }, "room_sid": { "type": "string", @@ -915,41 +915,41 @@ "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Room resource where the track is published" + "description": "The SID of the Room resource where the track is published." }, "name": { "type": "string", "nullable": true, - "description": "The track name" + "description": "The track name. Must be no more than 128 characters, and be unique among the participant's published tracks." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "enabled": { "type": "boolean", "nullable": true, - "description": "Whether the track is enabled" + "description": "Whether the track is enabled." }, "kind": { "type": "string", "$ref": "#/components/schemas/room_participant_published_track_enum_kind", "nullable": true, - "description": "The track type" + "description": "The track type. Can be: `audio`, `video` or `data`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -970,7 +970,7 @@ "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Participant resource for the Subscribe Rules" + "description": "The SID of the Participant resource for the Subscribe Rules." }, "room_sid": { "type": "string", @@ -1007,19 +1007,19 @@ } }, "nullable": true, - "description": "A collection of Subscribe Rules that describe how to include or exclude matching tracks" + "description": "A collection of Subscribe Rules that describe how to include or exclude matching tracks. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) section for further information." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." } } }, @@ -1032,7 +1032,7 @@ "maxLength": 34, "pattern": "^MT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the RoomParticipantSubscribedTrack resource." }, "participant_sid": { "type": "string", @@ -1040,7 +1040,7 @@ "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the participant that subscribes to the track" + "description": "The SID of the participant that subscribes to the track." }, "publisher_sid": { "type": "string", @@ -1048,7 +1048,7 @@ "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the participant that publishes the track" + "description": "The SID of the participant that publishes the track." }, "room_sid": { "type": "string", @@ -1056,41 +1056,41 @@ "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the room where the track is published" + "description": "The SID of the room where the track is published." }, "name": { "type": "string", "nullable": true, - "description": "The track name" + "description": "The track name. Must have no more than 128 characters and be unique among the participant's published tracks." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." }, "enabled": { "type": "boolean", "nullable": true, - "description": "Whether the track is enabled" + "description": "Whether the track is enabled." }, "kind": { "type": "string", "$ref": "#/components/schemas/room_participant_subscribed_track_enum_kind", "nullable": true, - "description": "The track type" + "description": "The track type. Can be: `audio`, `video` or `data`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -1111,19 +1111,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the RoomRecording resource." }, "status": { "type": "string", "$ref": "#/components/schemas/room_recording_enum_status", "nullable": true, - "description": "The status of the recording" + "description": "The status of the recording. Can be: `processing`, `completed`, or `deleted`. `processing` indicates the Recording is still being captured. `completed` indicates the Recording has been captured and is now available for download. `deleted` means the recording media has been deleted from the system, but its metadata is still available for historical purposes." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "sid": { "type": "string", @@ -1131,7 +1131,7 @@ "maxLength": 34, "pattern": "^RT[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the RoomRecording resource." }, "source_sid": { "type": "string", @@ -1139,63 +1139,63 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the recording source" + "description": "The SID of the recording source. For a Room Recording, this value is a `track_sid`." }, "size": { "type": "integer", "format": "int64", "nullable": true, - "description": "The size of the recorded track in bytes" + "description": "The size of the recorded track in bytes." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "type": { "type": "string", "$ref": "#/components/schemas/room_recording_enum_type", "nullable": true, - "description": "The recording's media type" + "description": "The recording's media type. Can be: `audio` or `video`." }, "duration": { "type": "integer", "nullable": true, - "description": "The duration of the recording in seconds" + "description": "The duration of the recording rounded to the nearest second. Sub-second duration tracks have a `duration` of 1 second" }, "container_format": { "type": "string", "$ref": "#/components/schemas/room_recording_enum_format", "nullable": true, - "description": "The file format for the recording" + "description": "The file format for the recording. Can be: `mka` or `mkv`. Video Room recordings are captured in [Matroska container format](https://matroska.org/), `mka` is for audio files and `mkv` for video files." }, "codec": { "type": "string", "$ref": "#/components/schemas/room_recording_enum_codec", "nullable": true, - "description": "The codec used for the recording" + "description": "The codec used for the recording. Can be: `VP8` or `H264`." }, "grouping_sids": { "nullable": true, - "description": "A list of SIDs related to the Recording" + "description": "A list of SIDs related to the Recording. Includes the `room_sid` and `participant_sid`." }, "track_name": { "type": "string", "nullable": true, - "description": "The name that was given to the source track of the recording" + "description": "The name that was given to the source track of the recording. If no name is given, the `source_sid` is used." }, "offset": { "type": "integer", "format": "int64", "nullable": true, - "description": "The number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started" + "description": "The time in milliseconds elapsed between an arbitrary point in time, common to all group rooms, and the moment when the source room of this track started. This information provides a synchronization mechanism for recordings belonging to the same room." }, "media_external_location": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the media file associated with the recording when stored externally" + "description": "The URL of the media file associated with the recording when stored externally. See [External S3 Recordings](/docs/video/api/external-s3-recordings) for more details." }, "room_sid": { "type": "string", @@ -1203,13 +1203,13 @@ "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Room resource the recording is associated with" + "description": "The SID of the Room resource the recording is associated with." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -1281,19 +1281,19 @@ } }, "nullable": true, - "description": "A collection of recording Rules that describe how to include or exclude matching tracks for recording" + "description": "A collection of Recording Rules that describe how to include or exclude matching tracks for recording" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "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 ISO 8601 date and time in GMT when the resource was last updated" + "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." } } } diff --git a/spec/json/twilio_voice_v1.json b/spec/json/twilio_voice_v1.json index a84af932..61064ba6 100644 --- a/spec/json/twilio_voice_v1.json +++ b/spec/json/twilio_voice_v1.json @@ -8,7 +8,7 @@ "type": "string", "format": "date", "nullable": true, - "description": "date" + "description": "The date" }, "sid": { "type": "string", @@ -16,13 +16,13 @@ "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, - "description": "sid" + "description": "The call sid" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -35,7 +35,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the BYOC Trunk resource." }, "sid": { "type": "string", @@ -43,18 +43,18 @@ "maxLength": 34, "pattern": "^BY[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that that we created to identify the BYOC Trunk resource." }, "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." }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when receiving a call" + "description": "The URL we call using the `voice_method` when the BYOC Trunk receives a call." }, "voice_method": { "type": "string", @@ -68,13 +68,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method to use with voice_url" + "description": "The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`." }, "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when an error occurs while executing TwiML" + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`." }, "voice_fallback_method": { "type": "string", @@ -88,13 +88,13 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method used with voice_fallback_url" + "description": "The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`." }, "status_callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call with status updates" + "description": "The URL that we call to pass status parameters (such as call ended) to your application." }, "status_callback_method": { "type": "string", @@ -108,12 +108,12 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call status_callback_url" + "description": "The HTTP method we use to call `status_callback_url`. Either `GET` or `POST`." }, "cnam_lookup_enabled": { "type": "boolean", "nullable": true, - "description": "Whether Caller ID Name (CNAM) lookup is enabled for the trunk" + "description": "Whether Caller ID Name (CNAM) lookup is enabled for the trunk. If enabled, all inbound calls to the BYOC Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information." }, "connection_policy_sid": { "type": "string", @@ -121,7 +121,7 @@ "maxLength": 34, "pattern": "^NY[0-9a-fA-F]{32}$", "nullable": true, - "description": "Origination Connection Policy (to your Carrier)" + "description": "The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure." }, "from_domain_sid": { "type": "string", @@ -129,25 +129,25 @@ "maxLength": 34, "pattern": "^SD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the SIP Domain that should be used in the `From` header of originating calls" + "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\"." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -160,7 +160,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Connection Policy resource." }, "sid": { "type": "string", @@ -168,36 +168,36 @@ "maxLength": 34, "pattern": "^NY[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Connection Policy resource." }, "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related resources" + "description": "The URLs of related resources." } } }, @@ -210,7 +210,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Target resource." }, "connection_policy_sid": { "type": "string", @@ -218,7 +218,7 @@ "maxLength": 34, "pattern": "^NY[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Connection Policy that owns the Target" + "description": "The SID of the Connection Policy that owns the Target." }, "sid": { "type": "string", @@ -226,51 +226,51 @@ "maxLength": 34, "pattern": "^NE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Target resource." }, "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." }, "target": { "type": "string", "format": "uri", "nullable": true, - "description": "The SIP address you want Twilio to route your calls to" + "description": "The SIP address you want Twilio to route your calls to. This must be a `sip:` schema. `sips` is NOT supported." }, "priority": { "type": "integer", "nullable": true, - "description": "The relative importance of the target" + "description": "The relative importance of the target. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important target." }, "weight": { "type": "integer", "nullable": true, - "description": "The value that determines the relative load the Target should receive compared to others with the same priority" + "description": "The value that determines the relative share of the load the Target should receive compared to other Targets with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. Targets with higher values receive more load than those with lower ones with the same priority." }, "enabled": { "type": "boolean", "nullable": true, - "description": "Whether the target is enabled" + "description": "Whether the target is enabled. The default is `true`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT when the resource was created" + "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 RFC 2822 date and time in GMT when the resource was last updated" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -285,17 +285,17 @@ "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "name": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "continent": { "type": "string", "nullable": true, - "description": "The name of the continent in which the country is located" + "description": "The name of the continent in which the country is located." }, "country_codes": { "type": "array", @@ -303,34 +303,34 @@ "type": "string" }, "nullable": true, - "description": "The E.164 assigned country codes(s)" + "description": "The E.164 assigned [country codes(s)](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)" }, "low_risk_numbers_enabled": { "type": "boolean", "nullable": true, - "description": "Whether dialing to low-risk numbers is enabled" + "description": "Whether dialing to low-risk numbers is enabled." }, "high_risk_special_numbers_enabled": { "type": "boolean", "nullable": true, - "description": "Whether dialing to high-risk special services numbers is enabled" + "description": "Whether dialing to high-risk special services numbers is enabled. These prefixes include number ranges allocated by the country and include premium numbers, special services, shared cost, and others" }, "high_risk_tollfraud_numbers_enabled": { "type": "boolean", "nullable": true, - "description": "Whether dialing to high-risk toll fraud numbers is enabled, else `false`" + "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" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of this resource" + "description": "The absolute URL of this resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of URLs related to this resource" + "description": "A list of URLs related to this resource." } } }, @@ -341,17 +341,17 @@ "type": "string", "format": "iso-country-code", "nullable": true, - "description": "The ISO country code" + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "name": { "type": "string", "nullable": true, - "description": "The name of the country" + "description": "The name of the country." }, "continent": { "type": "string", "nullable": true, - "description": "The name of the continent in which the country is located" + "description": "The name of the continent in which the country is located." }, "country_codes": { "type": "array", @@ -359,34 +359,34 @@ "type": "string" }, "nullable": true, - "description": "The E.164 assigned country codes(s)" + "description": "The E.164 assigned [country codes(s)](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)" }, "low_risk_numbers_enabled": { "type": "boolean", "nullable": true, - "description": "Whether dialing to low-risk numbers is enabled" + "description": "Whether dialing to low-risk numbers is enabled." }, "high_risk_special_numbers_enabled": { "type": "boolean", "nullable": true, - "description": "Whether dialing to high-risk special services numbers is enabled" + "description": "Whether dialing to high-risk special services numbers is enabled. These prefixes include number ranges allocated by the country and include premium numbers, special services, shared cost, and others" }, "high_risk_tollfraud_numbers_enabled": { "type": "boolean", "nullable": true, - "description": "Whether dialing to high-risk toll fraud numbers is enabled, else `false`" + "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" }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of this resource" + "description": "The absolute URL of this resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "A list of URLs related to this resource" + "description": "A list of URLs related to this resource." } } }, @@ -401,7 +401,7 @@ "update_request": { "type": "string", "nullable": true, - "description": "A URL encoded JSON array of update objects" + "description": "A bulk update request to change voice dialing country permissions stored as a URL-encoded, JSON array of update objects. For example : `[ { \"iso_code\": \"GB\", \"low_risk_numbers_enabled\": \"true\", \"high_risk_special_numbers_enabled\":\"true\", \"high_risk_tollfraud_numbers_enabled\": \"false\" } ]`" } } }, @@ -411,7 +411,7 @@ "prefix": { "type": "string", "nullable": true, - "description": "A prefix that includes the E.164 assigned country code" + "description": "A prefix is a contiguous number range for a block of E.164 numbers that includes the E.164 assigned country code. For example, a North American Numbering Plan prefix like `+1510720` written like `+1(510) 720` matches all numbers inclusive from `+1(510) 720-0000` to `+1(510) 720-9999`." } } }, @@ -421,13 +421,13 @@ "dialing_permissions_inheritance": { "type": "boolean", "nullable": true, - "description": "`true` if the sub-account will inherit voice dialing permissions from the Master Project; otherwise `false`" + "description": "`true` if the sub-account will inherit voice dialing permissions from the Master Project; otherwise `false`." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of this resource" + "description": "The absolute URL of this resource." } } }, @@ -440,7 +440,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IP Record resource." }, "sid": { "type": "string", @@ -448,12 +448,12 @@ "maxLength": 34, "pattern": "^IL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the IP Record resource." }, "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." }, "ip_address": { "type": "string", @@ -469,19 +469,19 @@ "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -494,7 +494,7 @@ "maxLength": 34, "pattern": "^IB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the IP Record resource." }, "ip_record_sid": { "type": "string", @@ -502,7 +502,7 @@ "maxLength": 34, "pattern": "^IL[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies an IP Record" + "description": "The Twilio-provided string that uniquely identifies the IP Record resource to map from." }, "sip_domain_sid": { "type": "string", @@ -510,25 +510,25 @@ "maxLength": 34, "pattern": "^SD[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies a SIP Domain" + "description": "The SID of the SIP Domain that the IP Record is mapped to." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The RFC 2822 date and time in GMT that the resource was created" + "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 RFC 2822 date and time in GMT that the resource was last updated" + "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." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } } diff --git a/spec/json/twilio_wireless_v1.json b/spec/json/twilio_wireless_v1.json index 97f13263..31b3de3e 100644 --- a/spec/json/twilio_wireless_v1.json +++ b/spec/json/twilio_wireless_v1.json @@ -10,19 +10,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AccountUsageRecord resource." }, "period": { "nullable": true, - "description": "The time period for which usage is reported" + "description": "The time period for which usage is reported. Contains `start` and `end` properties that describe the period using GMT date-time values specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "commands": { "nullable": true, - "description": "An object that describes the aggregated Commands usage for all SIMs during the specified period" + "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)." }, "data": { "nullable": true, - "description": "An object that describes the aggregated Data usage for all SIMs over the period" + "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)." } } }, @@ -43,7 +43,7 @@ "maxLength": 34, "pattern": "^DC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the Command resource." }, "account_sid": { "type": "string", @@ -51,7 +51,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Command resource." }, "sim_sid": { "type": "string", @@ -59,59 +59,59 @@ "maxLength": 34, "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Sim resource that the Command was sent to or from" + "description": "The SID of the [Sim resource](https://www.twilio.com/docs/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" + "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." }, "command_mode": { "type": "string", "$ref": "#/components/schemas/command_enum_command_mode", "nullable": true, - "description": "The mode used to send the SMS message" + "description": "The mode used to send the SMS message. Can be: `text` or `binary`. The default SMS mode is `text`." }, "transport": { "type": "string", "$ref": "#/components/schemas/command_enum_transport", "nullable": true, - "description": "The type of transport used" + "description": "The type of transport used. Can be: `sms` or `ip`." }, "delivery_receipt_requested": { "type": "boolean", "nullable": true, - "description": "Whether to request a delivery receipt" + "description": "Whether to request a delivery receipt." }, "status": { "type": "string", "$ref": "#/components/schemas/command_enum_status", "nullable": true, - "description": "The status of the Command" + "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." }, "direction": { "type": "string", "$ref": "#/components/schemas/command_enum_direction", "nullable": true, - "description": "The direction of the Command" + "description": "The direction of the Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was last updated format" + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -152,12 +152,12 @@ "sid": { "type": "string", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the DataSession resource." }, "sim_sid": { "type": "string", "nullable": true, - "description": "The SID of the Sim resource that the Data Session is for" + "description": "The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) that the Data Session is for." }, "account_sid": { "type": "string", @@ -165,74 +165,74 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the DataSession resource." }, "radio_link": { "type": "string", "nullable": true, - "description": "The generation of wireless technology that the device was using" + "description": "The generation of wireless technology that the device was using." }, "operator_mcc": { "type": "string", "nullable": true, - "description": "The 'mobile country code' is the unique ID of the home country where the Data Session took place" + "description": "The 'mobile country code' is the unique ID of the home country where the Data Session took place. See: [MCC/MNC lookup](http://mcc-mnc.com/)." }, "operator_mnc": { "type": "string", "nullable": true, - "description": "The 'mobile network code' is the unique ID specific to the mobile operator network where the Data Session took place" + "description": "The 'mobile network code' is the unique ID specific to the mobile operator network where the Data Session took place." }, "operator_country": { "type": "string", "nullable": true, - "description": "The three letter country code representing where the device's Data Session took place" + "description": "The three letter country code representing where the device's Data Session took place. This is determined by looking up the `operator_mcc`." }, "operator_name": { "type": "string", "nullable": true, - "description": "The friendly name of the mobile operator network that the SIM-connected device is attached to" + "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`." }, "cell_id": { "type": "string", "nullable": true, - "description": "The unique ID of the cellular tower that the device was attached to at the moment when the Data Session was last updated" + "description": "The unique ID of the cellular tower that the device was attached to at the moment when the Data Session was last updated." }, "cell_location_estimate": { "nullable": true, - "description": "An object with the estimated location where the device's Data Session took place" + "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). " }, "packets_uploaded": { "type": "integer", "nullable": true, - "description": "The number of packets uploaded by the device between the start time and when the Data Session was last updated" + "description": "The number of packets uploaded by the device between the `start` time and when the Data Session was last updated." }, "packets_downloaded": { "type": "integer", "nullable": true, - "description": "The number of packets downloaded by the device between the start time and when the Data Session was last updated" + "description": "The number of packets downloaded by the device between the `start` time and when the Data Session was last updated." }, "last_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that the resource was last updated, given as GMT in ISO 8601 format" + "description": "The date that the resource was last updated, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "start": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that the Data Session started, given as GMT in ISO 8601 format" + "description": "The date that the Data Session started, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "end": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that the record ended, given as GMT in ISO 8601 format" + "description": "The date that the record ended, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "imei": { "type": "string", "nullable": true, - "description": "The unique ID of the device using the SIM to connect" + "description": "The 'international mobile equipment identity' is the unique ID of the device using the SIM to connect. An IMEI is a 15-digit string: 14 digits for the device identifier plus a check digit calculated using the Luhn formula." } } }, @@ -245,12 +245,12 @@ "maxLength": 34, "pattern": "^WP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the resource" + "description": "The unique string that we created to identify the RatePlan resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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." }, "account_sid": { "type": "string", @@ -258,47 +258,47 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the RatePlan resource." }, "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." }, "data_enabled": { "type": "boolean", "nullable": true, - "description": "Whether SIMs can use GPRS/3G/4G/LTE data connectivity" + "description": "Whether SIMs can use GPRS/3G/4G/LTE data connectivity." }, "data_metering": { "type": "string", "nullable": true, - "description": "The model used to meter data usage" + "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)." }, "data_limit": { "type": "integer", "nullable": true, - "description": "The total data usage in Megabytes that the Network allows during one month on the home network" + "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile USA). The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB." }, "messaging_enabled": { "type": "boolean", "nullable": true, - "description": "Whether SIMs can make, send, and receive SMS using Commands" + "description": "Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/wireless/api/command-resource)." }, "voice_enabled": { "type": "boolean", "nullable": true, - "description": "Deprecated. Whether SIMs can make and receive voice calls" + "description": "Deprecated. Whether SIMs can make and receive voice calls." }, "national_roaming_enabled": { "type": "boolean", "nullable": true, - "description": "Whether SIMs can roam on networks other than the home network in the United States" + "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)." }, "national_roaming_data_limit": { "type": "integer", "nullable": true, - "description": "The total data usage in Megabytes that the Network allows during one month on non-home networks in the United States" + "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." }, "international_roaming": { "type": "array", @@ -306,30 +306,30 @@ "type": "string" }, "nullable": true, - "description": "The services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States" + "description": "The list of services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can contain: `data` and `messaging`." }, "international_roaming_data_limit": { "type": "integer", "nullable": true, - "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States" + "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." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date when the resource was created, given as GMT in ISO 8601 format" + "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date when the resource was last updated, given as GMT in ISO 8601 format" + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." } } }, @@ -349,12 +349,12 @@ "maxLength": 34, "pattern": "^DE[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that identifies the Sim resource" + "description": "The unique string that we created to identify the Sim resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies 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." }, "account_sid": { "type": "string", @@ -362,7 +362,7 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account to which the Sim resource belongs" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource belongs." }, "rate_plan_sid": { "type": "string", @@ -370,40 +370,40 @@ "maxLength": 34, "pattern": "^WP[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the RatePlan resource to which the Sim resource is assigned." + "description": "The SID of the [RatePlan resource](https://www.twilio.com/docs/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." }, "iccid": { "type": "string", "nullable": true, - "description": "The ICCID associated with the SIM" + "description": "The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM." }, "e_id": { "type": "string", "nullable": true, - "description": "Deprecated" + "description": "Deprecated." }, "status": { "type": "string", "$ref": "#/components/schemas/sim_enum_status", "nullable": true, - "description": "The status of the Sim resource" + "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." }, "reset_status": { "type": "string", "$ref": "#/components/schemas/sim_enum_reset_status", "nullable": true, - "description": "The connectivity reset status of the SIM" + "description": "The connectivity reset status of the SIM. Can be: null or `resetting`. When a connectivity reset is initiated on a SIM, this property is `resetting`. After the reset completes, it is null." }, "commands_callback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call when the SIM originates a machine-to-machine Command" + "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." }, "commands_callback_method": { "type": "string", @@ -417,7 +417,7 @@ "DELETE" ], "nullable": true, - "description": "The HTTP method we use to call commands_callback_url" + "description": "The HTTP method we use to call `commands_callback_url`. Can be: `POST` or `GET`. Default is `POST`." }, "sms_fallback_method": { "type": "string", @@ -431,13 +431,13 @@ "DELETE" ], "nullable": true, - "description": "Deprecated" + "description": "Deprecated." }, "sms_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "Deprecated" + "description": "Deprecated." }, "sms_method": { "type": "string", @@ -451,13 +451,13 @@ "DELETE" ], "nullable": true, - "description": "Deprecated" + "description": "Deprecated." }, "sms_url": { "type": "string", "format": "uri", "nullable": true, - "description": "Deprecated" + "description": "Deprecated." }, "voice_fallback_method": { "type": "string", @@ -471,13 +471,13 @@ "DELETE" ], "nullable": true, - "description": "Deprecated. The HTTP method we use to call voice_fallback_url" + "description": "Deprecated. The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`. Default is `POST`." }, "voice_fallback_url": { "type": "string", "format": "uri", "nullable": true, - "description": "Deprecated. The URL we call when an error occurs while retrieving or executing the TwiML requested from voice_url" + "description": "Deprecated. The URL we call using the `voice_fallback_method` when an error occurs while retrieving or executing the TwiML requested from `voice_url`." }, "voice_method": { "type": "string", @@ -491,42 +491,42 @@ "DELETE" ], "nullable": true, - "description": "Deprecated. The HTTP method we use to call voice_url" + "description": "Deprecated. The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`. Default is `POST`." }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "Deprecated. The URL we call when the SIM-connected device makes a voice call" + "description": "Deprecated. The URL we call using the `voice_method` when the SIM-connected device makes a voice call." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the resource was created" + "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The ISO 8601 date and time in GMT when the Sim resource was last updated" + "description": "The date and time in GMT when the Sim resource was last updated specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource" + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, - "description": "The URLs of related subresources" + "description": "The URLs of related subresources." }, "ip_address": { "type": "string", "nullable": true, - "description": "Deprecated" + "description": "Deprecated." } } }, @@ -555,7 +555,7 @@ "sim_sid": { "type": "string", "nullable": true, - "description": "The SID of the Sim resource that this Usage Record is for" + "description": "The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) that this Usage Record is for." }, "account_sid": { "type": "string", @@ -563,19 +563,19 @@ "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Account that created the resource" + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resource." }, "period": { "nullable": true, - "description": "The time period for which the usage is reported" + "description": "The time period for which the usage is reported. Contains `start` and `end` datetime values given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "commands": { "nullable": true, - "description": "An object that describes the SIM's usage of Commands during the specified period" + "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)." }, "data": { "nullable": true, - "description": "An object that describes the SIM's data usage during the specified period" + "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)." } } }, diff --git a/spec/yaml/twilio_accounts_v1.yaml b/spec/yaml/twilio_accounts_v1.yaml index 956f5cbd..c293666a 100644 --- a/spec/yaml/twilio_accounts_v1.yaml +++ b/spec/yaml/twilio_accounts_v1.yaml @@ -9,24 +9,25 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that the secondary Auth Token was created - for + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that the secondary Auth Token was created for. auth_token: type: string nullable: true - description: The promoted Auth Token + description: The promoted Auth Token that must be used to authenticate future + API requests. date_created: type: string format: date-time nullable: true - description: The ISO 8601 formatted date and time in UTC when the resource - was created + description: The date and time in UTC 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 ISO 8601 formatted date and time in UTC when the resource - was last updated + 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 @@ -44,29 +45,31 @@ components: maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the AWS resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the AWS resource. 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. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri @@ -81,30 +84,32 @@ components: maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the PublicKey + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Credential that the - PublicKey resource belongs to + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Credential that the PublicKey resource belongs to. 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. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri @@ -119,24 +124,25 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that the secondary Auth Token was created - for + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that the secondary Auth Token was created for. date_created: type: string format: date-time nullable: true - description: The ISO 8601 formatted date and time in UTC when the resource - was created + description: The date and time in UTC 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 ISO 8601 formatted date and time in UTC when the resource - was last updated + description: The date and time in UTC when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. secondary_auth_token: type: string nullable: true - description: The generated secondary Auth Token + description: The generated secondary Auth Token that can be used to authenticate + future API requests. url: type: string format: uri diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index 1bd2c788..1b9a5b5c 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -6,29 +6,33 @@ components: auth_token: type: string nullable: true - description: The authorization token for this account + description: The authorization token for this account. This token should + be kept a secret, so no sharing. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The date this account was created + description: The date that this account was created, in GMT in RFC 2822 + format date_updated: type: string format: date-time-rfc-2822 nullable: true - description: The date this account was last updated + description: The date that this account was last updated, in GMT in RFC + 2822 format. friendly_name: type: string nullable: true - description: A human readable description of this account + description: A human readable description of this account, up to 64 characters + long. By default the FriendlyName is your email address. owner_account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique 34 character id representing the parent of this - account + description: The unique 34 character id that represents the parent of this + account. The OwnerAccountSid of a parent account is it's own sid. sid: type: string minLength: 34 @@ -40,17 +44,20 @@ components: type: string $ref: '#/components/schemas/account_enum_status' nullable: true - description: The status of this account + description: The status of this account. Usually `active`, but can be `suspended` + or `closed`. subresource_uris: type: object format: uri-map nullable: true - description: Account Instance Subresources + description: A Map of various subresources available for the given Account + Instance type: type: string $ref: '#/components/schemas/account_enum_type' nullable: true - description: The type of this account + description: The type of this account. Either `Trial` or `Full` if it's + been upgraded uri: type: string nullable: true @@ -75,75 +82,85 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that is responsible for the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that is responsible for the Address resource. city: type: string nullable: true - description: The city in which the address is located + description: The city in which the address is located. customer_name: type: string nullable: true - description: The name associated with the address + description: The name associated with the address.This property has a maximum + length of 16 4-byte characters, or 21 3-byte characters. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. 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. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code of the address + description: The ISO country code of the address. postal_code: type: string nullable: true - description: The postal code of the address + description: The postal code of the address. region: type: string nullable: true - description: The state or region of the address + description: The state or region of the address. sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Address + resource. street: type: string nullable: true - description: The number and street address of the address + description: The number and street address of the address. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. emergency_enabled: type: boolean nullable: true - description: Whether emergency calling has been enabled on this number + description: Whether emergency calling has been enabled on this number. validated: type: boolean nullable: true description: Whether the address has been validated to comply with local - regulation + regulation. In countries that require valid addresses, an invalid address + will not be accepted. `true` indicates the Address has been validated. + `false` indicate the country doesn't require validation or the Address + is not valid. verified: type: boolean nullable: true - description: Whether the address has been verified to comply with regulation + description: Whether the address has been verified to comply with regulation. + In countries that require valid addresses, an invalid address will not + be accepted. `true` indicates the Address has been verified. `false` indicate + the country doesn't require verified or the Address is not valid. 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. api.v2010.account.application: type: object properties: @@ -153,38 +170,42 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Application resource. api_version: type: string nullable: true - description: The API version used to start a new TwiML session + description: The API version used to start a new TwiML session. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. 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. message_status_callback: type: string format: uri nullable: true - description: The URL to send message status information to your application + description: The URL we call using a POST method to send message status + information to your application. sid: type: string minLength: 34 maxLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Application + resource. sms_fallback_method: type: string format: http-method @@ -196,13 +217,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with sms_fallback_url + description: 'The HTTP method we use to call `sms_fallback_url`. Can be: + `GET` or `POST`.' sms_fallback_url: type: string format: uri nullable: true description: The URL that we call when an error occurs while retrieving - or executing the TwiML + or executing the TwiML from `sms_url`. sms_method: type: string format: http-method @@ -214,23 +236,26 @@ components: - PUT - DELETE nullable: true - description: The HTTP method to use with sms_url + description: 'The HTTP method we use to call `sms_url`. Can be: `GET` or + `POST`.' sms_status_callback: type: string format: uri nullable: true - description: The URL to send status information to your application + description: The URL we call using a POST method to send status information + to your application about SMS messages that refer to the application. sms_url: type: string format: uri nullable: true description: The URL we call when the phone number receives an incoming - SMS message + SMS message. status_callback: type: string format: uri nullable: true - description: The URL to send status information to your application + description: The URL we call using the `status_callback_method` to send + status information to your application. status_callback_method: type: string format: http-method @@ -242,15 +267,17 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call status_callback + description: 'The HTTP method we use to call `status_callback`. Can be: + `GET` or `POST`.' uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. voice_caller_id_lookup: type: boolean nullable: true - description: Whether to lookup the caller's name + description: 'Whether we look up the caller''s caller-ID name from the CNAM + database (additional charges apply). Can be: `true` or `false`.' voice_fallback_method: type: string format: http-method @@ -262,12 +289,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with voice_fallback_url + description: 'The HTTP method we use to call `voice_fallback_url`. Can be: + `GET` or `POST`.' voice_fallback_url: type: string format: uri nullable: true - description: The URL we call when a TwiML error occurs + description: The URL that we call when an error occurs retrieving or executing + the TwiML requested by `url`. voice_method: type: string format: http-method @@ -279,12 +308,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with the voice_url + description: 'The HTTP method we use to call `voice_url`. Can be: `GET` + or `POST`.' voice_url: type: string format: uri nullable: true - description: The URL we call when the phone number receives a call + description: The URL we call when the phone number assigned to this application + receives a call. api.v2010.account.authorized_connect_app: type: object properties: @@ -294,53 +325,56 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the AuthorizedConnectApp resource. connect_app_company_name: type: string nullable: true - description: The company name set for the Connect App + description: The company name set for the Connect App. connect_app_description: type: string nullable: true - description: A detailed description of the app + description: A detailed description of the Connect App. connect_app_friendly_name: type: string nullable: true - description: The name of the Connect App + description: The name of the Connect App. connect_app_homepage_url: type: string format: uri nullable: true - description: The public URL for the Connect App + description: The public URL for the Connect App. connect_app_sid: type: string minLength: 34 maxLength: 34 pattern: ^CN[0-9a-fA-F]{32}$ nullable: true - description: The SID that we assigned to the Connect App + description: The SID that we assigned to the Connect App. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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: type: string $ref: '#/components/schemas/authorized_connect_app_enum_permission' nullable: true - description: Permissions authorized to the app + description: 'The set of permissions that you authorized for the Connect + App. Can be: `get-all` or `post-all`.' uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. authorized_connect_app_enum_permission: type: string enum: @@ -353,26 +387,29 @@ components: type: string format: iso-country-code nullable: true - description: The ISO-3166-1 country code of the country. + description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + country code of the country. country: type: string nullable: true - description: The name of the country + description: The name of the country. uri: type: string format: uri nullable: true - description: The URI of the Country resource, relative to `https://api.twilio.com` + description: The URI of the Country resource, relative to `https://api.twilio.com`. beta: type: boolean nullable: true description: Whether all phone numbers available in the country are new - to the Twilio platform. + to the Twilio platform. `true` if they are and `false` if all numbers + are not in the Twilio Phone Number Beta program. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related AvailablePhoneNumber resources identified + by their URIs relative to `https://api.twilio.com`. api.v2010.account.available_phone_number_country.available_phone_number_local: type: object properties: @@ -380,54 +417,70 @@ components: type: string format: phone-number nullable: true - description: A formatted version of the phone number + description: A formatted version of the phone number. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. lata: type: string nullable: true - description: The LATA of this phone number + description: The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) + of this phone number. Available for only phone numbers from the US and + Canada. locality: type: string nullable: true - description: The locality or city of this phone number's location + description: The locality or city of this phone number's location. rate_center: type: string nullable: true - description: The rate center of this phone number + description: The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) + of this phone number. Available for only phone numbers from the US and + Canada. latitude: type: number nullable: true - description: The latitude of this phone number's location + description: The latitude of this phone number's location. Available for + only phone numbers from the US and Canada. longitude: type: number nullable: true - description: The longitude of this phone number's location + description: The longitude of this phone number's location. Available for + only phone numbers from the US and Canada. region: type: string nullable: true description: The two-letter state or province abbreviation of this phone - number's location + number's location. Available for only phone numbers from the US and Canada. postal_code: type: string nullable: true - description: The postal or ZIP code of this phone number's location + description: The postal or ZIP code of this phone number's location. Available + for only phone numbers from the US and Canada. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code of this phone number + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + of this phone number. address_requirements: type: string nullable: true - description: The type of Address resource the phone number requires + description: 'The type of [Address](https://www.twilio.com/docs/usage/api/address) + resource the phone number requires. Can be: `none`, `any`, `local`, or + `foreign`. `none` means no address is required. `any` means an address + is required, but it can be anywhere in the world. `local` means an address + in the phone number''s country is required. `foreign` means an address + outside of the phone number''s country is required.' beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: phone-number-capabilities @@ -441,7 +494,9 @@ components: fax: type: boolean nullable: true - description: Whether a phone number can receive calls or messages + 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`.' api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine: type: object properties: @@ -449,54 +504,70 @@ components: type: string format: phone-number nullable: true - description: A formatted version of the phone number + description: A formatted version of the phone number. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. lata: type: string nullable: true - description: The LATA of this phone number + description: The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) + of this phone number. Available for only phone numbers from the US and + Canada. locality: type: string nullable: true - description: The locality or city of this phone number's location + description: The locality or city of this phone number's location. rate_center: type: string nullable: true - description: The rate center of this phone number + description: The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) + of this phone number. Available for only phone numbers from the US and + Canada. latitude: type: number nullable: true - description: The latitude of this phone number's location + description: The latitude of this phone number's location. Available for + only phone numbers from the US and Canada. longitude: type: number nullable: true - description: The longitude of this phone number's location + description: The longitude of this phone number's location. Available for + only phone numbers from the US and Canada. region: type: string nullable: true description: The two-letter state or province abbreviation of this phone - number's location + number's location. Available for only phone numbers from the US and Canada. postal_code: type: string nullable: true - description: The postal or ZIP code of this phone number's location + description: The postal or ZIP code of this phone number's location. Available + for only phone numbers from the US and Canada. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code of this phone number + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + of this phone number. address_requirements: type: string nullable: true - description: The type of Address resource the phone number requires + description: 'The type of [Address](https://www.twilio.com/docs/usage/api/address) + resource the phone number requires. Can be: `none`, `any`, `local`, or + `foreign`. `none` means no address is required. `any` means an address + is required, but it can be anywhere in the world. `local` means an address + in the phone number''s country is required. `foreign` means an address + outside of the phone number''s country is required.' beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: phone-number-capabilities @@ -510,7 +581,9 @@ components: fax: type: boolean nullable: true - description: Whether a phone number can receive calls or messages + 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`.' api.v2010.account.available_phone_number_country.available_phone_number_mobile: type: object properties: @@ -518,54 +591,70 @@ components: type: string format: phone-number nullable: true - description: A formatted version of the phone number + description: A formatted version of the phone number. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. lata: type: string nullable: true - description: The LATA of this phone number + description: The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) + of this phone number. Available for only phone numbers from the US and + Canada. locality: type: string nullable: true - description: The locality or city of this phone number's location + description: The locality or city of this phone number's location. rate_center: type: string nullable: true - description: The rate center of this phone number + description: The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) + of this phone number. Available for only phone numbers from the US and + Canada. latitude: type: number nullable: true - description: The latitude of this phone number's location + description: The latitude of this phone number's location. Available for + only phone numbers from the US and Canada. longitude: type: number nullable: true - description: The longitude of this phone number's location + description: The longitude of this phone number's location. Available for + only phone numbers from the US and Canada. region: type: string nullable: true description: The two-letter state or province abbreviation of this phone - number's location + number's location. Available for only phone numbers from the US and Canada. postal_code: type: string nullable: true - description: The postal or ZIP code of this phone number's location + description: The postal or ZIP code of this phone number's location. Available + for only phone numbers from the US and Canada. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code of this phone number + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + of this phone number. address_requirements: type: string nullable: true - description: The type of Address resource the phone number requires + description: 'The type of [Address](https://www.twilio.com/docs/usage/api/address) + resource the phone number requires. Can be: `none`, `any`, `local`, or + `foreign`. `none` means no address is required. `any` means an address + is required, but it can be anywhere in the world. `local` means an address + in the phone number''s country is required. `foreign` means an address + outside of the phone number''s country is required.' beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: phone-number-capabilities @@ -579,7 +668,9 @@ components: fax: type: boolean nullable: true - description: Whether a phone number can receive calls or messages + 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`.' api.v2010.account.available_phone_number_country.available_phone_number_national: type: object properties: @@ -587,54 +678,70 @@ components: type: string format: phone-number nullable: true - description: A formatted version of the phone number + description: A formatted version of the phone number. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. lata: type: string nullable: true - description: The LATA of this phone number + description: The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) + of this phone number. Available for only phone numbers from the US and + Canada. locality: type: string nullable: true - description: The locality or city of this phone number's location + description: The locality or city of this phone number's location. rate_center: type: string nullable: true - description: The rate center of this phone number + description: The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) + of this phone number. Available for only phone numbers from the US and + Canada. latitude: type: number nullable: true - description: The latitude of this phone number's location + description: The latitude of this phone number's location. Available for + only phone numbers from the US and Canada. longitude: type: number nullable: true - description: The longitude of this phone number's location + description: The longitude of this phone number's location. Available for + only phone numbers from the US and Canada. region: type: string nullable: true description: The two-letter state or province abbreviation of this phone - number's location + number's location. Available for only phone numbers from the US and Canada. postal_code: type: string nullable: true - description: The postal or ZIP code of this phone number's location + description: The postal or ZIP code of this phone number's location. Available + for only phone numbers from the US and Canada. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code of this phone number + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + of this phone number. address_requirements: type: string nullable: true - description: The type of Address resource the phone number requires + description: 'The type of [Address](https://www.twilio.com/docs/usage/api/address) + resource the phone number requires. Can be: `none`, `any`, `local`, or + `foreign`. `none` means no address is required. `any` means an address + is required, but it can be anywhere in the world. `local` means an address + in the phone number''s country is required. `foreign` means an address + outside of the phone number''s country is required.' beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: phone-number-capabilities @@ -648,7 +755,9 @@ components: fax: type: boolean nullable: true - description: Whether a phone number can receive calls or messages + 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`.' api.v2010.account.available_phone_number_country.available_phone_number_shared_cost: type: object properties: @@ -656,54 +765,70 @@ components: type: string format: phone-number nullable: true - description: A formatted version of the phone number + description: A formatted version of the phone number. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. lata: type: string nullable: true - description: The LATA of this phone number + description: The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) + of this phone number. Available for only phone numbers from the US and + Canada. locality: type: string nullable: true - description: The locality or city of this phone number's location + description: The locality or city of this phone number's location. rate_center: type: string nullable: true - description: The rate center of this phone number + description: The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) + of this phone number. Available for only phone numbers from the US and + Canada. latitude: type: number nullable: true - description: The latitude of this phone number's location + description: The latitude of this phone number's location. Available for + only phone numbers from the US and Canada. longitude: type: number nullable: true - description: The longitude of this phone number's location + description: The longitude of this phone number's location. Available for + only phone numbers from the US and Canada. region: type: string nullable: true description: The two-letter state or province abbreviation of this phone - number's location + number's location. Available for only phone numbers from the US and Canada. postal_code: type: string nullable: true - description: The postal or ZIP code of this phone number's location + description: The postal or ZIP code of this phone number's location. Available + for only phone numbers from the US and Canada. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code of this phone number + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + of this phone number. address_requirements: type: string nullable: true - description: The type of Address resource the phone number requires + description: 'The type of [Address](https://www.twilio.com/docs/usage/api/address) + resource the phone number requires. Can be: `none`, `any`, `local`, or + `foreign`. `none` means no address is required. `any` means an address + is required, but it can be anywhere in the world. `local` means an address + in the phone number''s country is required. `foreign` means an address + outside of the phone number''s country is required.' beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: phone-number-capabilities @@ -717,7 +842,9 @@ components: fax: type: boolean nullable: true - description: Whether a phone number can receive calls or messages + 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`.' api.v2010.account.available_phone_number_country.available_phone_number_toll_free: type: object properties: @@ -725,54 +852,70 @@ components: type: string format: phone-number nullable: true - description: A formatted version of the phone number + description: A formatted version of the phone number. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. lata: type: string nullable: true - description: The LATA of this phone number + description: The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) + of this phone number. Available for only phone numbers from the US and + Canada. locality: type: string nullable: true - description: The locality or city of this phone number's location + description: The locality or city of this phone number's location. rate_center: type: string nullable: true - description: The rate center of this phone number + description: The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) + of this phone number. Available for only phone numbers from the US and + Canada. latitude: type: number nullable: true - description: The latitude of this phone number's location + description: The latitude of this phone number's location. Available for + only phone numbers from the US and Canada. longitude: type: number nullable: true - description: The longitude of this phone number's location + description: The longitude of this phone number's location. Available for + only phone numbers from the US and Canada. region: type: string nullable: true description: The two-letter state or province abbreviation of this phone - number's location + number's location. Available for only phone numbers from the US and Canada. postal_code: type: string nullable: true - description: The postal or ZIP code of this phone number's location + description: The postal or ZIP code of this phone number's location. Available + for only phone numbers from the US and Canada. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code of this phone number + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + of this phone number. address_requirements: type: string nullable: true - description: The type of Address resource the phone number requires + description: 'The type of [Address](https://www.twilio.com/docs/usage/api/address) + resource the phone number requires. Can be: `none`, `any`, `local`, or + `foreign`. `none` means no address is required. `any` means an address + is required, but it can be anywhere in the world. `local` means an address + in the phone number''s country is required. `foreign` means an address + outside of the phone number''s country is required.' beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: phone-number-capabilities @@ -786,7 +929,9 @@ components: fax: type: boolean nullable: true - description: Whether a phone number can receive calls or messages + 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`.' api.v2010.account.available_phone_number_country.available_phone_number_voip: type: object properties: @@ -794,54 +939,70 @@ components: type: string format: phone-number nullable: true - description: A formatted version of the phone number + description: A formatted version of the phone number. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. lata: type: string nullable: true - description: The LATA of this phone number + description: The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) + of this phone number. Available for only phone numbers from the US and + Canada. locality: type: string nullable: true - description: The locality or city of this phone number's location + description: The locality or city of this phone number's location. rate_center: type: string nullable: true - description: The rate center of this phone number + description: The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) + of this phone number. Available for only phone numbers from the US and + Canada. latitude: type: number nullable: true - description: The latitude of this phone number's location + description: The latitude of this phone number's location. Available for + only phone numbers from the US and Canada. longitude: type: number nullable: true - description: The longitude of this phone number's location + description: The longitude of this phone number's location. Available for + only phone numbers from the US and Canada. region: type: string nullable: true description: The two-letter state or province abbreviation of this phone - number's location + number's location. Available for only phone numbers from the US and Canada. postal_code: type: string nullable: true - description: The postal or ZIP code of this phone number's location + description: The postal or ZIP code of this phone number's location. Available + for only phone numbers from the US and Canada. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code of this phone number + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + of this phone number. address_requirements: type: string nullable: true - description: The type of Address resource the phone number requires + description: 'The type of [Address](https://www.twilio.com/docs/usage/api/address) + resource the phone number requires. Can be: `none`, `any`, `local`, or + `foreign`. `none` means no address is required. `any` means an address + is required, but it can be anywhere in the world. `local` means an address + in the phone number''s country is required. `foreign` means an address + outside of the phone number''s country is required.' beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: phone-number-capabilities @@ -855,7 +1016,9 @@ components: fax: type: boolean nullable: true - description: Whether a phone number can receive calls or messages + 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`.' api.v2010.account.balance: type: object properties: @@ -865,15 +1028,17 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account Sid. + description: The unique SID identifier of the Account. balance: type: string nullable: true - description: Account balance + description: The balance of the Account, in units specified by the unit + parameter. Balance changes may not be reflected immediately. Child accounts + do not contain balance information currency: type: string nullable: true - description: Currency units + description: The units of currency for the account balance api.v2010.account.call: type: object properties: @@ -883,18 +1048,19 @@ components: maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies this resource + description: The unique string that we created to identify this Call resource. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that this resource was created + description: The date and time in GMT that this 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 RFC 2822 date and time in GMT that this resource was last - updated + 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. parent_call_sid: type: string minLength: 34 @@ -908,31 +1074,37 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created this resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created this Call resource. to: type: string nullable: true - description: The phone number, SIP address or Client identifier that received - this call. 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, 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`. to_formatted: type: string nullable: true description: The phone number, SIP address or Client identifier that received - this call. Formatted for display. + 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). from: type: string nullable: true - description: The phone number, SIP address or Client identifier that made - this call. 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, 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`. from_formatted: type: string nullable: true description: The calling phone number, SIP address, or Client identifier - formatted for display. + formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) + format (e.g., +442071838750). phone_number_sid: type: string minLength: 34 @@ -946,23 +1118,27 @@ components: type: string $ref: '#/components/schemas/call_enum_status' nullable: true - description: The status of this call. + description: 'The status of this call. Can be: `queued`, `ringing`, `in-progress`, + `canceled`, `completed`, `failed`, `busy` or `no-answer`. See [Call Status + Values](https://www.twilio.com/docs/voice/api/call-resource#call-status-values) + below for more information.' start_time: type: string format: date-time-rfc-2822 nullable: true - description: The start time of the call. Null if the call has not yet been - dialed. + description: The start time of the call, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) + format. Empty if the call has not yet been dialed. end_time: type: string format: date-time-rfc-2822 nullable: true - description: The end time of the call. Null if the call did not complete - successfully. + description: The time the call ended, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) + format. Empty if the call did not complete successfully. duration: type: string nullable: true - description: The length of the call in seconds. + description: The length of the call in seconds. This value is empty for + busy, failed, unanswered, or ongoing calls. price: type: string nullable: true @@ -973,13 +1149,19 @@ components: type: string format: currency nullable: true - description: The currency in which `Price` is measured. + description: The currency in which `Price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format (e.g., `USD`, `EUR`, `JPY`). Always capitalized for calls. direction: type: string nullable: true - description: A string describing the direction of the call. `inbound` for - inbound calls, `outbound-api` for calls initiated via the REST API or - `outbound-dial` for calls initiated by a `Dial` verb. + description: 'A string describing the direction of the call. Can be: `inbound` + for inbound calls, `outbound-api` for calls initiated via the REST API + or `outbound-dial` for calls initiated by a `` verb. Using [Elastic + SIP Trunking](https://www.twilio.com/docs/sip-trunking), the values can + be [`trunking-terminating`](https://www.twilio.com/docs/sip-trunking#termination) + for outgoing calls from your communications infrastructure to the PSTN + or [`trunking-originating`](https://www.twilio.com/docs/sip-trunking#origination) + for incoming calls to your communications infrastructure from the PSTN.' answered_by: type: string nullable: true @@ -988,7 +1170,7 @@ components: api_version: type: string nullable: true - description: The API Version used to create the call + description: The API version used to create the call. forwarded_from: type: string nullable: true @@ -1018,18 +1200,19 @@ components: maxLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ nullable: true - description: The (optional) unique identifier of the trunk resource that - was used for this call. + description: The unique identifier of the trunk resource that was used for + this call. The field is empty if the call was not made using a SIP trunk + or if the call is not terminated. uri: type: string nullable: true - description: The URI of this resource, relative to `https://api.twilio.com` + description: The URI of this resource, relative to `https://api.twilio.com`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related subresources identified by their relative - URIs + description: A list of subresources available to this call, identified by + their URIs relative to `https://api.twilio.com`. call_enum_event: type: string enum: @@ -1058,10 +1241,11 @@ components: properties: request: nullable: true - description: Call Request. + description: Contains a dictionary representing the request of the call. response: nullable: true - description: Call Response with Events. + description: Contains a dictionary representing the call response, including + a list of the call events. api.v2010.account.call.call_feedback: type: object properties: @@ -1071,35 +1255,42 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique sid that identifies this account + 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 this resource was created + 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 this resource was last updated + 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: Issues experienced during the call + 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 + 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 string that uniquely identifies this feedback resource + description: A 34 character string that uniquely identifies this resource. call_feedback_enum_issues: type: string enum: @@ -1120,68 +1311,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique sid that identifies this account + 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 + description: The total number of calls. call_feedback_count: type: integer nullable: true - description: The total number of calls with a feedback entry + description: The total number of calls with a feedback entry. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The date this resource was created + 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 this resource was last updated + 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 latest feedback entry date in the summary + 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 + description: Whether the feedback summary includes subaccounts; `true` if + it does, otherwise `false`. issues: type: array items: {} nullable: true - description: Issues experienced during the call + 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 + description: The average QualityScore of the feedback entries. quality_score_median: type: number nullable: true - description: The median QualityScore of the feedback entries + description: The median QualityScore of the feedback entries. quality_score_standard_deviation: type: number nullable: true - description: The standard deviation of the quality scores + 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 string that uniquely identifies this feedback entry + description: A 34 character string that uniquely identifies this resource. start_date: type: string format: date nullable: true - description: The earliest feedback entry date in the summary + 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 + description: The status of the feedback summary can be `queued`, `in-progress`, + `completed`, or `failed`. call_feedback_summary_enum_status: type: string enum: @@ -1198,51 +1399,58 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Call Notification resource. api_version: type: string nullable: true - description: The API version used to create the Call Notification resource + description: The API version used to create the Call Notification resource. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Call Notification resource is associated with. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. error_code: type: string nullable: true - description: A unique error code corresponding to the notification + description: A unique error code for the error condition that is described + in our [Error Dictionary](https://www.twilio.com/docs/api/errors). log: type: string nullable: true - description: An integer log level + description: 'An integer log level that corresponds to the type of notification: + `0` is ERROR, `1` is WARNING.' message_date: type: string format: date-time-rfc-2822 nullable: true - description: The date the notification was generated + description: The date the notification was actually generated in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) + format. Message buffering can cause this value to differ from `date_created`. message_text: type: string nullable: true - description: The text of the notification + description: The text of the notification. more_info: type: string format: uri nullable: true - description: A URL for more information about the error code + description: The URL for more information about the error condition. This + value is a page in our [Error Dictionary](https://www.twilio.com/docs/api/errors). request_method: type: string format: http-method @@ -1254,23 +1462,32 @@ components: - PUT - DELETE nullable: true - description: HTTP method used with the request url + description: The HTTP method used to generate the notification. If the notification + was generated during a phone call, this is the HTTP Method used to request + the resource on your server. If the notification was generated by your + use of our REST API, this is the HTTP method used to call the resource + on our servers. request_url: type: string format: uri nullable: true - description: URL of the resource that generated the notification + description: The URL of the resource that generated the notification. If + the notification was generated during a phone call, this is the URL of + the resource on your server that caused the notification. If the notification + was generated by your use of our REST API, this is the URL of the resource + you called. sid: type: string minLength: 34 maxLength: 34 pattern: ^NO[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Call + Notification resource. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. api.v2010.account.call.call_notification-instance: type: object properties: @@ -1280,51 +1497,58 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Call Notification resource. api_version: type: string nullable: true - description: The API version used to create the Call Notification resource + description: The API version used to create the Call Notification resource. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Call Notification resource is associated with. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. error_code: type: string nullable: true - description: A unique error code corresponding to the notification + description: A unique error code for the error condition that is described + in our [Error Dictionary](https://www.twilio.com/docs/api/errors). log: type: string nullable: true - description: An integer log level + description: 'An integer log level that corresponds to the type of notification: + `0` is ERROR, `1` is WARNING.' message_date: type: string format: date-time-rfc-2822 nullable: true - description: The date the notification was generated + description: The date the notification was actually generated in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) + format. Message buffering can cause this value to differ from `date_created`. message_text: type: string nullable: true - description: The text of the notification + description: The text of the notification. more_info: type: string format: uri nullable: true - description: A URL for more information about the error code + description: The URL for more information about the error condition. This + value is a page in our [Error Dictionary](https://www.twilio.com/docs/api/errors). request_method: type: string format: http-method @@ -1336,35 +1560,46 @@ components: - PUT - DELETE nullable: true - description: HTTP method used with the request url + description: The HTTP method used to generate the notification. If the notification + was generated during a phone call, this is the HTTP Method used to request + the resource on your server. If the notification was generated by your + use of our REST API, this is the HTTP method used to call the resource + on our servers. request_url: type: string format: uri nullable: true - description: URL of the resource that generated the notification + description: The URL of the resource that generated the notification. If + the notification was generated during a phone call, this is the URL of + the resource on your server that caused the notification. If the notification + was generated by your use of our REST API, this is the URL of the resource + you called. request_variables: type: string nullable: true - description: Twilio-generated HTTP variables sent to the server + description: The HTTP GET or POST variables we sent to your server. However, + if the notification was generated by our REST API, this contains the HTTP + POST or PUT variables you sent to our API. response_body: type: string nullable: true - description: The HTTP body returned by your server + description: The HTTP body returned by your server. response_headers: type: string nullable: true - description: The HTTP headers returned by your server + description: The HTTP headers returned by your server. sid: type: string minLength: 34 maxLength: 34 pattern: ^NO[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Call + Notification resource. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. api.v2010.account.call.call_recording: type: object properties: @@ -1374,18 +1609,20 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Recording resource. api_version: type: string nullable: true - description: The API version used to make the recording + description: The API version used to make the recording. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Recording resource is associated with. conference_sid: type: string minLength: 34 @@ -1393,69 +1630,84 @@ components: pattern: ^CF[0-9a-fA-F]{32}$ nullable: true description: The Conference SID that identifies the conference associated - with the recording + with the recording, if a conference recording. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. start_time: type: string format: date-time-rfc-2822 nullable: true - description: The start time of the recording, given in RFC 2822 format + description: The start time of the recording in GMT and in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) + format. duration: type: string nullable: true - description: The length of the recording in seconds + description: The length of the recording in seconds. sid: type: string minLength: 34 maxLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Recording + resource. price: type: number nullable: true - description: The one-time cost of creating the recording. + description: The one-time cost of creating the recording in the `price_unit` + currency. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. encryption_details: nullable: true - description: How to decrypt the recording. + description: How to decrypt the recording if it was encrypted using [Call + Recording Encryption](https://www.twilio.com/docs/voice/tutorials/voice-recording-encryption) + feature. price_unit: type: string format: currency nullable: true - description: The currency used in the price property. + description: 'The currency used in the `price` property. Example: `USD`.' status: type: string $ref: '#/components/schemas/call_recording_enum_status' nullable: true - description: The status of the recording + description: 'The status of the recording. Can be: `processing`, `completed` + and `absent`. For more detailed statuses on in-progress recordings, check + out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource).' channels: type: integer nullable: true - description: The number of channels in the final recording file + description: 'The number of channels in the final recording file. Can be: + `1`, or `2`. Separating a two leg call into two separate channels of the + recording file is supported in [Dial](https://www.twilio.com/docs/voice/twiml/dial#attributes-record) + and [Outbound Rest API](https://www.twilio.com/docs/voice/make-calls) + record options.' source: type: string $ref: '#/components/schemas/call_recording_enum_source' nullable: true - description: How the recording was created + description: 'How the recording was created. Can be: `DialVerb`, `Conference`, + `OutboundAPI`, `Trunking`, `RecordVerb`, `StartCallRecordingAPI`, and + `StartConferenceRecordingAPI`.' error_code: type: integer nullable: true - description: More information about why the recording is missing, if status - is `absent`. + description: The error code that describes why the recording is `absent`. + The error code is described in our [Error Dictionary](https://www.twilio.com/docs/api/errors). + This value is null if the recording `status` is not `absent`. track: type: string nullable: true @@ -1488,64 +1740,74 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created this resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created this Conference resource. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that this resource was created + description: The date and time in GMT that this 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 RFC 2822 date and time in GMT that this resource was last - updated + 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. api_version: type: string nullable: true - description: The API version used to create this conference + description: The API version used to create this conference. friendly_name: type: string nullable: true - description: A string that you assigned to describe this conference room + description: A string that you assigned to describe this conference room. region: type: string nullable: true description: A string that represents the Twilio Region where the conference - was mixed + audio was mixed. May be `us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, and + `jp1`. Basic conference audio will always be mixed in `us1`. Global Conference + audio will be mixed nearest to the majority of participants. sid: type: string minLength: 34 maxLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies this resource + description: The unique string that that we created to identify this Conference + resource. status: type: string $ref: '#/components/schemas/conference_enum_status' nullable: true - description: The status of this conference + description: 'The status of this conference. Can be: `init`, `in-progress`, + or `completed`.' uri: type: string nullable: true - description: The URI of this resource, relative to `https://api.twilio.com` + description: The URI of this resource, relative to `https://api.twilio.com`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their URIs relative + to `https://api.twilio.com`. reason_conference_ended: type: string $ref: '#/components/schemas/conference_enum_reason_conference_ended' nullable: true - description: The reason why a conference ended. + description: 'The reason why a conference ended. When a conference is in + progress, will be `null`. When conference is completed, can be: `conference-ended-via-api`, + `participant-with-end-conference-on-exit-left`, `participant-with-end-conference-on-exit-kicked`, + `last-participant-kicked`, or `last-participant-left`.' call_sid_ending_conference: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The call SID that caused the conference to end + description: The call SID that caused the conference to end. conference_enum_status: type: string enum: @@ -1573,18 +1835,20 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Conference Recording resource. api_version: type: string nullable: true - description: The API version used to create the recording + description: The API version used to create the recording. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Conference Recording resource is associated with. conference_sid: type: string minLength: 34 @@ -1592,69 +1856,83 @@ components: pattern: ^CF[0-9a-fA-F]{32}$ nullable: true description: The Conference SID that identifies the conference associated - with the recording + with the recording. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. start_time: type: string format: date-time-rfc-2822 nullable: true - description: The start time of the recording, given in RFC 2822 format + description: The start time of the recording in GMT and in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) + format. duration: type: string nullable: true - description: The length of the recording in seconds + description: The length of the recording in seconds. sid: type: string minLength: 34 maxLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Conference + Recording resource. price: type: string nullable: true - description: The one-time cost of creating the recording. + description: The one-time cost of creating the recording in the `price_unit` + currency. price_unit: type: string format: currency nullable: true - description: The currency used in the price property. + description: 'The currency used in the `price` property. Example: `USD`.' status: type: string $ref: '#/components/schemas/conference_recording_enum_status' nullable: true - description: The status of the recording + description: 'The status of the recording. Can be: `processing`, `completed` + and `absent`. For more detailed statuses on in-progress recordings, check + out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource).' channels: type: integer nullable: true - description: The number of channels in the final recording file as an integer + description: 'The number of channels in the final recording file. Can be: + `1`, or `2`. Separating a two leg call into two separate channels of the + recording file is supported in [Dial](https://www.twilio.com/docs/voice/twiml/dial#attributes-record) + and [Outbound Rest API](https://www.twilio.com/docs/voice/make-calls) + record options.' source: type: string $ref: '#/components/schemas/conference_recording_enum_source' nullable: true - description: How the recording was created + description: 'How the recording was created. Can be: `DialVerb`, `Conference`, + `OutboundAPI`, `Trunking`, `RecordVerb`, `StartCallRecordingAPI`, `StartConferenceRecordingAPI`.' error_code: type: integer nullable: true - description: More information about why the recording is missing, if status - is `absent`. + description: The error code that describes why the recording is `absent`. + The error code is described in our [Error Dictionary](https://www.twilio.com/docs/api/errors). + This value is null if the recording `status` is not `absent`. encryption_details: nullable: true - description: How to decrypt the recording. + description: How to decrypt the recording if it was encrypted using [Call + Recording Encryption](https://www.twilio.com/docs/voice/tutorials/voice-recording-encryption) + feature. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. conference_recording_enum_status: type: string enum: @@ -1683,16 +1961,18 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the ConnectApp resource. authorize_redirect_url: type: string format: uri nullable: true - description: The URL to redirect the user to after authorization + description: The URL we redirect the user to after we authenticate the user + and obtain authorization to access the Connect App. company_name: type: string nullable: true - description: The company name set for the Connect App + description: The company name set for the Connect App. deauthorize_callback_method: type: string format: http-method @@ -1704,43 +1984,46 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call deauthorize_callback_url + description: The HTTP method we use to call `deauthorize_callback_url`. deauthorize_callback_url: type: string format: uri nullable: true - description: The URL we call to de-authorize the Connect App + description: The URL we call using the `deauthorize_callback_method` to + de-authorize the Connect App. description: type: string nullable: true - description: The description of the Connect App + description: The description of the Connect App. 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. homepage_url: type: string format: uri nullable: true - description: The URL users can obtain more information + description: The public URL where users can obtain more information about + this Connect App. permissions: type: array items: type: string $ref: '#/components/schemas/connect_app_enum_permission' nullable: true - description: The set of permissions that your ConnectApp requests + description: The set of permissions that your ConnectApp requests. sid: type: string minLength: 34 maxLength: 34 pattern: ^CN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the ConnectApp + resource. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. connect_app_enum_permission: type: string enum: @@ -1755,29 +2038,35 @@ components: maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the DependentPhoneNumber + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the DependentPhoneNumber resource. friendly_name: 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. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. voice_url: type: string format: uri nullable: true - description: The URL we call when the phone number receives a call + description: The URL we call when the phone number receives a call. The + `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` + is set. voice_method: type: string format: http-method @@ -1789,7 +2078,8 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with the voice_url + description: 'The HTTP method we use to call `voice_url`. Can be: `GET` + or `POST`.' voice_fallback_method: type: string format: http-method @@ -1801,27 +2091,32 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with voice_fallback_url + description: 'The HTTP method we use to call `voice_fallback_url`. Can be: + `GET` or `POST`.' voice_fallback_url: type: string format: uri nullable: true - description: The URL we call when an error occurs in TwiML + description: The URL that we call when an error occurs retrieving or executing + the TwiML requested by `url`. voice_caller_id_lookup: type: boolean nullable: true - description: Whether to lookup the caller's name + description: 'Whether we look up the caller''s caller-ID name from the CNAM + database. Can be: `true` or `false`. Caller ID lookups can cost $0.01 + each.' date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. sms_fallback_method: type: string format: http-method @@ -1833,13 +2128,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with sms_fallback_url + description: 'The HTTP method we use to call `sms_fallback_url`. Can be: + `GET` or `POST`.' sms_fallback_url: type: string format: uri nullable: true description: The URL that we call when an error occurs while retrieving - or executing the TwiML + or executing the TwiML from `sms_url`. sms_method: type: string format: http-method @@ -1851,27 +2147,31 @@ components: - PUT - DELETE nullable: true - description: The HTTP method to use with sms_url + description: 'The HTTP method we use to call `sms_url`. Can be: `GET` or + `POST`.' sms_url: type: string format: uri nullable: true description: The URL we call when the phone number receives an incoming - SMS message + SMS message. address_requirements: type: string $ref: '#/components/schemas/dependent_phone_number_enum_address_requirement' nullable: true - description: Whether the phone number requires an Address registered with - Twilio + description: 'Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) + registered with Twilio. Can be: `none`, `any`, `local`, or `foreign`.' capabilities: nullable: true - description: Indicate if a phone can receive calls or messages + description: 'The set of Boolean properties that indicates whether a phone + number can receive calls or messages. Capabilities are `Voice`, `SMS`, + and `MMS` and each capability can be: `true` or `false`.' status_callback: type: string format: uri nullable: true - description: The URL to send status information to your application + description: The URL we call using the `status_callback_method` to send + status information to your application. status_callback_method: type: string format: http-method @@ -1883,11 +2183,12 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call status_callback + description: 'The HTTP method we use to call `status_callback`. Can be: + `GET` or `POST`.' api_version: type: string nullable: true - description: The API version used to start a new TwiML session + description: The API version used to start a new TwiML session. sms_application_sid: type: string minLength: 34 @@ -1895,7 +2196,8 @@ components: pattern: ^AP[0-9a-fA-F]{32}$ nullable: true description: The SID of the application that handles SMS messages sent to - the phone number + the phone number. If an `sms_application_sid` is present, we ignore all + `sms_*_url` values and use those of the application. voice_application_sid: type: string minLength: 34 @@ -1903,30 +2205,36 @@ components: pattern: ^AP[0-9a-fA-F]{32}$ nullable: true description: The SID of the application that handles calls to the phone - number + number. If a `voice_application_sid` is present, we ignore all of the + voice urls and use those set on the application. Setting a `voice_application_sid` + will automatically delete your `trunk_sid` and vice versa. trunk_sid: type: string minLength: 34 maxLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Trunk that handles calls to the phone number + description: The SID of the Trunk that handles calls to the phone number. + If a `trunk_sid` is present, we ignore all of the voice urls and voice + applications and use those set on the Trunk. Setting a `trunk_sid` will + automatically delete your `voice_application_sid` and vice versa. emergency_status: type: string $ref: '#/components/schemas/dependent_phone_number_enum_emergency_status' nullable: true - description: Whether the phone number is enabled for emergency calling + description: Whether the phone number is enabled for emergency calling. emergency_address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: The emergency address configuration to use for emergency calling + description: The SID of the emergency address configuration that we use + for emergency calling from the phone number. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. dependent_phone_number_enum_address_requirement: type: string enum: @@ -1948,28 +2256,30 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created this IncomingPhoneNumber resource. address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Address resource associated with the phone number + description: The SID of the Address resource associated with the phone number. address_requirements: type: string $ref: '#/components/schemas/incoming_phone_number_enum_address_requirement' nullable: true - description: Whether the phone number requires an Address registered with - Twilio. + description: 'Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) + registered with Twilio. Can be: `none`, `any`, `local`, or `foreign`.' api_version: type: string nullable: true - description: The API version used to start a new TwiML session + description: The API version used to start a new TwiML session. beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: phone-number-capabilities @@ -1983,45 +2293,53 @@ components: fax: type: boolean nullable: true - description: Indicate if a phone can receive calls or messages + 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`.' date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. 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. identity_sid: type: string minLength: 34 maxLength: 34 pattern: ^RI[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Identity resource associated with number + description: The SID of the Identity resource that we associate with the + phone number. Some regions require an Identity to meet local regulations. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. origin: type: string nullable: true - description: The phone number's origin. Can be twilio or hosted. + description: The phone number's origin. `twilio` identifies Twilio-owned + phone numbers and `hosted` identifies hosted phone numbers. sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify this IncomingPhoneNumber + resource. sms_application_sid: type: string minLength: 34 @@ -2029,7 +2347,8 @@ components: pattern: ^AP[0-9a-fA-F]{32}$ nullable: true description: The SID of the application that handles SMS messages sent to - the phone number + the phone number. If an `sms_application_sid` is present, we ignore all + `sms_*_url` values and use those of the application. sms_fallback_method: type: string format: http-method @@ -2041,13 +2360,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with sms_fallback_url + description: 'The HTTP method we use to call `sms_fallback_url`. Can be: + `GET` or `POST`.' sms_fallback_url: type: string format: uri nullable: true description: The URL that we call when an error occurs while retrieving - or executing the TwiML + or executing the TwiML from `sms_url`. sms_method: type: string format: http-method @@ -2059,18 +2379,20 @@ components: - PUT - DELETE nullable: true - description: The HTTP method to use with sms_url + description: 'The HTTP method we use to call `sms_url`. Can be: `GET` or + `POST`.' sms_url: type: string format: uri nullable: true description: The URL we call when the phone number receives an incoming - SMS message + SMS message. status_callback: type: string format: uri nullable: true - description: The URL to send status information to your application + description: The URL we call using the `status_callback_method` to send + status information to your application. status_callback_method: type: string format: http-method @@ -2082,18 +2404,22 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call status_callback + description: 'The HTTP method we use to call `status_callback`. Can be: + `GET` or `POST`.' trunk_sid: type: string minLength: 34 maxLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Trunk that handles calls to the phone number + description: The SID of the Trunk that handles calls to the phone number. + If a `trunk_sid` is present, we ignore all of the voice urls and voice + applications and use those set on the Trunk. Setting a `trunk_sid` will + automatically delete your `voice_application_sid` and vice versa. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. voice_receive_mode: type: string $ref: '#/components/schemas/incoming_phone_number_enum_voice_receive_mode' @@ -2105,11 +2431,14 @@ components: pattern: ^AP[0-9a-fA-F]{32}$ nullable: true description: The SID of the application that handles calls to the phone - number + number. If a `voice_application_sid` is present, we ignore all of the + voice urls and use those set on the application. Setting a `voice_application_sid` + will automatically delete your `trunk_sid` and vice versa. voice_caller_id_lookup: type: boolean nullable: true - description: Whether to lookup the caller's name + description: 'Whether we look up the caller''s caller-ID name from the CNAM + database ($0.01 per look up). Can be: `true` or `false`.' voice_fallback_method: type: string format: http-method @@ -2121,12 +2450,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with voice_fallback_url + description: 'The HTTP method we use to call `voice_fallback_url`. Can be: + `GET` or `POST`.' voice_fallback_url: type: string format: uri nullable: true - description: The URL we call when an error occurs in TwiML + description: The URL that we call when an error occurs retrieving or executing + the TwiML requested by `url`. voice_method: type: string format: http-method @@ -2138,37 +2469,45 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with the voice_url + description: 'The HTTP method we use to call `voice_url`. Can be: `GET` + or `POST`.' voice_url: type: string format: uri nullable: true - description: The URL we call when the phone number receives a call + description: The URL we call when the phone number receives a call. The + `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` + is set. emergency_status: type: string $ref: '#/components/schemas/incoming_phone_number_enum_emergency_status' nullable: true - description: Displays if emergency calling is enabled for this number. + description: The parameter displays if emergency calling is enabled for + this number. Active numbers may place emergency calls by dialing valid + emergency numbers for the country. emergency_address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: The emergency address configuration to use for emergency calling + description: The SID of the emergency address configuration that we use + for emergency calling from this phone number. emergency_address_status: type: string $ref: '#/components/schemas/incoming_phone_number_enum_emergency_address_status' nullable: true - description: State of the emergency address configuration for the phone - number + description: The status of address registration with emergency services. + A registered emergency address will be used during handling of emergency + calls from this number. bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Bundle resource associated with number + description: The SID of the Bundle resource that you associate with the + phone number. Some regions require a Bundle to meet local Regulations. status: type: string nullable: true @@ -2207,57 +2546,61 @@ components: maxLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the resource. resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Phone Number that installed this Add-on + description: The SID of the Phone Number to which the Add-on is assigned. 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. description: type: string nullable: true - description: A short description of the Add-on functionality + description: A short description of the functionality that the Add-on provides. configuration: nullable: true - description: A JSON string that represents the current configuration + description: A JSON string that represents the current configuration of + this Add-on installation. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their relative URIs. ? api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension : type: object properties: @@ -2267,50 +2610,52 @@ components: maxLength: 34 pattern: ^XF[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the resource. resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Phone Number to which the Add-on is assigned + description: The SID of the Phone Number to which the Add-on is assigned. assigned_add_on_sid: type: string minLength: 34 maxLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ nullable: true - description: The SID that uniquely identifies the assigned Add-on installation + description: The SID that uniquely identifies the assigned Add-on installation. 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 nullable: true description: A string that you assigned to describe the Product this Extension - is used within + is used within. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. enabled: type: boolean nullable: true - description: Whether the Extension will be invoked + description: Whether the Extension will be invoked. api.v2010.account.incoming_phone_number.incoming_phone_number_local: type: object properties: @@ -2320,28 +2665,30 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the resource. address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Address resource associated with the phone number + description: The SID of the Address resource associated with the phone number. address_requirements: type: string $ref: '#/components/schemas/incoming_phone_number_local_enum_address_requirement' nullable: true - description: Whether the phone number requires an Address registered with - Twilio. + description: 'Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) + registered with Twilio. Can be: `none`, `any`, `local`, or `foreign`.' api_version: type: string nullable: true - description: The API version used to start a new TwiML session + description: The API version used to start a new TwiML session. beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: phone-number-capabilities @@ -2355,52 +2702,61 @@ components: fax: type: boolean nullable: true - description: Indicate if a phone can receive calls or messages + 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`.' date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. 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. identity_sid: type: string minLength: 34 maxLength: 34 pattern: ^RI[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Identity resource associated with number + description: The SID of the Identity resource that we associate with the + phone number. Some regions require an Identity to meet local regulations. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. origin: type: string nullable: true - description: The phone number's origin. Can be twilio or hosted. + description: The phone number's origin. `twilio` identifies Twilio-owned + phone numbers and `hosted` identifies hosted phone numbers. sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the resource. sms_application_sid: type: string minLength: 34 maxLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Application resource to handle SMS messages + description: The SID of the application that handles SMS messages sent to + the phone number. If an `sms_application_sid` is present, we ignore all + `sms_*_url` values and use those of the application. sms_fallback_method: type: string format: http-method @@ -2412,13 +2768,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with sms_fallback_url + description: 'The HTTP method we use to call `sms_fallback_url`. Can be: + `GET` or `POST`.' sms_fallback_url: type: string format: uri nullable: true description: The URL that we call when an error occurs while retrieving - or executing the TwiML + or executing the TwiML from `sms_url`. sms_method: type: string format: http-method @@ -2430,18 +2787,20 @@ components: - PUT - DELETE nullable: true - description: The HTTP method to use with sms_url + description: 'The HTTP method we use to call `sms_url`. Can be: `GET` or + `POST`.' sms_url: type: string format: uri nullable: true description: The URL we call when the phone number receives an incoming - SMS message + SMS message. status_callback: type: string format: uri nullable: true - description: The URL to send status information to your application + description: The URL we call using the `status_callback_method` to send + status information to your application. status_callback_method: type: string format: http-method @@ -2453,18 +2812,22 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call status_callback + description: 'The HTTP method we use to call `status_callback`. Can be: + `GET` or `POST`.' trunk_sid: type: string minLength: 34 maxLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Trunk that handles calls to the phone number + description: The SID of the Trunk that handles calls to the phone number. + If a `trunk_sid` is present, we ignore all of the voice urls and voice + applications and use those set on the Trunk. Setting a `trunk_sid` will + automatically delete your `voice_application_sid` and vice versa. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. voice_receive_mode: type: string $ref: '#/components/schemas/incoming_phone_number_local_enum_voice_receive_mode' @@ -2476,11 +2839,14 @@ components: pattern: ^AP[0-9a-fA-F]{32}$ nullable: true description: The SID of the application that handles calls to the phone - number + number. If a `voice_application_sid` is present, we ignore all of the + voice urls and use those set on the application. Setting a `voice_application_sid` + will automatically delete your `trunk_sid` and vice versa. voice_caller_id_lookup: type: boolean nullable: true - description: Whether to lookup the caller's name + description: 'Whether we look up the caller''s caller-ID name from the CNAM + database ($0.01 per look up). Can be: `true` or `false`.' voice_fallback_method: type: string format: http-method @@ -2492,12 +2858,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with voice_fallback_url + description: 'The HTTP method we use to call `voice_fallback_url`. Can be: + `GET` or `POST`.' voice_fallback_url: type: string format: uri nullable: true - description: The URL we call when an error occurs in TwiML + description: The URL that we call when an error occurs retrieving or executing + the TwiML requested by `url`. voice_method: type: string format: http-method @@ -2509,37 +2877,45 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with the voice_url + description: 'The HTTP method we use to call `voice_url`. Can be: `GET` + or `POST`.' voice_url: type: string format: uri nullable: true - description: The URL we call when this phone number receives a call + description: The URL we call when this phone number receives a call. The + `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` + is set. emergency_status: type: string $ref: '#/components/schemas/incoming_phone_number_local_enum_emergency_status' nullable: true - description: Displays if emergency calling is enabled for this number. + description: The parameter displays if emergency calling is enabled for + this number. Active numbers may place emergency calls by dialing valid + emergency numbers for the country. emergency_address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: The emergency address configuration to use for emergency calling + description: The SID of the emergency address configuration that we use + for emergency calling from this phone number. emergency_address_status: type: string $ref: '#/components/schemas/incoming_phone_number_local_enum_emergency_address_status' nullable: true - description: State of the emergency address configuration for the phone - number + description: The status of address registration with emergency services. + A registered emergency address will be used during handling of emergency + calls from this number. bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Bundle resource associated with number + description: The SID of the Bundle resource that you associate with the + phone number. Some regions require a Bundle to meet local Regulations. status: type: string nullable: true @@ -2578,28 +2954,30 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the resource. address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Address resource associated with the phone number + description: The SID of the Address resource associated with the phone number. address_requirements: type: string $ref: '#/components/schemas/incoming_phone_number_mobile_enum_address_requirement' nullable: true - description: Whether the phone number requires an Address registered with - Twilio. + description: 'Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) + registered with Twilio. Can be: `none`, `any`, `local`, or `foreign`.' api_version: type: string nullable: true - description: The API version used to start a new TwiML session + description: The API version used to start a new TwiML session. beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: phone-number-capabilities @@ -2613,45 +2991,52 @@ components: fax: type: boolean nullable: true - description: Indicate if a phone can receive calls or messages + 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`.' date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. 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. identity_sid: type: string minLength: 34 maxLength: 34 pattern: ^RI[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Identity resource associated with number + description: The SID of the Identity resource that we associate with the + phone number. Some regions require an Identity to meet local regulations. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. origin: type: string nullable: true - description: The phone number's origin. Can be twilio or hosted. + description: The phone number's origin. `twilio` identifies Twilio-owned + phone numbers and `hosted` identifies hosted phone numbers. sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the resource. sms_application_sid: type: string minLength: 34 @@ -2659,7 +3044,8 @@ components: pattern: ^AP[0-9a-fA-F]{32}$ nullable: true description: The SID of the application that handles SMS messages sent to - the phone number + the phone number. If an `sms_application_sid` is present, we ignore all + `sms_*_url` values and use those of the application. sms_fallback_method: type: string format: http-method @@ -2671,13 +3057,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with sms_fallback_url + description: 'The HTTP method we use to call `sms_fallback_url`. Can be: + `GET` or `POST`.' sms_fallback_url: type: string format: uri nullable: true description: The URL that we call when an error occurs while retrieving - or executing the TwiML + or executing the TwiML from `sms_url`. sms_method: type: string format: http-method @@ -2689,18 +3076,20 @@ components: - PUT - DELETE nullable: true - description: The HTTP method to use with sms_url + description: 'The HTTP method we use to call `sms_url`. Can be: `GET` or + `POST`.' sms_url: type: string format: uri nullable: true description: The URL we call when the phone number receives an incoming - SMS message + SMS message. status_callback: type: string format: uri nullable: true - description: The URL to send status information to your application + description: The URL we call using the `status_callback_method` to send + status information to your application. status_callback_method: type: string format: http-method @@ -2712,18 +3101,22 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call status_callback + description: 'The HTTP method we use to call `status_callback`. Can be: + `GET` or `POST`.' trunk_sid: type: string minLength: 34 maxLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Trunk that handles calls to the phone number + description: The SID of the Trunk that handles calls to the phone number. + If a `trunk_sid` is present, we ignore all of the voice urls and voice + applications and use those set on the Trunk. Setting a `trunk_sid` will + automatically delete your `voice_application_sid` and vice versa. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. voice_receive_mode: type: string $ref: '#/components/schemas/incoming_phone_number_mobile_enum_voice_receive_mode' @@ -2735,11 +3128,14 @@ components: pattern: ^AP[0-9a-fA-F]{32}$ nullable: true description: The SID of the application that handles calls to the phone - number + number. If a `voice_application_sid` is present, we ignore all of the + voice urls and use those set on the application. Setting a `voice_application_sid` + will automatically delete your `trunk_sid` and vice versa. voice_caller_id_lookup: type: boolean nullable: true - description: Whether to lookup the caller's name + description: 'Whether we look up the caller''s caller-ID name from the CNAM + database ($0.01 per look up). Can be: `true` or `false`.' voice_fallback_method: type: string format: http-method @@ -2751,12 +3147,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with voice_fallback_url + description: 'The HTTP method we use to call `voice_fallback_url`. Can be: + `GET` or `POST`.' voice_fallback_url: type: string format: uri nullable: true - description: The URL we call when an error occurs in TwiML + description: The URL that we call when an error occurs retrieving or executing + the TwiML requested by `url`. voice_method: type: string format: http-method @@ -2768,37 +3166,45 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with the voice_url + description: 'The HTTP method we use to call `voice_url`. Can be: `GET` + or `POST`.' voice_url: type: string format: uri nullable: true - description: The URL we call when the phone number receives a call + description: The URL we call when the phone number receives a call. The + `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` + is set. emergency_status: type: string $ref: '#/components/schemas/incoming_phone_number_mobile_enum_emergency_status' nullable: true - description: Displays if emergency calling is enabled for this number. + description: The parameter displays if emergency calling is enabled for + this number. Active numbers may place emergency calls by dialing valid + emergency numbers for the country. emergency_address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: The emergency address configuration to use for emergency calling + description: The SID of the emergency address configuration that we use + for emergency calling from this phone number. emergency_address_status: type: string $ref: '#/components/schemas/incoming_phone_number_mobile_enum_emergency_address_status' nullable: true - description: State of the emergency address configuration for the phone - number + description: The status of address registration with emergency services. + A registered emergency address will be used during handling of emergency + calls from this number. bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Bundle resource associated with number + description: The SID of the Bundle resource that you associate with the + phone number. Some regions require a Bundle to meet local Regulations. status: type: string nullable: true @@ -2837,28 +3243,30 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the resource. address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Address resource associated with the phone number + description: The SID of the Address resource associated with the phone number. address_requirements: type: string $ref: '#/components/schemas/incoming_phone_number_toll_free_enum_address_requirement' nullable: true - description: Whether the phone number requires an Address registered with - Twilio. + description: 'Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) + registered with Twilio. Can be: `none`, `any`, `local`, or `foreign`.' api_version: type: string nullable: true - description: The API version used to start a new TwiML session + description: The API version used to start a new TwiML session. beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: phone-number-capabilities @@ -2872,45 +3280,52 @@ components: fax: type: boolean nullable: true - description: Indicate if a phone can receive calls or messages + 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`.' date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. 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. identity_sid: type: string minLength: 34 maxLength: 34 pattern: ^RI[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Identity resource associated with number + description: The SID of the Identity resource that we associate with the + phone number. Some regions require an Identity to meet local regulations. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. origin: type: string nullable: true - description: The phone number's origin. Can be twilio or hosted. + description: The phone number's origin. `twilio` identifies Twilio-owned + phone numbers and `hosted` identifies hosted phone numbers. sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the resource. sms_application_sid: type: string minLength: 34 @@ -2918,7 +3333,8 @@ components: pattern: ^AP[0-9a-fA-F]{32}$ nullable: true description: The SID of the application that handles SMS messages sent to - the phone number + the phone number. If an `sms_application_sid` is present, we ignore all + `sms_*_url` values and use those of the application. sms_fallback_method: type: string format: http-method @@ -2930,13 +3346,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with sms_fallback_url + description: 'The HTTP method we use to call `sms_fallback_url`. Can be: + `GET` or `POST`.' sms_fallback_url: type: string format: uri nullable: true description: The URL that we call when an error occurs while retrieving - or executing the TwiML + or executing the TwiML from `sms_url`. sms_method: type: string format: http-method @@ -2948,18 +3365,20 @@ components: - PUT - DELETE nullable: true - description: The HTTP method to use with sms_url + description: 'The HTTP method we use to call `sms_url`. Can be: `GET` or + `POST`.' sms_url: type: string format: uri nullable: true description: The URL we call when the phone number receives an incoming - SMS message + SMS message. status_callback: type: string format: uri nullable: true - description: The URL to send status information to your application + description: The URL we call using the `status_callback_method` to send + status information to your application. status_callback_method: type: string format: http-method @@ -2971,18 +3390,22 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call status_callback + description: 'The HTTP method we use to call `status_callback`. Can be: + `GET` or `POST`.' trunk_sid: type: string minLength: 34 maxLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Trunk that handles calls to the phone number + description: The SID of the Trunk that handles calls to the phone number. + If a `trunk_sid` is present, we ignore all of the voice urls and voice + applications and use those set on the Trunk. Setting a `trunk_sid` will + automatically delete your `voice_application_sid` and vice versa. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. voice_receive_mode: type: string $ref: '#/components/schemas/incoming_phone_number_toll_free_enum_voice_receive_mode' @@ -2994,11 +3417,14 @@ components: pattern: ^AP[0-9a-fA-F]{32}$ nullable: true description: The SID of the application that handles calls to the phone - number + number. If a `voice_application_sid` is present, we ignore all of the + voice urls and use those set on the application. Setting a `voice_application_sid` + will automatically delete your `trunk_sid` and vice versa. voice_caller_id_lookup: type: boolean nullable: true - description: Whether to lookup the caller's name + description: 'Whether we look up the caller''s caller-ID name from the CNAM + database ($0.01 per look up). Can be: `true` or `false`.' voice_fallback_method: type: string format: http-method @@ -3010,12 +3436,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with voice_fallback_url + description: 'The HTTP method we use to call `voice_fallback_url`. Can be: + `GET` or `POST`.' voice_fallback_url: type: string format: uri nullable: true - description: The URL we call when an error occurs in TwiML + description: The URL that we call when an error occurs retrieving or executing + the TwiML requested by `url`. voice_method: type: string format: http-method @@ -3027,37 +3455,45 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with the voice_url + description: 'The HTTP method we use to call `voice_url`. Can be: `GET` + or `POST`.' voice_url: type: string format: uri nullable: true - description: The URL we call when the phone number receives a call + description: The URL we call when the phone number receives a call. The + `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` + is set. emergency_status: type: string $ref: '#/components/schemas/incoming_phone_number_toll_free_enum_emergency_status' nullable: true - description: Displays if emergency calling is enabled for this number. + description: The parameter displays if emergency calling is enabled for + this number. Active numbers may place emergency calls by dialing valid + emergency numbers for the country. emergency_address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: The emergency address configuration to use for emergency calling + description: The SID of the emergency address configuration that we use + for emergency calling from this phone number. emergency_address_status: type: string $ref: '#/components/schemas/incoming_phone_number_toll_free_enum_emergency_address_status' nullable: true - description: State of the emergency address configuration for the phone - number + description: The status of address registration with emergency services. + A registered emergency address will be used during handling of emergency + calls from this number. bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Bundle resource associated with number + description: The SID of the Bundle resource that you associate with the + phone number. Some regions require a Bundle to meet local Regulations. status: type: string nullable: true @@ -3096,22 +3532,24 @@ components: maxLength: 34 pattern: ^SK[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Key + resource. 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. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. api.v2010.account.message.media: type: object properties: @@ -3121,40 +3559,44 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created this resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created this Media resource. content_type: type: string nullable: true - description: The default mime-type of the media + 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 RFC 2822 date and time in GMT that this resource was created + description: The date and time in GMT that this 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 RFC 2822 date and time in GMT that this resource was last - updated + 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. 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 resource that created the media. sid: type: string minLength: 34 maxLength: 34 pattern: ^ME[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies this resource + description: The unique string that that we created to identify 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 resource, relative to `https://api.twilio.com`. api.v2010.account.queue.member: type: object properties: @@ -3164,12 +3606,13 @@ components: maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Member resource is associated with. date_enqueued: type: string format: date-time-rfc-2822 nullable: true - description: The date the member was enqueued + description: The date that the member was enqueued, given in RFC 2822 format. position: type: integer nullable: true @@ -3177,7 +3620,7 @@ components: uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. wait_time: type: integer nullable: true @@ -3188,108 +3631,145 @@ components: maxLength: 34 pattern: ^QU[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Queue the member is in + description: The SID of the Queue the member is in. api.v2010.account.message: type: object properties: body: type: string nullable: true - description: The message text + description: The message text. Can be up to 1,600 characters long. num_segments: type: string nullable: true - description: The number of messages used to deliver the message body + 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.' direction: type: string $ref: '#/components/schemas/message_enum_direction' nullable: true - description: The direction of the message + 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.' from: type: string format: phone-number nullable: true - description: The phone number that initiated the message + 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. to: type: string nullable: true - description: The phone number that received the message + 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. date_updated: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was last - updated + 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. price: type: string nullable: true - description: The amount billed for the message + 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. error_message: type: string nullable: true - description: The description of the error_code + description: The description of the `error_code` if your message `status` + is `failed` or `undelivered`. If the message was successful, this 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 resource, relative to `https://api.twilio.com`. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that sent the message that created the resource. num_media: type: string nullable: true - description: The number of media files associated with the message + description: The number of media files associated with the message. A message + can send up to 10 media files. status: type: string $ref: '#/components/schemas/message_enum_status' nullable: true - description: The status of the message + 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).' messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Messaging Service used with the message. + 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. 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 + description: The unique string that that we created to identify the Message + resource. date_sent: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT when the message was sent + 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. ' date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + description: The date and time in GMT that the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. error_code: type: integer nullable: true - description: The error code associated with the message + 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. price_unit: type: string format: currency nullable: true - description: The currency in which price is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format (e.g. `usd`, `eur`, `jpy`). 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 relative URIs + description: A list of related resources identified by their URIs relative + to `https://api.twilio.com` message_enum_status: type: string enum: @@ -3342,7 +3822,8 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the MessageFeedback resource. message_sid: type: string minLength: 34 @@ -3350,27 +3831,31 @@ components: pattern: ^(SM|MM)[0-9a-fA-F]{32}$ nullable: true description: The SID of the Message resource for which the feedback was - provided + provided. outcome: type: string $ref: '#/components/schemas/message_feedback_enum_outcome' nullable: true - description: Whether the feedback has arrived + 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`.' date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. message_feedback_enum_outcome: type: string enum: @@ -3385,27 +3870,32 @@ components: maxLength: 34 pattern: ^SK[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the NewKey + resource. You will use this as the basic-auth `user` when authenticating + to the API. 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. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + description: The date and time in GMT that the API Key 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 RFC 2822 date and time in GMT that the resource was last - updated + description: The date and time in GMT that the new API Key was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. secret: type: string nullable: true description: The secret your application uses to sign Access Tokens and - to authenticate to the REST API. + 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.** api.v2010.account.new_signing_key: type: object properties: @@ -3415,27 +3905,31 @@ components: maxLength: 34 pattern: ^SK[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the NewSigningKey + resource. 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. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. secret: type: string nullable: true description: The secret your application uses to sign Access Tokens and - to authenticate to the REST API. + 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.** api.v2010.account.notification: type: object properties: @@ -3445,51 +3939,60 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Notification resource. api_version: type: string nullable: true - description: The API version used to generate the notification + description: The API version used to generate the notification. Can be empty + for events that don't have a specific API version, such as incoming phone + calls. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Notification resource is associated with. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. error_code: type: string nullable: true - description: A unique error code corresponding to the notification + description: A unique error code for the error condition that is described + in our [Error Dictionary](https://www.twilio.com/docs/api/errors). log: type: string nullable: true - description: An integer log level + description: 'An integer log level that corresponds to the type of notification: + `0` is ERROR, `1` is WARNING.' message_date: type: string format: date-time-rfc-2822 nullable: true - description: The date the notification was generated + description: The date the notification was actually generated in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) + format. Message buffering can cause this value to differ from `date_created`. message_text: type: string nullable: true - description: The text of the notification + description: The text of the notification. more_info: type: string format: uri nullable: true - description: A URL for more information about the error code + description: The URL for more information about the error condition. This + value is a page in our [Error Dictionary](https://www.twilio.com/docs/api/errors). request_method: type: string format: http-method @@ -3501,23 +4004,32 @@ components: - PUT - DELETE nullable: true - description: HTTP method used with the request url + description: The HTTP method used to generate the notification. If the notification + was generated during a phone call, this is the HTTP Method used to request + the resource on your server. If the notification was generated by your + use of our REST API, this is the HTTP method used to call the resource + on our servers. request_url: type: string format: uri nullable: true - description: URL of the resource that generated the notification + description: The URL of the resource that generated the notification. If + the notification was generated during a phone call, this is the URL of + the resource on your server that caused the notification. If the notification + was generated by your use of our REST API, this is the URL of the resource + you called. sid: type: string minLength: 34 maxLength: 34 pattern: ^NO[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Notification + resource. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. api.v2010.account.notification-instance: type: object properties: @@ -3527,51 +4039,60 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Notification resource. api_version: type: string nullable: true - description: The API version used to generate the notification + description: The API version used to generate the notification. Can be empty + for events that don't have a specific API version, such as incoming phone + calls. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Notification resource is associated with. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. error_code: type: string nullable: true - description: A unique error code corresponding to the notification + description: A unique error code for the error condition that is described + in our [Error Dictionary](https://www.twilio.com/docs/api/errors). log: type: string nullable: true - description: An integer log level + description: 'An integer log level that corresponds to the type of notification: + `0` is ERROR, `1` is WARNING.' message_date: type: string format: date-time-rfc-2822 nullable: true - description: The date the notification was generated + description: The date the notification was actually generated in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) + format. Message buffering can cause this value to differ from `date_created`. message_text: type: string nullable: true - description: The text of the notification + description: The text of the notification. more_info: type: string format: uri nullable: true - description: A URL for more information about the error code + description: The URL for more information about the error condition. This + value is a page in our [Error Dictionary](https://www.twilio.com/docs/api/errors). request_method: type: string format: http-method @@ -3583,35 +4104,46 @@ components: - PUT - DELETE nullable: true - description: HTTP method used with the request url + description: The HTTP method used to generate the notification. If the notification + was generated during a phone call, this is the HTTP Method used to request + the resource on your server. If the notification was generated by your + use of our REST API, this is the HTTP method used to call the resource + on our servers. request_url: type: string format: uri nullable: true - description: URL of the resource that generated the notification + description: The URL of the resource that generated the notification. If + the notification was generated during a phone call, this is the URL of + the resource on your server that caused the notification. If the notification + was generated by your use of our REST API, this is the URL of the resource + you called. request_variables: type: string nullable: true - description: Twilio-generated HTTP variables sent to the server + description: The HTTP GET or POST variables we sent to your server. However, + if the notification was generated by our REST API, this contains the HTTP + POST or PUT variables you sent to our API. response_body: type: string nullable: true - description: The HTTP body returned by your server + description: The HTTP body returned by your server. response_headers: type: string nullable: true - description: The HTTP headers returned by your server + description: The HTTP headers returned by your server. sid: type: string minLength: 34 maxLength: 34 pattern: ^NO[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Notification + resource. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. api.v2010.account.outgoing_caller_id: type: object properties: @@ -3621,38 +4153,43 @@ components: maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the OutgoingCallerId + resource. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. 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. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the OutgoingCallerId resource. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. api.v2010.account.conference.participant: type: object properties: @@ -3662,73 +4199,88 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Participant resource. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Participant resource is associated with. label: type: string nullable: true - description: The label of this participant + description: The user-specified label of this participant, if one was given + when the participant was created. This may be used to fetch, update or + delete the participant. call_sid_to_coach: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the participant who is being `coached` + 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`. coaching: type: boolean nullable: true - description: Indicates if the participant changed to coach + description: 'Whether the participant is coaching another call. Can be: + `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` + is defined. If `true`, `call_sid_to_coach` must be defined.' conference_sid: type: string minLength: 34 maxLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ nullable: true - description: The SID of the conference the participant is in + description: The SID of the conference the participant is in. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. end_conference_on_exit: type: boolean nullable: true - description: Whether the conference ends when the participant leaves + description: 'Whether the conference ends when the participant leaves. Can + be: `true` or `false` and the default is `false`. If `true`, the conference + ends and all other participants drop out when the participant leaves.' muted: type: boolean nullable: true - description: Whether the participant is muted + description: Whether the participant is muted. Can be `true` or `false`. hold: type: boolean nullable: true - description: Whether the participant is on hold + description: Whether the participant is on hold. Can be `true` or `false`. start_conference_on_enter: type: boolean nullable: true - description: Whether the conference starts when the participant joins the - conference + description: 'Whether the conference starts when the participant joins the + conference, if it has not already started. Can be: `true` or `false` and + the default is `true`. If `false` and the conference has not started, + the participant is muted and hears background music until another participant + starts the conference.' status: type: string $ref: '#/components/schemas/participant_enum_status' nullable: true - description: The status of the participant's call in a session + description: 'The status of the participant''s call in a session. Can be: + `queued`, `connecting`, `ringing`, `connected`, `complete`, or `failed`.' uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. participant_enum_status: type: string enum: @@ -3747,14 +4299,17 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Payments resource. + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Payments resource. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with. + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Payments resource is associated with. This will refer to the call + sid that is producing the payment card (credit/ACH) information thru DTMF. sid: type: string minLength: 34 @@ -3766,17 +4321,18 @@ components: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. payments_enum_payment_method: type: string enum: @@ -3814,8 +4370,8 @@ components: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that this resource was last - updated + 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. current_size: type: integer nullable: true @@ -3823,38 +4379,43 @@ components: friendly_name: type: string nullable: true - description: A string that you assigned to describe this resource + description: A string that you assigned to describe this resource. uri: type: string nullable: true - description: The URI of this resource, relative to `https://api.twilio.com` + description: The URI of this resource, relative to `https://api.twilio.com`. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created this resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created this Queue resource. average_wait_time: type: integer nullable: true - description: Average wait time of members in the queue + description: ' The average wait time in seconds of the members in this queue. + This is calculated at the time of the request.' sid: type: string minLength: 34 maxLength: 34 pattern: ^QU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies this resource + description: The unique string that that we created to identify this Queue + resource. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that this resource was created + description: The date and time in GMT that this resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. max_size: type: integer nullable: true - description: The max number of calls allowed in the queue + description: ' The maximum number of calls that can be in the queue. The + default is 100 and the maximum is 5000.' api.v2010.account.recording: type: object properties: @@ -3864,7 +4425,8 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Recording resource. api_version: type: string nullable: true @@ -3875,30 +4437,35 @@ components: maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Recording resource is associated with. This will always refer to the + parent leg of a two-leg call. conference_sid: type: string minLength: 34 maxLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ nullable: true - description: The unique ID for the conference associated with the recording. + description: The Conference SID that identifies the conference associated + with the recording, if a conference recording. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. start_time: type: string format: date-time-rfc-2822 nullable: true - description: The start time of the recording, given in RFC 2822 format + description: The start time of the recording in GMT and in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) + format. duration: type: string nullable: true @@ -3909,51 +4476,64 @@ components: maxLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Recording + resource. price: type: string nullable: true - description: The one-time cost of creating the recording. + description: The one-time cost of creating the recording in the `price_unit` + currency. price_unit: type: string nullable: true - description: The currency used in the price property. + description: 'The currency used in the `price` property. Example: `USD`.' status: type: string $ref: '#/components/schemas/recording_enum_status' nullable: true - description: The status of the recording. + description: 'The status of the recording. Can be: `processing`, `completed`, + `absent` or `deleted`. For information about more detailed statuses on + in-progress recordings, check out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource).' channels: type: integer nullable: true - description: The number of channels in the final recording file as an integer. + description: 'The number of channels in the final recording file. Can be: + `1` or `2`. You can split a call with two legs into two separate recording + channels if you record using [TwiML Dial](https://www.twilio.com/docs/voice/twiml/dial#record) + or the [Outbound Rest API](https://www.twilio.com/docs/voice/make-calls#manage-your-outbound-call).' source: type: string $ref: '#/components/schemas/recording_enum_source' nullable: true - description: How the recording was created + description: 'How the recording was created. Can be: `DialVerb`, `Conference`, + `OutboundAPI`, `Trunking`, `RecordVerb`, `StartCallRecordingAPI`, and + `StartConferenceRecordingAPI`.' error_code: type: integer nullable: true - description: More information about why the recording is missing, if status - is `absent`. + description: The error code that describes why the recording is `absent`. + The error code is described in our [Error Dictionary](https://www.twilio.com/docs/api/errors). + This value is null if the recording `status` is not `absent`. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. encryption_details: nullable: true - description: How to decrypt the recording. + description: How to decrypt the recording if it was encrypted using [Call + Recording Encryption](https://www.twilio.com/docs/voice/tutorials/voice-recording-encryption) + feature. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their relative URIs. media_url: type: string format: uri nullable: true - description: The URL of the media file. + 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. recording_enum_status: type: string enum: @@ -3983,49 +4563,54 @@ components: maxLength: 34 pattern: ^XR[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Recording + AddOnResult resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Recording AddOnResult resource. status: type: string $ref: '#/components/schemas/recording_add_on_result_enum_status' nullable: true - description: The status of the result + description: 'The status of the result. Can be: `canceled`, `completed`, + `deleted`, `failed`, `in-progress`, `init`, `processing`, `queued`.' add_on_sid: type: string minLength: 34 maxLength: 34 pattern: ^XB[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Add-on to which the result belongs + description: The SID of the Add-on to which the result belongs. add_on_configuration_sid: type: string minLength: 34 maxLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Add-on configuration + description: The SID of the Add-on configuration. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. date_completed: type: string format: date-time-rfc-2822 nullable: true - description: The date and time in GMT that the result was completed + description: The date and time in GMT that the result was completed specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. reference_sid: type: string minLength: 34 @@ -4033,12 +4618,12 @@ components: pattern: ^RE[0-9a-fA-F]{32}$ nullable: true description: The SID of the recording to which the AddOnResult resource - belongs + belongs. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their relative URIs. recording_add_on_result_enum_status: type: string enum: @@ -4059,54 +4644,57 @@ components: maxLength: 34 pattern: ^XH[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Recording + AddOnResult Payload resource. add_on_result_sid: type: string minLength: 34 maxLength: 34 pattern: ^XR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the AddOnResult to which the payload belongs + description: The SID of the AddOnResult to which the payload belongs. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Recording AddOnResult Payload resource. label: type: string nullable: true - description: The string that describes the payload + description: The string provided by the vendor that describes the payload. add_on_sid: type: string minLength: 34 maxLength: 34 pattern: ^XB[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Add-on to which the result belongs + description: The SID of the Add-on to which the result belongs. add_on_configuration_sid: type: string minLength: 34 maxLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Add-on configuration + description: The SID of the Add-on configuration. content_type: type: string nullable: true - description: The MIME type of the payload + description: The MIME type of the payload. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. reference_sid: type: string minLength: 34 @@ -4114,12 +4702,12 @@ components: pattern: ^RE[0-9a-fA-F]{32}$ nullable: true description: The SID of the recording to which the AddOnResult resource - that contains the payload belongs + that contains the payload belongs. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their relative URIs. api.v2010.account.recording.recording_transcription: type: object properties: @@ -4129,22 +4717,24 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Transcription resource. api_version: type: string nullable: true - description: The API version used to create the transcription + description: The API version used to create the transcription. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. duration: type: string nullable: true @@ -4152,31 +4742,37 @@ components: price: type: number nullable: true - description: The charge for the transcription + description: The charge for the transcript in the currency associated with + the account. This value is populated after the transcript is complete + so it may not be available immediately. price_unit: type: string format: currency nullable: true - description: The currency in which price is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format (e.g. `usd`, `eur`, `jpy`). recording_sid: type: string minLength: 34 maxLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ nullable: true - description: The SID that identifies the transcription's recording + description: The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) + from which the transcription was created. sid: type: string minLength: 34 maxLength: 34 pattern: ^TR[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Transcription + resource. status: type: string $ref: '#/components/schemas/recording_transcription_enum_status' nullable: true - description: The status of the transcription + description: 'The status of the transcription. Can be: `in-progress`, `completed`, + `failed`.' transcription_text: type: string nullable: true @@ -4184,11 +4780,11 @@ components: type: type: string nullable: true - description: The transcription type + description: The transcription type. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. recording_transcription_enum_status: type: string enum: @@ -4204,26 +4800,30 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created this resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created this ShortCode resource. api_version: type: string nullable: true - description: The API version used to start a new TwiML session + description: The API version used to start a new TwiML session when an SMS + message is sent to this short code. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that this resource was created + description: The date and time in GMT that this 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 RFC 2822 date and time in GMT that this resource was last - updated + 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. friendly_name: type: string nullable: true - description: A string that you assigned to describe this resource + description: A string that you assigned to describe this resource. By default, + the `FriendlyName` is the short code. short_code: type: string nullable: true @@ -4234,7 +4834,8 @@ components: maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies this resource + description: The unique string that that we created to identify this ShortCode + resource. sms_fallback_method: type: string format: http-method @@ -4246,12 +4847,14 @@ components: - PUT - DELETE nullable: true - description: HTTP method we use to call the sms_fallback_url + description: 'The HTTP method we use to call the `sms_fallback_url`. Can + be: `GET` or `POST`.' sms_fallback_url: type: string format: uri nullable: true - description: URL Twilio will request if an error occurs in executing TwiML + description: The URL that we call if an error occurs while retrieving or + executing the TwiML from `sms_url`. sms_method: type: string format: http-method @@ -4263,17 +4866,18 @@ components: - PUT - DELETE nullable: true - description: HTTP method to use when requesting the sms url + description: 'The HTTP method we use to call the `sms_url`. Can be: `GET` + or `POST`.' sms_url: type: string format: uri nullable: true - description: URL we call when receiving an incoming SMS message to this - short code + description: The URL we call when receiving an incoming SMS message to this + short code. uri: type: string nullable: true - description: The URI of this resource, relative to `https://api.twilio.com` + description: The URI of this resource, relative to `https://api.twilio.com`. api.v2010.account.signing_key: type: object properties: @@ -4312,29 +4916,32 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the CredentialListMapping resource. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. 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. sid: type: string minLength: 34 maxLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the CredentialListMapping + resource. api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping: type: object properties: @@ -4344,29 +4951,32 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the IpAccessControlListMapping resource. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. 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. sid: type: string minLength: 34 maxLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the IpAccessControlListMapping + resource. api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations: type: object properties: {} @@ -4379,29 +4989,32 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the CredentialListMapping resource. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. 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. sid: type: string minLength: 34 maxLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the CredentialListMapping + resource. api.v2010.account.sip.sip_credential_list.sip_credential: type: object properties: @@ -4426,7 +5039,7 @@ components: pattern: ^CL[0-9a-fA-F]{32}$ nullable: true description: The unique id that identifies the credential list that includes - this credential + this credential. username: type: string nullable: true @@ -4435,18 +5048,20 @@ components: type: string format: date-time-rfc-2822 nullable: true - description: The date that this resource was created, given as GMT in RFC - 2822 format. + description: The date that this resource was created, given as GMT 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 as GMT - in RFC 2822 format. + in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) + format. uri: type: string nullable: true - description: The URI for this resource, relative to https://api.twilio.com + description: The URI for this resource, relative to `https://api.twilio.com` api.v2010.account.sip.sip_credential_list: type: object properties: @@ -4456,37 +5071,43 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique sid that identifies this account + description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) + that owns this resource. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The date this resource was created + description: The date that this resource was created, given as GMT 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 this resource was last updated + description: The date that this resource was last updated, given as GMT + in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) + format. friendly_name: type: string nullable: true - description: Human readable descriptive text + description: A human readable descriptive text that describes the CredentialList, + up to 64 characters long. sid: type: string minLength: 34 maxLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this credential + description: A 34 character string that uniquely identifies this resource. subresource_uris: type: object format: uri-map nullable: true - description: The list of credentials associated with this credential list. + description: A list of credentials associated with this credential list. uri: type: string nullable: true - description: The URI for this resource + description: The URI for this resource, relative to `https://api.twilio.com`. api.v2010.account.sip.sip_domain.sip_credential_list_mapping: type: object properties: @@ -4501,21 +5122,24 @@ components: type: string format: date-time-rfc-2822 nullable: true - description: The date that this resource was created, given as GMT in RFC - 2822 format. + description: The date that this resource was created, given as GMT 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 as GMT - in RFC 2822 format. + in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) + format. domain_sid: type: string minLength: 34 maxLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the SipDomain resource. + description: The unique string that is created to identify the SipDomain + resource. friendly_name: type: string nullable: true @@ -4531,7 +5155,7 @@ components: uri: type: string nullable: true - description: The URI for this resource, relative to https://api.twilio.com + description: The URI for this resource, relative to `https://api.twilio.com` api.v2010.account.sip.sip_domain: type: object properties: @@ -4541,45 +5165,53 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the SipDomain resource. api_version: type: string nullable: true - description: The API version used to process the call + description: The API version used to process the call. auth_type: type: string nullable: true - description: The types of authentication mapped to the domain + description: 'The types of authentication you have mapped to your domain. + Can be: `IP_ACL` and `CREDENTIAL_LIST`. If you have both defined for your + domain, both will be returned in a comma delimited string. If `auth_type` + is not defined, the domain will not be able to receive any traffic.' date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. domain_name: type: string nullable: true - description: The unique address on Twilio to route SIP traffic + description: The unique address you reserve on Twilio to which you route + your SIP traffic. Domain names can contain letters, digits, and "-" and + must end with `sip.twilio.com`. 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. sid: type: string minLength: 34 maxLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the SipDomain + resource. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. voice_fallback_method: type: string format: http-method @@ -4591,12 +5223,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with voice_fallback_url + description: 'The HTTP method we use to call `voice_fallback_url`. Can be: + `GET` or `POST`.' voice_fallback_url: type: string format: uri nullable: true - description: The URL we call when an error occurs while executing TwiML + description: The URL that we call when an error occurs while retrieving + or executing the TwiML requested from `voice_url`. voice_method: type: string format: http-method @@ -4608,7 +5242,8 @@ components: - PUT - DELETE nullable: true - description: The HTTP method to use with voice_url + description: 'The HTTP method we use to call `voice_url`. Can be: `GET` + or `POST`.' voice_status_callback_method: type: string format: http-method @@ -4620,41 +5255,51 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call voice_status_callback_url + description: The HTTP method we use to call `voice_status_callback_url`. + Either `GET` or `POST`. voice_status_callback_url: type: string format: uri nullable: true - description: The URL that we call with status updates + description: The URL that we call to pass status parameters (such as call + ended) to your application. voice_url: type: string format: uri nullable: true - description: The URL we call when receiving a call + description: The URL we call using the `voice_method` when the domain receives + a call. subresource_uris: type: object format: uri-map nullable: true - description: A list mapping resources associated with the SIP Domain resource + description: A list of mapping resources associated with the SIP Domain + resource identified by their relative URIs. sip_registration: type: boolean nullable: true - description: Whether SIP registration is allowed + description: Whether to allow SIP Endpoints to register with the domain + to receive calls. emergency_calling_enabled: type: boolean nullable: true - description: Whether emergency calling is enabled for the domain. + description: Whether emergency calling is enabled for the domain. If enabled, + allows emergency calls on the domain from phone numbers with validated + addresses. secure: type: boolean nullable: true - description: Whether secure SIP is enabled for the domain + description: Whether secure SIP is enabled for the domain. If enabled, TLS + will be enforced and SRTP will be negotiated on all incoming calls to + this sip domain. byoc_trunk_sid: type: string minLength: 34 maxLength: 34 pattern: ^BY[0-9a-fA-F]{32}$ nullable: true - description: The SID of the BYOC Trunk resource. + description: The SID of the BYOC Trunk(Bring Your Own Carrier) resource + that the Sip Domain will be associated with. emergency_caller_sid: type: string minLength: 34 @@ -4662,6 +5307,8 @@ components: pattern: ^PN[0-9a-fA-F]{32}$ 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. api.v2010.account.sip.sip_ip_access_control_list: type: object properties: @@ -4671,37 +5318,43 @@ components: maxLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this resource + description: A 34 character string that uniquely identifies this resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique sid that identifies this account + description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) + that owns this resource. friendly_name: type: string nullable: true - description: A human readable description of this resource + description: A human readable descriptive text, up to 255 characters long. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The date this resource was created + description: The date that this resource was created, given as GMT 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 this resource was last updated + description: The date that this resource was last updated, given as GMT + in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) + format. subresource_uris: type: object format: uri-map nullable: true - description: The IP addresses associated with this resource. + description: A list of the IpAddress resources associated with this IP access + control list resource. uri: type: string nullable: true - description: The URI for this resource + description: The URI for this resource, relative to `https://api.twilio.com` api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping: type: object properties: @@ -4716,21 +5369,24 @@ components: type: string format: date-time-rfc-2822 nullable: true - description: The date that this resource was created, given as GMT in RFC - 2822 format. + description: The date that this resource was created, given as GMT 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 as GMT - in RFC 2822 format. + in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) + format. domain_sid: type: string minLength: 34 maxLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the SipDomain resource. + description: The unique string that is created to identify the SipDomain + resource. friendly_name: type: string nullable: true @@ -4746,7 +5402,7 @@ components: uri: type: string nullable: true - description: The URI for this resource, relative to https://api.twilio.com + description: The URI for this resource, relative to `https://api.twilio.com` api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address: type: object properties: @@ -4793,18 +5449,20 @@ components: type: string format: date-time-rfc-2822 nullable: true - description: The date that this resource was created, given as GMT in RFC - 2822 format. + description: The date that this resource was created, given as GMT 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 as GMT - in RFC 2822 format. + in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) + format. uri: type: string nullable: true - description: The URI for this resource, relative to https://api.twilio.com + description: The URI for this resource, relative to `https://api.twilio.com` api.v2010.account.call.siprec: type: object properties: @@ -4821,18 +5479,21 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created this resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created this Siprec resource. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Siprec resource is associated with. name: type: string nullable: true - description: The name of this resource + description: The user-specified name of this Siprec, if one was given when + the Siprec was created. This may be used to stop the Siprec. status: type: string $ref: '#/components/schemas/siprec_enum_status' @@ -4842,12 +5503,12 @@ components: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that this resource was last - updated + 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. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. siprec_enum_track: type: string enum: @@ -4879,18 +5540,21 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created this resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created this Stream resource. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Stream resource is associated with. name: type: string nullable: true - description: The name of this resource + description: The user-specified name of this Stream, if one was given when + the Stream was created. This may be used to stop the Stream. status: type: string $ref: '#/components/schemas/stream_enum_status' @@ -4900,12 +5564,12 @@ components: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that this resource was last - updated + 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. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. stream_enum_track: type: string enum: @@ -4930,18 +5594,20 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Token resource. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. ice_servers: type: array items: @@ -4957,19 +5623,22 @@ components: urls: type: string nullable: true - description: An array representing the ephemeral credentials + description: An array representing the ephemeral credentials and the STUN + and TURN server URIs. password: type: string nullable: true - description: The temporary password used for authenticating + description: The temporary password that the username will use when authenticating + with Twilio. ttl: type: string nullable: true - description: The duration in seconds the credentials are valid + description: The duration in seconds for which the username and password + are valid. username: type: string nullable: true - description: The temporary username that uniquely identifies a Token + description: The temporary username that uniquely identifies a Token. api.v2010.account.transcription: type: object properties: @@ -4979,22 +5648,24 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Transcription resource. api_version: type: string nullable: true - description: The API version used to create the transcription + description: The API version used to create the transcription. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. duration: type: string nullable: true @@ -5002,31 +5673,37 @@ components: price: type: number nullable: true - description: The charge for the transcription + description: The charge for the transcript in the currency associated with + the account. This value is populated after the transcript is complete + so it may not be available immediately. price_unit: type: string format: currency nullable: true - description: The currency in which price is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format (e.g. `usd`, `eur`, `jpy`). recording_sid: type: string minLength: 34 maxLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ nullable: true - description: The SID that identifies the transcription's recording + description: The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) + from which the transcription was created. sid: type: string minLength: 34 maxLength: 34 pattern: ^TR[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the Transcription + resource. status: type: string $ref: '#/components/schemas/transcription_enum_status' nullable: true - description: The status of the transcription + description: 'The status of the transcription. Can be: `in-progress`, `completed`, + `failed`.' transcription_text: type: string nullable: true @@ -5034,11 +5711,11 @@ components: type: type: string nullable: true - description: The transcription type + description: 'The transcription type. Can only be: `fast`.' uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. transcription_enum_status: type: string enum: @@ -5057,68 +5734,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account accrued the usage + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that accrued the usage. api_version: type: string nullable: true - description: The API version used to create the resource + description: The API version used to create the resource. as_of: type: string nullable: true - description: Usage records up to date as of this timestamp + description: Usage records up to date as of this timestamp, formatted as + YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT category: type: string $ref: '#/components/schemas/usage_record_enum_category' nullable: true - description: The category of usage + description: The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). count: type: string nullable: true - description: The number of usage events + description: The number of usage events, such as the number of calls. count_unit: type: string nullable: true - description: The units in which count is measured + description: The units in which `count` is measured, such as `calls` for + calls or `messages` for SMS. description: type: string nullable: true - description: A plain-language description of the usage category + description: A plain-language description of the usage category. end_date: type: string format: date nullable: true - description: The last date for which usage is included in the UsageRecord + description: The last date for which usage is included in the UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. price: type: number nullable: true - description: The total price of the usage + description: The total price of the usage in the currency specified in `price_unit` + and associated with the account. price_unit: type: string format: currency nullable: true - description: The currency in which `price` is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format, such as `usd`, `eur`, and `jpy`. start_date: type: string format: date nullable: true - description: The first date for which usage is included in this UsageRecord + description: The first date for which usage is included in this UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their URIs. For more + information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources). uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. usage: type: string nullable: true - description: The amount of usage + description: The amount used to bill usage and measured in units described + in `usage_unit`. usage_unit: type: string nullable: true - description: The units in which usage is measured + description: The units in which `usage` is measured, such as `minutes` for + calls or `messages` for SMS. usage_record_enum_category: type: string enum: @@ -5376,68 +6063,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account accrued the usage + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that accrued the usage. api_version: type: string nullable: true - description: The API version used to create the resource + description: The API version used to create the resource. as_of: type: string nullable: true - description: Usage records up to date as of this timestamp + description: Usage records up to date as of this timestamp, formatted as + YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT category: type: string $ref: '#/components/schemas/usage_record_all_time_enum_category' nullable: true - description: The category of usage + description: The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). count: type: string nullable: true - description: The number of usage events + description: The number of usage events, such as the number of calls. count_unit: type: string nullable: true - description: The units in which count is measured + description: The units in which `count` is measured, such as `calls` for + calls or `messages` for SMS. description: type: string nullable: true - description: A plain-language description of the usage category + description: A plain-language description of the usage category. end_date: type: string format: date nullable: true - description: The last date for which usage is included in the UsageRecord + description: The last date for which usage is included in the UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. price: type: number nullable: true - description: The total price of the usage + description: The total price of the usage in the currency specified in `price_unit` + and associated with the account. price_unit: type: string format: currency nullable: true - description: The currency in which `price` is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format, such as `usd`, `eur`, and `jpy`. start_date: type: string format: date nullable: true - description: The first date for which usage is included in this UsageRecord + description: The first date for which usage is included in this UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their URIs. For more + information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources). uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. usage: type: string nullable: true - description: The amount of usage + description: The amount used to bill usage and measured in units described + in `usage_unit`. usage_unit: type: string nullable: true - description: The units in which usage is measured + description: The units in which `usage` is measured, such as `minutes` for + calls or `messages` for SMS. usage_record_all_time_enum_category: type: string enum: @@ -5695,68 +6392,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account accrued the usage + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that accrued the usage. api_version: type: string nullable: true - description: The API version used to create the resource + description: The API version used to create the resource. as_of: type: string nullable: true - description: Usage records up to date as of this timestamp + description: Usage records up to date as of this timestamp, formatted as + YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT category: type: string $ref: '#/components/schemas/usage_record_daily_enum_category' nullable: true - description: The category of usage + description: The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). count: type: string nullable: true - description: The number of usage events + description: The number of usage events, such as the number of calls. count_unit: type: string nullable: true - description: The units in which count is measured + description: The units in which `count` is measured, such as `calls` for + calls or `messages` for SMS. description: type: string nullable: true - description: A plain-language description of the usage category + description: A plain-language description of the usage category. end_date: type: string format: date nullable: true - description: The last date for which usage is included in the UsageRecord + description: The last date for which usage is included in the UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. price: type: number nullable: true - description: The total price of the usage + description: The total price of the usage in the currency specified in `price_unit` + and associated with the account. price_unit: type: string format: currency nullable: true - description: The currency in which `price` is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format, such as `usd`, `eur`, and `jpy`. start_date: type: string format: date nullable: true - description: The first date for which usage is included in this UsageRecord + description: The first date for which usage is included in this UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their URIs. For more + information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources). uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. usage: type: string nullable: true - description: The amount of usage + description: The amount used to bill usage and measured in units described + in `usage_unit`. usage_unit: type: string nullable: true - description: The units in which usage is measured + description: The units in which `usage` is measured, such as `minutes` for + calls or `messages` for SMS. usage_record_daily_enum_category: type: string enum: @@ -6014,68 +6721,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account accrued the usage + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that accrued the usage. api_version: type: string nullable: true - description: The API version used to create the resource + description: The API version used to create the resource. as_of: type: string nullable: true - description: Usage records up to date as of this timestamp + description: Usage records up to date as of this timestamp, formatted as + YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT category: type: string $ref: '#/components/schemas/usage_record_last_month_enum_category' nullable: true - description: The category of usage + description: The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). count: type: string nullable: true - description: The number of usage events + description: The number of usage events, such as the number of calls. count_unit: type: string nullable: true - description: The units in which count is measured + description: The units in which `count` is measured, such as `calls` for + calls or `messages` for SMS. description: type: string nullable: true - description: A plain-language description of the usage category + description: A plain-language description of the usage category. end_date: type: string format: date nullable: true - description: The last date for which usage is included in the UsageRecord + description: The last date for which usage is included in the UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. price: type: number nullable: true - description: The total price of the usage + description: The total price of the usage in the currency specified in `price_unit` + and associated with the account. price_unit: type: string format: currency nullable: true - description: The currency in which `price` is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format, such as `usd`, `eur`, and `jpy`. start_date: type: string format: date nullable: true - description: The first date for which usage is included in this UsageRecord + description: The first date for which usage is included in this UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their URIs. For more + information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources). uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. usage: type: string nullable: true - description: The amount of usage + description: The amount used to bill usage and measured in units described + in `usage_unit`. usage_unit: type: string nullable: true - description: The units in which usage is measured + description: The units in which `usage` is measured, such as `minutes` for + calls or `messages` for SMS. usage_record_last_month_enum_category: type: string enum: @@ -6333,68 +7050,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account accrued the usage + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that accrued the usage. api_version: type: string nullable: true - description: The API version used to create the resource + description: The API version used to create the resource. as_of: type: string nullable: true - description: Usage records up to date as of this timestamp + description: Usage records up to date as of this timestamp, formatted as + YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT category: type: string $ref: '#/components/schemas/usage_record_monthly_enum_category' nullable: true - description: The category of usage + description: The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). count: type: string nullable: true - description: The number of usage events + description: The number of usage events, such as the number of calls. count_unit: type: string nullable: true - description: The units in which count is measured + description: The units in which `count` is measured, such as `calls` for + calls or `messages` for SMS. description: type: string nullable: true - description: A plain-language description of the usage category + description: A plain-language description of the usage category. end_date: type: string format: date nullable: true - description: The last date for which usage is included in the UsageRecord + description: The last date for which usage is included in the UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. price: type: number nullable: true - description: The total price of the usage + description: The total price of the usage in the currency specified in `price_unit` + and associated with the account. price_unit: type: string format: currency nullable: true - description: The currency in which `price` is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format, such as `usd`, `eur`, and `jpy`. start_date: type: string format: date nullable: true - description: The first date for which usage is included in this UsageRecord + description: The first date for which usage is included in this UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their URIs. For more + information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources). uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. usage: type: string nullable: true - description: The amount of usage + description: The amount used to bill usage and measured in units described + in `usage_unit`. usage_unit: type: string nullable: true - description: The units in which usage is measured + description: The units in which `usage` is measured, such as `minutes` for + calls or `messages` for SMS. usage_record_monthly_enum_category: type: string enum: @@ -6652,68 +7379,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account accrued the usage + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that accrued the usage. api_version: type: string nullable: true - description: The API version used to create the resource + description: The API version used to create the resource. as_of: type: string nullable: true - description: Usage records up to date as of this timestamp + description: Usage records up to date as of this timestamp, formatted as + YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT category: type: string $ref: '#/components/schemas/usage_record_this_month_enum_category' nullable: true - description: The category of usage + description: The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). count: type: string nullable: true - description: The number of usage events + description: The number of usage events, such as the number of calls. count_unit: type: string nullable: true - description: The units in which count is measured + description: The units in which `count` is measured, such as `calls` for + calls or `messages` for SMS. description: type: string nullable: true - description: A plain-language description of the usage category + description: A plain-language description of the usage category. end_date: type: string format: date nullable: true - description: The last date for which usage is included in the UsageRecord + description: The last date for which usage is included in the UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. price: type: number nullable: true - description: The total price of the usage + description: The total price of the usage in the currency specified in `price_unit` + and associated with the account. price_unit: type: string format: currency nullable: true - description: The currency in which `price` is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format, such as `usd`, `eur`, and `jpy`. start_date: type: string format: date nullable: true - description: The first date for which usage is included in this UsageRecord + description: The first date for which usage is included in this UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their URIs. For more + information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources). uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. usage: type: string nullable: true - description: The amount of usage + description: The amount used to bill usage and measured in units described + in `usage_unit`. usage_unit: type: string nullable: true - description: The units in which usage is measured + description: The units in which `usage` is measured, such as `minutes` for + calls or `messages` for SMS. usage_record_this_month_enum_category: type: string enum: @@ -6971,68 +7708,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account accrued the usage + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that accrued the usage. api_version: type: string nullable: true - description: The API version used to create the resource + description: The API version used to create the resource. as_of: type: string nullable: true - description: Usage records up to date as of this timestamp + description: Usage records up to date as of this timestamp, formatted as + YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT category: type: string $ref: '#/components/schemas/usage_record_today_enum_category' nullable: true - description: The category of usage + description: The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). count: type: string nullable: true - description: The number of usage events + description: The number of usage events, such as the number of calls. count_unit: type: string nullable: true - description: The units in which count is measured + description: The units in which `count` is measured, such as `calls` for + calls or `messages` for SMS. description: type: string nullable: true - description: A plain-language description of the usage category + description: A plain-language description of the usage category. end_date: type: string format: date nullable: true - description: The last date for which usage is included in the UsageRecord + description: The last date for which usage is included in the UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. price: type: number nullable: true - description: The total price of the usage + description: The total price of the usage in the currency specified in `price_unit` + and associated with the account. price_unit: type: string format: currency nullable: true - description: The currency in which `price` is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format, such as `usd`, `eur`, and `jpy`. start_date: type: string format: date nullable: true - description: The first date for which usage is included in this UsageRecord + description: The first date for which usage is included in this UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their URIs. For more + information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources). uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. usage: type: string nullable: true - description: The amount of usage + description: The amount used to bill usage and measured in units described + in `usage_unit`. usage_unit: type: string nullable: true - description: The units in which usage is measured + description: The units in which `usage` is measured, such as `minutes` for + calls or `messages` for SMS. usage_record_today_enum_category: type: string enum: @@ -7290,68 +8037,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account accrued the usage + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that accrued the usage. api_version: type: string nullable: true - description: The API version used to create the resource + description: The API version used to create the resource. as_of: type: string nullable: true - description: Usage records up to date as of this timestamp + description: Usage records up to date as of this timestamp, formatted as + YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT category: type: string $ref: '#/components/schemas/usage_record_yearly_enum_category' nullable: true - description: The category of usage + description: The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). count: type: string nullable: true - description: The number of usage events + description: The number of usage events, such as the number of calls. count_unit: type: string nullable: true - description: The units in which count is measured + description: The units in which `count` is measured, such as `calls` for + calls or `messages` for SMS. description: type: string nullable: true - description: A plain-language description of the usage category + description: A plain-language description of the usage category. end_date: type: string format: date nullable: true - description: The last date for which usage is included in the UsageRecord + description: The last date for which usage is included in the UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. price: type: number nullable: true - description: The total price of the usage + description: The total price of the usage in the currency specified in `price_unit` + and associated with the account. price_unit: type: string format: currency nullable: true - description: The currency in which `price` is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format, such as `usd`, `eur`, and `jpy`. start_date: type: string format: date nullable: true - description: The first date for which usage is included in this UsageRecord + description: The first date for which usage is included in this UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their URIs. For more + information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources). uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. usage: type: string nullable: true - description: The amount of usage + description: The amount used to bill usage and measured in units described + in `usage_unit`. usage_unit: type: string nullable: true - description: The units in which usage is measured + description: The units in which `usage` is measured, such as `minutes` for + calls or `messages` for SMS. usage_record_yearly_enum_category: type: string enum: @@ -7609,68 +8366,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account accrued the usage + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that accrued the usage. api_version: type: string nullable: true - description: The API version used to create the resource + description: The API version used to create the resource. as_of: type: string nullable: true - description: Usage records up to date as of this timestamp + description: Usage records up to date as of this timestamp, formatted as + YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT category: type: string $ref: '#/components/schemas/usage_record_yesterday_enum_category' nullable: true - description: The category of usage + description: The category of usage. For more information, see [Usage Categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). count: type: string nullable: true - description: The number of usage events + description: The number of usage events, such as the number of calls. count_unit: type: string nullable: true - description: The units in which count is measured + description: The units in which `count` is measured, such as `calls` for + calls or `messages` for SMS. description: type: string nullable: true - description: A plain-language description of the usage category + description: A plain-language description of the usage category. end_date: type: string format: date nullable: true - description: The last date for which usage is included in the UsageRecord + description: The last date for which usage is included in the UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. price: type: number nullable: true - description: The total price of the usage + description: The total price of the usage in the currency specified in `price_unit` + and associated with the account. price_unit: type: string format: currency nullable: true - description: The currency in which `price` is measured + description: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) + format, such as `usd`, `eur`, and `jpy`. start_date: type: string format: date nullable: true - description: The first date for which usage is included in this UsageRecord + description: The first date for which usage is included in this UsageRecord. + The date is specified in GMT and formatted as `YYYY-MM-DD`. subresource_uris: type: object format: uri-map nullable: true - description: A list of related resources identified by their relative URIs + description: A list of related resources identified by their URIs. For more + information, see [List Subresources](https://www.twilio.com/docs/usage/api/usage-record#list-subresources). uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. usage: type: string nullable: true - description: The amount of usage + description: The amount used to bill usage and measured in units described + in `usage_unit`. usage_unit: type: string nullable: true - description: The units in which usage is measured + description: The units in which `usage` is measured, such as `minutes` for + calls or `messages` for SMS. usage_record_yesterday_enum_category: type: string enum: @@ -7928,11 +8695,12 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that this trigger monitors + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that the trigger monitors. api_version: type: string nullable: true - description: The API version used to create the resource + description: The API version used to create the resource. callback_method: type: string format: http-method @@ -7944,71 +8712,83 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call callback_url + description: 'The HTTP method we use to call `callback_url`. Can be: `GET` + or `POST`.' callback_url: type: string format: uri nullable: true - description: he URL we call when the trigger fires + description: The URL we call using the `callback_method` when the trigger + fires. current_value: type: string nullable: true - description: The current value of the field the trigger is watching + description: The current value of the field the trigger is watching. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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_fired: type: string format: date-time-rfc-2822 nullable: true - description: The RFC 2822 date and time in GMT that the trigger was last - fired + description: The date and time in GMT that the trigger was last fired 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. friendly_name: type: string nullable: true - description: The string that you assigned to describe the trigger + description: The string that you assigned to describe the trigger. recurring: type: string $ref: '#/components/schemas/usage_trigger_enum_recurring' nullable: true - description: The frequency of a recurring UsageTrigger + description: 'The frequency of a recurring UsageTrigger. Can be: `daily`, + `monthly`, or `yearly` for recurring triggers or empty for non-recurring + triggers. A trigger will only fire once during each period. Recurring + times are in GMT.' sid: type: string minLength: 34 maxLength: 34 pattern: ^UT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the UsageTrigger + resource. trigger_by: type: string $ref: '#/components/schemas/usage_trigger_enum_trigger_field' nullable: true - description: The field in the UsageRecord resource that fires the trigger + description: 'The field in the [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) + resource that fires the trigger. Can be: `count`, `usage`, or `price`, + as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).' trigger_value: type: string nullable: true - description: The value at which the trigger will fire + description: The value at which the trigger will fire. Must be a positive, + numeric value. uri: type: string nullable: true - description: The URI of the resource, relative to `https://api.twilio.com` + description: The URI of the resource, relative to `https://api.twilio.com`. usage_category: type: string $ref: '#/components/schemas/usage_trigger_enum_usage_category' nullable: true - description: The usage category the trigger watches + description: The usage category the trigger watches. Must be one of the + supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). usage_record_uri: type: string nullable: true - description: The URI of the UsageRecord resource this trigger watches + 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`. usage_trigger_enum_usage_category: type: string enum: @@ -8279,26 +9059,29 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account SID. + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created User Defined Message. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: Call SID. + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the User Defined Message is associated with. sid: type: string minLength: 34 maxLength: 34 pattern: ^KX[0-9a-fA-F]{32}$ nullable: true - description: User Defined Message SID. + description: The SID that uniquely identifies this User Defined Message. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The date this User Defined Message was created. + description: The date that this User Defined Message was created, given + in RFC 2822 format. api.v2010.account.call.user_defined_message_subscription: type: object properties: @@ -8308,26 +9091,31 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account SID. + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that subscribed to the User Defined Messages. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: Call SID. + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the User Defined Message Subscription is associated with. This refers + to the Call SID that is producing the User Defined Messages. sid: type: string minLength: 34 maxLength: 34 pattern: ^ZY[0-9a-fA-F]{32}$ nullable: true - description: User Defined Message Subscription SID. + description: The SID that uniquely identifies this User Defined Message + Subscription. date_created: type: string format: date-time-rfc-2822 nullable: true - description: The date this User Defined Message Subscription was created. + description: The date that this User Defined Message Subscription was created, + given in RFC 2822 format. uri: type: string nullable: true @@ -8342,28 +9130,32 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for the Caller ID. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Call the resource is associated with + description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) + the Caller ID is associated with. 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. phone_number: type: string format: phone-number nullable: true - description: The phone number to verify in E.164 format + 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. 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 + the Caller ID when `phone_number` is called. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_autopilot_v1.yaml b/spec/yaml/twilio_autopilot_v1.yaml index 228205a1..754a4451 100644 --- a/spec/yaml/twilio_autopilot_v1.yaml +++ b/spec/yaml/twilio_autopilot_v1.yaml @@ -9,38 +9,43 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 + 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 + description: Reserved. links: type: object format: uri-map nullable: true - description: A list of the URLs of the Assistant's related resources + 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 + 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 @@ -48,33 +53,35 @@ components: needs_model_build: type: boolean nullable: true - description: Whether model needs to be rebuilt + 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 identifies the resource + 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 + 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 + description: The absolute URL of the Assistant resource. callback_url: type: string format: uri nullable: true - description: Reserved + description: Reserved. callback_events: type: string nullable: true - description: Reserved + description: Reserved. autopilot.v1.assistant.defaults: type: object properties: @@ -84,22 +91,25 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 that is the parent of the resource + 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 + description: The absolute URL of the Defaults resource. data: nullable: true - description: The JSON string that describes the default task links + 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: @@ -109,29 +119,32 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 that is the parent of the resource + 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 identifies the resource + 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 + 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 + description: The absolute URL of the Dialogue resource. autopilot.v1.assistant.task.field: type: object properties: @@ -141,22 +154,25 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 + 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 @@ -164,32 +180,33 @@ components: 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 + 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 that is the parent of the Task associated - with the resource + 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 identifies the resource + 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 + 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 + description: The absolute URL of the Field resource. autopilot.v1.assistant.field_type: type: object properties: @@ -199,51 +216,57 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 + 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 + 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 that is the parent of the resource + 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 identifies the resource + 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 + 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 + description: The absolute URL of the FieldType resource. autopilot.v1.assistant.field_type.field_value: type: object properties: @@ -253,61 +276,65 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 + description: The SID of the Field Type associated with the Field Value. language: type: string nullable: true - description: The ISO language-country tag that identifies the language of - the value + 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 that is the parent of the FieldType - associated with the resource + 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 identifies the resource + description: The unique string that we created to identify the FieldValue + resource. value: type: string nullable: true - description: The Field Value data + description: The Field Value data. url: type: string format: uri nullable: true - description: The absolute URL of the FieldValue resource + 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 + description: The word for which the field value is a synonym of. autopilot.v1.assistant.model_build: type: object properties: @@ -317,56 +344,64 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 that is the parent of the resource + 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 identifies the resource + 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 + 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 + 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 + 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 + description: The time in seconds it took to build the model. error_code: type: integer nullable: true - description: More information about why the model build failed, if `status` - is `failed` + 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: @@ -384,27 +419,29 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 - recognized and a list of identified Fields + 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 string that specifies the language - used by the 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. For example: `en-US`.' model_build_sid: type: string minLength: 34 @@ -412,46 +449,48 @@ components: 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 + queried. query: type: string nullable: true - description: The end-user's natural language input + 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 created from - the query + 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 that is the parent of the resource + 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 identifies the resource + description: The unique string that we created to identify the Query resource. status: type: string nullable: true - description: The status of the Query + 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 + 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 + description: The communication channel from where the end-user input came. dialogue_sid: type: string minLength: 34 @@ -468,49 +507,56 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 identifies the resource + description: The unique string that we created to identify the Assistant + resource. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 + 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 + 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 + 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 + description: Reserved. log_queries: type: boolean nullable: true - description: Whether queries should be logged and kept after training + 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 @@ -519,11 +565,11 @@ components: type: string format: uri nullable: true - description: Reserved + description: Reserved. callback_events: type: string nullable: true - description: Reserved + description: Reserved. autopilot.v1.assistant.task.sample: type: object properties: @@ -533,58 +579,64 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 associated with the resource + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + associated with the resource. language: type: string nullable: true - description: An ISO language-country string that specifies the language - used for the sample + 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 that is the parent of the Task associated - with the resource + 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 identifies the resource + 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 + 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 + description: The absolute URL of the Sample resource. source_channel: type: string nullable: true - description: The communication channel from which the sample was captured + 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: @@ -594,22 +646,24 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 that is the parent of the resource + 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 + description: The absolute URL of the StyleSheet resource. data: nullable: true - description: The JSON string that describes the style sheet object + description: The JSON string that describes the style sheet object. autopilot.v1.assistant.task: type: object properties: @@ -619,56 +673,61 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 + 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 + 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 that is the parent of the resource + 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 identifies the resource + 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 + 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 + 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 + description: The absolute URL of the Task resource. autopilot.v1.assistant.task.task_actions: type: object properties: @@ -678,31 +737,33 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 that is the parent of the Task associated - with the resource + 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 associated with the resource + 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 + description: The absolute URL of the TaskActions resource. data: nullable: true - description: The JSON string that specifies the actions that instruct the - Assistant on how to perform the task + 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: @@ -712,35 +773,39 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 that is the parent of the Task associated - with the resource + 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 for which the statistics were collected + 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 associated with the Task + 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 associated with the Task + 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 + description: The absolute URL of the TaskStatistics resource. autopilot.v1.assistant.webhook: type: object properties: @@ -748,44 +813,48 @@ components: type: string format: uri nullable: true - description: The absolute URL of the Webhook resource + 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 that created the resource + 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 RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 that is the parent of the resource + 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 identifies the resource + 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 + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. events: type: string nullable: true diff --git a/spec/yaml/twilio_bulkexports_v1.yaml b/spec/yaml/twilio_bulkexports_v1.yaml index ae357d25..e6575b1a 100644 --- a/spec/yaml/twilio_bulkexports_v1.yaml +++ b/spec/yaml/twilio_bulkexports_v1.yaml @@ -6,15 +6,16 @@ components: day: type: string nullable: true - description: The date of the data in the file + description: The ISO 8601 format date of the resources in the file, for + a UTC day size: type: integer nullable: true - description: Size of the file in bytes + description: The size of the day's data file in bytes create_date: type: string nullable: true - description: The date when resource is created + description: The ISO 8601 format date when resources is created friendly_name: type: string nullable: true @@ -48,23 +49,27 @@ components: type: object format: uri-map nullable: true - description: Nested resource URLs. + description: Contains a dictionary of URL links to nested resources of this + Export. bulkexports.v1.export_configuration: type: object properties: enabled: type: boolean nullable: true - description: Whether files are automatically generated + description: If true, Twilio will automatically generate every day's file + when the day is over. webhook_url: type: string format: uri nullable: true - description: URL targeted at export + description: Stores the URL destination for the method specified in webhook_method. webhook_method: type: string nullable: true - description: Whether to GET or POST to the webhook url + 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 resource_type: type: string nullable: true @@ -90,25 +95,22 @@ components: start_day: type: string nullable: true - description: The start day for the custom export specified as a string in - the format of yyyy-MM-dd + description: The start day for the custom export specified when creating + the job end_day: type: string nullable: true - description: The end day for the custom export specified as a string in - the format of yyyy-MM-dd. This will be the last day exported. For instance, - to export a single day, choose the same day for start and end day. To - export the first 4 days of July, you would set the start date to 2020-07-01 - and the end date to 2020-07-04. The end date must be the UTC day before - yesterday. + description: The end day for the export specified when creating the job webhook_url: type: string nullable: true - description: The optional webhook url called on completion + description: The optional webhook url called on completion of the job. If + this is supplied, `WebhookMethod` must also be supplied. webhook_method: type: string nullable: true - description: This is the method used to call the webhook + description: This is the method used to call the webhook on completion of + the job. If this is supplied, `WebhookUrl` must also be supplied. email: type: string nullable: true @@ -119,12 +121,16 @@ components: maxLength: 34 pattern: ^JS[0-9a-fA-F]{32}$ nullable: true - description: The unique job_sid returned when the custom export was created. - This can be used to look up the status of the job. + description: The unique job_sid returned when the custom export was created details: nullable: true - description: The details of a job state which is an object that contains - a `status` string, a day count integer, and list of days in the job + description: The details of a job which is an object that contains an array + of status grouped by `status` state. Each `status` object has a `status` + string, a count which is the number of days in that `status`, and list + of days in that `status`. The day strings are in the format yyyy-MM-dd. + As an example, a currently running job may have a status object for COMPLETED + and a `status` object for SUBMITTED each with its own count and list of + days. job_queue_position: type: string nullable: true @@ -163,8 +169,13 @@ components: description: The friendly name specified when creating the job details: nullable: true - description: The details of a job state which is an object that contains - a `status` string, a day count integer, and list of days in the job + description: The details of a job which is an object that contains an array + of status grouped by `status` state. Each `status` object has a `status` + string, a count which is the number of days in that `status`, and list + of days in that `status`. The day strings are in the format yyyy-MM-dd. + As an example, a currently running job may have a status object for COMPLETED + and a `status` object for SUBMITTED each with its own count and list of + days. start_day: type: string nullable: true diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml index eb077425..caf37f70 100644 --- a/spec/yaml/twilio_chat_v1.yaml +++ b/spec/yaml/twilio_chat_v1.yaml @@ -9,73 +9,83 @@ components: maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Channel resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/api/rest/account) + that created the Channel resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + the resource is associated with. 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. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used to address the resource in place of the resource's + `sid` in the URL. attributes: type: string nullable: true - description: The JSON string that stores application-specific data + 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. type: type: string $ref: '#/components/schemas/channel_enum_channel_type' nullable: true - description: 'The visibility of the channel. Can be: `public` or `private`' + description: 'The visibility of the channel. Can be: `public` or `private`.' date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. created_by: type: string nullable: true - description: The identity of the User that created the channel + description: The `identity` of the User that created the channel. If the + Channel was created by using the API, the value is `system`. members_count: type: integer nullable: true - description: The number of Members in the Channel + description: The number of Members in the Channel. messages_count: type: integer nullable: true - description: The number of Messages in the Channel + description: The number of Messages in the Channel. url: type: string format: uri nullable: true - description: The absolute URL of the Channel resource + description: The absolute URL of the Channel resource. links: type: object format: uri-map nullable: true - description: Absolute URLs to access the Members, Messages , Invites and, - if it exists, the last Message for the Channel + description: The absolute URLs of the [Members](https://www.twilio.com/docs/chat/api/members), + [Messages](https://www.twilio.com/docs/chat/api/messages) , [Invites](https://www.twilio.com/docs/chat/api/invites) + and, if it exists, the last [Message](https://www.twilio.com/docs/chat/api/messages) + for the Channel. channel_enum_channel_type: type: string enum: @@ -90,43 +100,48 @@ components: maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Credential + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/api/rest/account) + that created the Credential resource. 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. type: type: string $ref: '#/components/schemas/credential_enum_push_service' nullable: true - description: The type of push-notification service the credential is for + description: 'The type of push-notification service the credential is for. + Can be: `gcm`, `fcm`, or `apn`.' sandbox: type: string nullable: true - description: '[APN only] Whether to send the credential to sandbox APNs' + description: '[APN only] Whether to send the credential to sandbox APNs. + Can be `true` to send to sandbox APNs or `false` to send to production.' date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true - description: The absolute URL of the Credential resource + description: The absolute URL of the Credential resource. credential_enum_push_service: type: string enum: @@ -142,59 +157,68 @@ components: maxLength: 34 pattern: ^IN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Invite resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/api/rest/account) + that created the Invite resource. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Channel the new resource belongs to + description: The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the resource belongs to. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + the resource is associated with. identity: type: string nullable: true - description: The string that identifies the resource's User + 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. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Role assigned to the member + description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) + assigned to the resource. created_by: type: string nullable: true - description: The identity of the User that created the invite + description: The `identity` of the User that created the invite. url: type: string format: uri nullable: true - description: The absolute URL of the Invite resource + description: The absolute URL of the Invite resource. chat.v1.service.channel.member: type: object properties: @@ -204,66 +228,77 @@ components: maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Member resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/api/rest/account) + that created the Member resource. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Channel for the member + description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + for the member. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + the resource is associated with. identity: type: string nullable: true - description: The string that identifies the resource's User + 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. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Role assigned to the member + description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) + assigned to the member. last_consumed_message_index: type: integer nullable: true - description: The index of the last Message that the Member has read within - the Channel + description: The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) + in the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) that + the Member has read. last_consumption_timestamp: type: string format: date-time nullable: true - description: The ISO 8601 based timestamp string that represents the date-time - of the last Message read event for the Member within the Channel + description: The ISO 8601 timestamp string that represents the date-time + of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) + read event for the Member within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels). url: type: string format: uri nullable: true - description: The absolute URL of the Member resource + description: The absolute URL of the Member resource. chat.v1.service.channel.message: type: object properties: @@ -273,71 +308,80 @@ components: maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Message resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/api/rest/account) + that created the Message resource. attributes: type: string nullable: true - description: The JSON string that stores application-specific data + 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. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + the resource is associated with. to: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Channel that the message was sent to + description: The SID of the [Channel](https://www.twilio.com/docs/chat/api/channels) + that the message was sent to. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Channel the Message resource belongs to + description: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the Message resource belongs to. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. was_edited: type: boolean nullable: true - description: Whether the message has been edited since it was created + description: Whether the message has been edited since it was created. from: type: string nullable: true - description: The identity of the message's author + description: The [identity](https://www.twilio.com/docs/api/chat/guides/identity) + of the message's author. The default value is `system`. body: type: string nullable: true - description: The content of the message + description: The content of the message. index: type: integer nullable: true - description: The index of the message within the Channel + description: The index of the message within the [Channel](https://www.twilio.com/docs/chat/api/channels). url: type: string format: uri nullable: true - description: The absolute URL of the Message resource + description: The absolute URL of the Message resource. message_enum_order_type: type: string enum: @@ -352,52 +396,58 @@ components: maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Role resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/api/rest/account) + that created the Role resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + the resource is associated with. 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. type: type: string $ref: '#/components/schemas/role_enum_role_type' nullable: true - description: The type of role + description: 'The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/api/channels) + roles or `deployment` for [Service](https://www.twilio.com/docs/chat/api/services) + roles.' permissions: type: array items: type: string nullable: true - description: An array of the permissions the role has been granted + description: An array of the permissions the role has been granted, formatted + as a JSON string. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true - description: The absolute URL of the Role resource + description: The absolute URL of the Role resource. role_enum_role_type: type: string enum: @@ -412,29 +462,31 @@ components: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Service resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/api/rest/account) + that created the Service resource. 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. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. default_service_role_sid: type: string minLength: 34 @@ -442,7 +494,8 @@ components: pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The service role assigned to users when they are added to the - service + service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) + for more details. default_channel_role_sid: type: string minLength: 34 @@ -450,7 +503,8 @@ components: pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The channel role assigned to users when they are added to a - channel + channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) + for more details. default_channel_creator_role_sid: type: string minLength: 34 @@ -458,64 +512,83 @@ components: pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The channel role assigned to a channel creator when they join - a new channel + a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) + for more details. read_status_enabled: type: boolean nullable: true - description: Whether the Message Consumption Horizon feature is enabled + description: Whether the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) + feature is enabled. The default is `true`. reachability_enabled: type: boolean nullable: true - description: Whether the Reachability Indicator feature is enabled for this - Service instance + description: Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) + is enabled for this Service instance. The default is `false`. typing_indicator_timeout: type: integer nullable: true - description: How long in seconds to wait before assuming the user is no - longer typing + description: How long in seconds after a `started typing` event until clients + should assume that user is no longer typing, even if no `ended typing` + message was received. The default is 5 seconds. consumption_report_interval: type: integer nullable: true - description: DEPRECATED + description: DEPRECATED. The interval in seconds between consumption reports + submission batches from client endpoints. limits: nullable: true - description: An object that describes the limits of the service instance + description: An object that describes the limits of the service instance. + The `limits` object contains `channel_members` to describe the members/channel + limit and `user_channels` to describe the channels/user limit. `channel_members` + can be 1,000 or less, with a default of 250. `user_channels` can be 1,000 + or less, with a default value of 100. webhooks: nullable: true description: An object that contains information about the webhooks configured - for this service + for this service. pre_webhook_url: type: string nullable: true - description: The webhook URL for pre-event webhooks + description: The URL for pre-event webhooks, which are called by using the + `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) + for more details. post_webhook_url: type: string nullable: true - description: The URL for post-event webhooks + description: The URL for post-event webhooks, which are called by using + the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) + for more details. webhook_method: type: string nullable: true - description: The HTTP method to use for both PRE and POST webhooks + description: 'The HTTP method to use for calls to the `pre_webhook_url` + and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default + is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) + for more details.' webhook_filters: type: array items: type: string nullable: true description: The list of WebHook events that are enabled for this Service - instance + instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) + for more details. notifications: nullable: true - description: The notification configuration for the Service instance + description: The notification configuration for the Service instance. See + [Push Notification Configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + for more information. url: type: string format: uri nullable: true - description: The absolute URL of the Service resource + description: The absolute URL of the Service resource. links: type: object format: uri-map nullable: true - description: The absolute URLs of the Service's Channels, Roles, and Users + description: The absolute URLs of the Service's [Channels](https://www.twilio.com/docs/chat/api/channels), + [Roles](https://www.twilio.com/docs/chat/api/roles), and [Users](https://www.twilio.com/docs/chat/api/users). chat.v1.service.user: type: object properties: @@ -525,76 +598,96 @@ components: maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the User resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/api/rest/account) + that created the User resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + the resource is associated with. attributes: type: string nullable: true - description: The JSON string that stores application-specific data + 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. 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. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The SID of the assigned to the user + description: The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) + assigned to the user. identity: type: string nullable: true - description: The string that identifies the resource's User + 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. is_online: type: boolean nullable: true description: Whether the User is actively connected to the Service instance - and online + and online. This value is only returned by Fetch actions that return a + single resource and `null` is always returned by a Read action. This value + is `null` if the Service's `reachability_enabled` is `false`, if the User + has never been online for the Service instance, even if the Service's + `reachability_enabled` is `true`. is_notifiable: type: boolean nullable: true description: Whether the User has a potentially valid Push Notification - registration for the Service instance + registration (APN or GCM) for the Service instance. If at least one registration + exists, `true`; otherwise `false`. This value is only returned by Fetch + actions that return a single resource and `null` is always returned by + a Read action. This value is `null` if the Service's `reachability_enabled` + is `false`, and if the User has never had a notification registration, + even if the Service's `reachability_enabled` is `true`. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. joined_channels_count: type: integer nullable: true - description: The number of Channels this User is a Member of + description: The number of Channels this User is a Member of. links: type: object format: uri-map nullable: true - description: The absolute URLs of the Channel and Binding resources related - to the user + description: The absolute URLs of the [Channel](https://www.twilio.com/docs/chat/api/channels) + and [Binding](https://www.twilio.com/docs/chat/rest/bindings-resource) + resources related to the user. url: type: string format: uri nullable: true - description: The absolute URL of the User resource + description: The absolute URL of the User resource. chat.v1.service.user.user_channel: type: object properties: @@ -604,48 +697,59 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/api/rest/account) + that created the User Channel resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) + the resource is associated with. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Channel the resource belongs to + description: The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) + the resource belongs to. member_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true - description: The SID of the User as a Member in the Channel + description: The SID of a [Member](https://www.twilio.com/docs/api/chat/rest/members) + that represents the User on the Channel. status: type: string $ref: '#/components/schemas/user_channel_enum_channel_status' nullable: true - description: The status of the User on the Channel + description: 'The status of the User on the Channel. Can be: `joined`, `invited`, + or `not_participating`.' last_consumed_message_index: type: integer nullable: true - description: The index of the last Message in the Channel the Member has - read + description: The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) + in the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) that + the Member has read. unread_messages_count: type: integer nullable: true - description: The number of unread Messages in the Channel for the User + description: The number of unread Messages in the Channel for the User. + Note that retrieving messages on a client endpoint does not mean that + messages are consumed or read. See [Consumption Horizon feature](/docs/api/chat/guides/consumption-horizon) + to learn how to mark messages as consumed. links: type: object format: uri-map nullable: true - description: Absolute URLs to access the Members, Messages , Invites and, - if it exists, the last Message for the Channel + description: The absolute URLs of the [Members](https://www.twilio.com/docs/chat/api/members), + [Messages](https://www.twilio.com/docs/chat/api/messages) , [Invites](https://www.twilio.com/docs/chat/api/invites) + and, if it exists, the last [Message](https://www.twilio.com/docs/chat/api/messages) + for the Channel. user_channel_enum_channel_status: type: string enum: diff --git a/spec/yaml/twilio_chat_v2.yaml b/spec/yaml/twilio_chat_v2.yaml index cc3e376f..ffdd5aab 100644 --- a/spec/yaml/twilio_chat_v2.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -9,70 +9,81 @@ components: maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Binding resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Binding resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the Binding resource is associated - with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the Binding resource is associated with. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. endpoint: type: string nullable: true - description: The unique endpoint identifier for the Binding + description: The unique endpoint identifier for the Binding. The format + of this value depends on the `binding_type`. identity: type: string nullable: true - description: The string that identifies the resource's User + 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. credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Credential for the binding + description: The SID of the [Credential](https://www.twilio.com/docs/chat/rest/credential-resource) + for the binding. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + for more info. binding_type: type: string $ref: '#/components/schemas/binding_enum_binding_type' nullable: true - description: The push technology to use for the binding + description: 'The push technology to use for the Binding. Can be: `apn`, + `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + for more info.' message_types: type: array items: type: string nullable: true - description: The Programmable Chat message types the binding is subscribed - to + description: The [Programmable Chat message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) + the binding is subscribed to. url: type: string format: uri nullable: true - description: The absolute URL of the Binding resource + description: The absolute URL of the Binding resource. links: type: object format: uri-map nullable: true - description: The absolute URLs of the Binding's User + description: The absolute URLs of the Binding's [User](https://www.twilio.com/docs/chat/rest/user-resource). binding_enum_binding_type: type: string enum: @@ -88,73 +99,81 @@ components: maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Channel resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Channel resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the Channel resource is associated with. 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. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used to address the resource in place of the resource's + `sid` in the URL. attributes: type: string nullable: true - description: The JSON string that stores application-specific data + description: The JSON string that stores application-specific data. If attributes + have not been set, `{}` is returned. type: type: string $ref: '#/components/schemas/channel_enum_channel_type' nullable: true - description: 'The visibility of the channel. Can be: `public` or `private`' + description: 'The visibility of the channel. Can be: `public` or `private`.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. created_by: type: string nullable: true - description: The identity of the User that created the channel + description: The `identity` of the User that created the channel. If the + Channel was created by using the API, the value is `system`. members_count: type: integer nullable: true - description: The number of Members in the Channel + description: The number of Members in the Channel. messages_count: type: integer nullable: true - description: The number of Messages that have been passed in the Channel + description: The number of Messages that have been passed in the Channel. url: type: string format: uri nullable: true - description: The absolute URL of the Channel resource + description: The absolute URL of the Channel resource. links: type: object format: uri-map nullable: true - description: Absolute URLs to access the Members, Messages , Invites and, - if it exists, the last Message for the Channel + description: The absolute URLs of the [Members](https://www.twilio.com/docs/chat/rest/member-resource), + [Messages](https://www.twilio.com/docs/chat/rest/message-resource), [Invites](https://www.twilio.com/docs/chat/rest/invite-resource), + Webhooks and, if it exists, the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) + for the Channel. channel_enum_channel_type: type: string enum: @@ -174,54 +193,58 @@ components: maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Channel 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 that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Channel Webhook resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the Channel Webhook resource is - associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the Channel Webhook resource is associated with. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Channel the Channel Webhook resource belongs - to + description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) + the Channel Webhook resource belongs to. type: type: string nullable: true - description: The type of webhook + description: 'The type of webhook. Can be: `webhook`, `studio`, or `trigger`.' url: type: string format: uri nullable: true - description: The absolute URL of the Channel Webhook resource + description: The absolute URL of the Channel Webhook resource. configuration: nullable: true - description: The JSON string that describes the configuration object for - the channel webhook + description: The JSON string that describes how the channel webhook is configured. + The configuration object contains the `url`, `method`, `filters`, and + `retry_count` values that are configured by the create and update actions. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. channel_webhook_enum_type: type: string enum: @@ -242,43 +265,48 @@ components: maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Credential + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Credential resource. 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. type: type: string $ref: '#/components/schemas/credential_enum_push_service' nullable: true - description: The type of push-notification service the credential is for + description: 'The type of push-notification service the credential is for. + Can be: `gcm`, `fcm`, or `apn`.' sandbox: type: string nullable: true - description: '[APN only] Whether to send the credential to sandbox APNs' + description: '[APN only] Whether to send the credential to sandbox APNs. + Can be `true` to send to sandbox APNs or `false` to send to production.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 Credential resource + description: The absolute URL of the Credential resource. credential_enum_push_service: type: string enum: @@ -294,59 +322,68 @@ components: maxLength: 34 pattern: ^IN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Invite resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Invite resource. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Channel the new resource belongs to + description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) + the Invite resource belongs to. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the Invite resource is associated with. identity: type: string nullable: true - description: The string that identifies the resource's User + 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. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Role assigned to the member + description: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) + assigned to the resource. created_by: type: string nullable: true - description: The identity of the User that created the invite + description: The `identity` of the User that created the invite. url: type: string format: uri nullable: true - description: The absolute URL of the Invite resource + description: The absolute URL of the Invite resource. chat.v2.service.channel.member: type: object properties: @@ -356,70 +393,82 @@ components: maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Member resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Member resource. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Channel for the member + description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) + the Member resource belongs to. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the Member resource is associated with. identity: type: string nullable: true - description: The string that identifies the resource's User + 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. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Role assigned to the member + description: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) + assigned to the member. last_consumed_message_index: type: integer nullable: true - description: The index of the last Message that the Member has read within - the Channel + description: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) + in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member + has read. last_consumption_timestamp: type: string format: date-time nullable: true - description: The ISO 8601 based timestamp string that represents the datetime - of the last Message read event for the Member within the Channel + 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). url: type: string format: uri nullable: true - description: The absolute URL of the Member resource + description: The absolute URL of the Member resource. attributes: type: string nullable: true - description: The JSON string that stores application-specific data + description: The JSON string that stores application-specific data. If attributes + have not been set, `{}` is returned. member_enum_webhook_enabled_type: type: string enum: @@ -434,83 +483,96 @@ components: maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Message resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Message resource. attributes: type: string nullable: true - description: The JSON string that stores application-specific data + description: The JSON string that stores application-specific data. If attributes + have not been set, `{}` is returned. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the Message resource is associated with. to: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Channel that the message was sent to + description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) + that the message was sent to. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Channel the Message resource belongs to + description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) + the Message resource belongs to. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. last_updated_by: type: string nullable: true - description: The Identity of the User who last updated the Message + description: The [Identity](https://www.twilio.com/docs/chat/identity) of + the User who last updated the Message, if applicable. was_edited: type: boolean nullable: true - description: Whether the message has been edited since it was created + description: Whether the message has been edited since it was created. from: type: string nullable: true - description: The Identity of the message's author + description: The [Identity](https://www.twilio.com/docs/chat/identity) of + the message's author. The default value is `system`. body: type: string nullable: true - description: The content of the message + description: The content of the message. index: type: integer nullable: true - description: The index of the message within the Channel + description: The index of the message within the [Channel](https://www.twilio.com/docs/chat/channels). + Indices may skip numbers, but will always be in order of when the message + was received. type: type: string nullable: true - description: The Message type + description: 'The Message type. Can be: `text` or `media`.' media: nullable: true - description: A Media object that describes the Message's media if attached; - otherwise, 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`.' url: type: string format: uri nullable: true - description: The absolute URL of the Message resource + description: The absolute URL of the Message resource. message_enum_order_type: type: string enum: @@ -530,52 +592,57 @@ components: maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Role resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Role resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the Role resource is associated with. 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. type: type: string $ref: '#/components/schemas/role_enum_role_type' nullable: true - description: The type of role + description: 'The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/channels) + roles or `deployment` for [Service](https://www.twilio.com/docs/chat/rest/service-resource) + roles.' permissions: type: array items: type: string nullable: true - description: An array of the permissions the role has been granted + description: An array of the permissions the role has been granted. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 Role resource + description: The absolute URL of the Role resource. role_enum_role_type: type: string enum: @@ -590,29 +657,31 @@ components: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Service resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Service resource. 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. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. default_service_role_sid: type: string minLength: 34 @@ -620,7 +689,8 @@ components: pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The service role assigned to users when they are added to the - service + service. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) + for more info about roles. default_channel_role_sid: type: string minLength: 34 @@ -628,7 +698,8 @@ components: pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The channel role assigned to users when they are added to a - channel + channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) + for more info about roles. default_channel_creator_role_sid: type: string minLength: 34 @@ -636,73 +707,101 @@ components: pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The channel role assigned to a channel creator when they join - a new channel + a new channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) + for more info about roles. read_status_enabled: type: boolean nullable: true - description: Whether the Message Consumption Horizon feature is enabled + description: Whether the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) + feature is enabled. The default is `true`. reachability_enabled: type: boolean nullable: true - description: Whether the Reachability Indicator feature is enabled for this - Service instance + description: Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) + is enabled for this Service instance. The default is `false`. typing_indicator_timeout: type: integer nullable: true - description: How long in seconds to wait before assuming the user is no - longer typing + description: How long in seconds after a `started typing` event until clients + should assume that user is no longer typing, even if no `ended typing` + message was received. The default is 5 seconds. consumption_report_interval: type: integer nullable: true - description: DEPRECATED + description: DEPRECATED. The interval in seconds between consumption reports + submission batches from client endpoints. limits: nullable: true - description: An object that describes the limits of the service instance + description: An object that describes the limits of the service instance. + The `limits` object contains `channel_members` to describe the members/channel + limit and `user_channels` to describe the channels/user limit. `channel_members` + can be 1,000 or less, with a default of 250. `user_channels` can be 1,000 + or less, with a default value of 100. pre_webhook_url: type: string nullable: true - description: The webhook URL for pre-event webhooks + description: The URL for pre-event webhooks, which are called by using the + `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) + for more details. post_webhook_url: type: string nullable: true - description: The URL for post-event webhooks + description: The URL for post-event webhooks, which are called by using + the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) + for more details. webhook_method: type: string nullable: true - description: The HTTP method to use for both PRE and POST webhooks + description: 'The HTTP method to use for calls to the `pre_webhook_url` + and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default + is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) + for more details.' webhook_filters: type: array items: type: string nullable: true description: The list of webhook events that are enabled for this Service - instance + instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) + for more details. pre_webhook_retry_count: type: integer nullable: true - description: Count of times webhook will be retried in case of timeout or - 429/503/504 HTTP responses + description: The number of times to retry a call to the `pre_webhook_url` + if the request times out (after 5 seconds) or it receives a 429, 503, + or 504 HTTP response. Default retry count is 0 times, which means the + call won't be retried. post_webhook_retry_count: type: integer nullable: true - description: The number of times calls to the `post_webhook_url` will be - retried + description: The number of times to retry a call to the `post_webhook_url` + if the request times out (after 5 seconds) or it receives a 429, 503, + or 504 HTTP response. The default is 0, which means the call won't be + retried. notifications: nullable: true - description: The notification configuration for the Service instance + description: The notification configuration for the Service instance. See + [Push Notification Configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + for more info. media: nullable: true - description: The properties of the media that the service supports + description: An object that describes the properties of media that the service + supports. The object contains the `size_limit_mb` property, which describes + the size of the largest media file in MB; and the `compatibility_message` + property, which contains the message text to send when a media message + does not have any text. url: type: string format: uri nullable: true - description: The absolute URL of the Service resource + description: The absolute URL of the Service resource. links: type: object format: uri-map nullable: true - description: The absolute URLs of the Service's Channels, Roles, and Users + description: The absolute URLs of the Service's [Channels](https://www.twilio.com/docs/chat/channels), + [Roles](https://www.twilio.com/docs/chat/rest/role-resource), [Bindings](https://www.twilio.com/docs/chat/rest/binding-resource), + and [Users](https://www.twilio.com/docs/chat/rest/user-resource). chat.v2.service.user: type: object properties: @@ -712,76 +811,95 @@ components: maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the User resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the User resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the User resource is associated with. attributes: type: string nullable: true - description: The JSON string that stores application-specific data + description: The JSON string that stores application-specific data. If attributes + have not been set, `{}` is returned. 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. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Role assigned to the user + description: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) + assigned to the user. identity: type: string nullable: true - description: The string that identifies the resource's User + 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. is_online: type: boolean nullable: true description: Whether the User is actively connected to the Service instance - and online + and online. This value is only returned by Fetch actions that return a + single resource and `null` is always returned by a Read action. This value + is `null` if the Service's `reachability_enabled` is `false`, if the User + has never been online for the Service instance, even if the Service's + `reachability_enabled` is `true`. is_notifiable: type: boolean nullable: true description: Whether the User has a potentially valid Push Notification - registration for the Service instance + registration (APN or GCM) for the Service instance. If at least one registration + exists, `true`; otherwise `false`. This value is only returned by Fetch + actions that return a single resource and `null` is always returned by + a Read action. This value is `null` if the Service's `reachability_enabled` + is `false`, and if the User has never had a notification registration, + even if the Service's `reachability_enabled` is `true`. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. joined_channels_count: type: integer nullable: true - description: The number of Channels the User is a Member of + description: The number of Channels the User is a Member of. links: type: object format: uri-map nullable: true - description: The absolute URLs of the Channel and Binding resources related - to the user + description: The absolute URLs of the [Channel](https://www.twilio.com/docs/chat/channels) + and [Binding](https://www.twilio.com/docs/chat/rest/binding-resource) + resources related to the user. url: type: string format: uri nullable: true - description: The absolute URL of the User resource + description: The absolute URL of the User resource. user_enum_webhook_enabled_type: type: string enum: @@ -796,71 +914,86 @@ components: maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the User Binding + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the User Binding resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the User Binding resource is associated with. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. endpoint: type: string nullable: true - description: The unique endpoint identifier for the User Binding + description: The unique endpoint identifier for the User Binding. The format + of the value depends on the `binding_type`. identity: type: string nullable: true - description: The string that identifies the resource's User + 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. user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The SID of the User with the binding + description: The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) + with the User Binding resource. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + for more info. credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Credential for the binding + description: The SID of the [Credential](https://www.twilio.com/docs/chat/rest/credential-resource) + for the binding. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + for more info. binding_type: type: string $ref: '#/components/schemas/user_binding_enum_binding_type' nullable: true - description: The push technology to use for the binding + description: 'The push technology to use for the User Binding. Can be: `apn`, + `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + for more info.' message_types: type: array items: type: string nullable: true - description: The Programmable Chat message types the binding is subscribed - to + description: The [Programmable Chat message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) + the binding is subscribed to. url: type: string format: uri nullable: true - description: The absolute URL of the User Binding resource + description: The absolute URL of the User Binding resource. user_binding_enum_binding_type: type: string enum: @@ -876,65 +1009,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the User Channel resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the User Channel resource is associated with. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Channel the resource belongs to + description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) + the User Channel resource belongs to. user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The SID of the User the User Channel belongs to + description: The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) + the User Channel belongs to. member_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true - description: The SID of the User as a Member in the Channel + description: The SID of a [Member](https://www.twilio.com/docs/chat/rest/member-resource) + that represents the User on the Channel. status: type: string $ref: '#/components/schemas/user_channel_enum_channel_status' nullable: true - description: The status of the User on the Channel + description: 'The status of the User on the Channel. Can be: `joined`, `invited`, + or `not_participating`.' last_consumed_message_index: type: integer nullable: true - description: The index of the last Message in the Channel the Member has - read + description: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) + in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member + has read. unread_messages_count: type: integer nullable: true - description: The number of unread Messages in the Channel for the User + description: The number of unread Messages in the Channel for the User. + Note that retrieving messages on a client endpoint does not mean that + messages are consumed or read. See [Consumption Horizon feature](https://www.twilio.com/docs/chat/consumption-horizon) + to learn how to mark messages as consumed. links: type: object format: uri-map nullable: true - description: Absolute URLs to access the Members, Messages , Invites and, - if it exists, the last Message for the Channel + description: The absolute URLs of the [Members](https://www.twilio.com/docs/chat/rest/member-resource), + [Messages](https://www.twilio.com/docs/chat/rest/message-resource) , [Invites](https://www.twilio.com/docs/chat/rest/invite-resource) + and, if it exists, the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) + for the Channel. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the User Channel resource. notification_level: type: string $ref: '#/components/schemas/user_channel_enum_notification_level' nullable: true - description: The push notification level of the User for the Channel + description: 'The push notification level of the User for the Channel. Can + be: `default` or `muted`.' user_channel_enum_channel_status: type: string enum: diff --git a/spec/yaml/twilio_chat_v3.yaml b/spec/yaml/twilio_chat_v3.yaml index 0066087a..fefd874e 100644 --- a/spec/yaml/twilio_chat_v3.yaml +++ b/spec/yaml/twilio_chat_v3.yaml @@ -9,75 +9,81 @@ components: maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Channel resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Channel resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the Channel resource is associated with. 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. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used to address the resource in place of the resource's + `sid` in the URL. attributes: type: string nullable: true - description: The JSON string that stores application-specific data + description: The JSON string that stores application-specific data. If attributes + have not been set, `{}` is returned. type: type: string $ref: '#/components/schemas/channel_enum_channel_type' nullable: true - description: 'The visibility of the channel. Can be: `public` or `private`' + description: 'The visibility of the channel. Can be: `public` or `private`.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. created_by: type: string nullable: true - description: The identity of the User that created the channel + description: The `identity` of the User that created the channel. If the + Channel was created by using the API, the value is `system`. members_count: type: integer nullable: true - description: The number of Members in the Channel + description: The number of Members in the Channel. messages_count: type: integer nullable: true - description: The number of Messages that have been passed in the Channel + description: The number of Messages that have been passed in the Channel. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Messaging Service this channel belongs - to. + description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + this channel belongs to. url: type: string format: uri nullable: true - description: The absolute URL of the Channel resource + description: The absolute URL of the Channel resource. channel_enum_channel_type: type: string enum: diff --git a/spec/yaml/twilio_content_v1.yaml b/spec/yaml/twilio_content_v1.yaml index 56567edd..75fb9b65 100644 --- a/spec/yaml/twilio_content_v1.yaml +++ b/spec/yaml/twilio_content_v1.yaml @@ -9,23 +9,26 @@ components: maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Content resource + 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 that created the Content resource + 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 + 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` + description: The URL of the resource, relative to `https://content.twilio.com`. content.v1.content: type: object properties: @@ -33,53 +36,59 @@ components: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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 identifies the resource + 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 that created the resource + 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 + description: A string name used to describe the Content resource. Not visible + to the end recipient. language: type: string nullable: true - description: Two-letter language code identifying the language the Content - resource is in. + 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 + 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 (e.g. twilio/text) for this Content resource + 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` + 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 + description: A list of links related to the Content resource, such as approval_fetch + and approval_create securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_conversations_v1.yaml b/spec/yaml/twilio_conversations_v1.yaml index 28e177fa..ad3a2a71 100644 --- a/spec/yaml/twilio_conversations_v1.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -9,43 +9,45 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account responsible for this configuration. + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this configuration. default_chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the default Conversation Service that every new - conversation is associated with. + description: The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + used when creating a conversation. default_messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the default Messaging Service that every new conversation - is associated with. + description: The SID of the default [Messaging Service](https://www.twilio.com/docs/sms/services/api) + used when creating a conversation. default_inactive_timer: type: string nullable: true description: Default ISO8601 duration when conversation will be switched - to `inactive` state. + to `inactive` state. Minimum value for this timer is 1 minute. default_closed_timer: type: string nullable: true description: Default ISO8601 duration when conversation will be switched - to `closed` state. + to `closed` state. Minimum value for this timer is 10 minutes. url: type: string format: uri nullable: true - description: An absolute URL for this global configuration. + description: An absolute API resource URL for this global configuration. links: type: object format: uri-map nullable: true - description: Absolute URLs to access the webhook and default service configurations. + description: Contains absolute API resource URLs to access the webhook and + default service configurations. conversations.v1.configuration_address: type: object properties: @@ -62,19 +64,22 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account the address belongs to. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + the address belongs to type: type: string nullable: true - description: Type of Address. + description: Type of Address, value can be `whatsapp` or `sms`. address: type: string nullable: true - description: The unique address to be configured. + description: The unique address to be configured. The address can be a whatsapp + address or phone number friendly_name: type: string nullable: true - description: The human-readable name of this configuration. + description: The human-readable name of this configuration, limited to 256 + characters. Optional. auto_creation: nullable: true description: Auto Creation configuration for the address. @@ -92,7 +97,7 @@ components: type: string format: uri nullable: true - description: An absolute URL for this address configuration. + description: An absolute API resource URL for this address configuration. configuration_address_enum_type: type: string enum: @@ -120,7 +125,8 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this conversation. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this conversation. method: type: string $ref: '#/components/schemas/configuration_webhook_enum_method' @@ -131,8 +137,10 @@ components: items: type: string nullable: true - description: The list of webhook event triggers that are enabled for this - Service. + description: 'The list of webhook event triggers that are enabled for this + Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, + `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, + `onParticipantRemoved`' pre_webhook_url: type: string nullable: true @@ -147,12 +155,13 @@ components: type: string $ref: '#/components/schemas/configuration_webhook_enum_target' nullable: true - description: The routing target of the webhook. + description: The routing target of the webhook. Can be ordinary or route + internally to Flex url: type: string format: uri nullable: true - description: An absolute URL for this webhook. + description: An absolute API resource API resource URL for this webhook. configuration_webhook_enum_target: type: string enum: @@ -172,23 +181,24 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this conversation. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation Service this conversation - belongs to. + description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + this conversation belongs to. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Messaging Service this conversation belongs - to. + description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + this conversation belongs to. sid: type: string minLength: 34 @@ -199,22 +209,26 @@ components: friendly_name: type: string nullable: true - description: The human-readable name of this conversation. + description: The human-readable name of this conversation, limited to 256 + characters. Optional. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used to address the resource in place of the resource's + `sid` in the URL. attributes: type: string nullable: true description: An optional string metadata field you can use to store any - data you wish. + data you wish. The string value must contain structurally valid JSON if + specified. **Note** that if the attributes are not set "{}" will be returned. state: type: string $ref: '#/components/schemas/conversation_enum_state' nullable: true - description: Current state of this conversation. + description: Current state of this conversation. Can be either `active`, + `inactive` or `closed` and defaults to `active` date_created: type: string format: date-time @@ -227,17 +241,19 @@ components: description: The date that this resource was last updated. timers: nullable: true - description: Timer date values for this conversation. + description: Timer date values representing state update for this conversation. url: type: string format: uri nullable: true - description: An absolute URL for this conversation. + description: An absolute API resource URL for this conversation. links: type: object format: uri-map nullable: true - description: Absolute URLs to access the participants, messages and webhooks + description: Contains absolute URLs to access the [participants](https://www.twilio.com/docs/conversations/api/conversation-participant-resource), + [messages](https://www.twilio.com/docs/conversations/api/conversation-message-resource) + and [webhooks](https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource) of this conversation. bindings: nullable: true @@ -261,14 +277,16 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this message. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this message. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation for this message. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + for this message. sid: type: string minLength: 34 @@ -279,32 +297,41 @@ components: index: type: integer nullable: true - description: The index of the message within the Conversation. + description: The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource). Indices + may skip numbers, but will always be in order of when the message was + received. author: type: string nullable: true - description: The channel specific identifier of the message's author. + description: The channel specific identifier of the message's author. Defaults + to `system`. body: type: string nullable: true - description: The content of the message. + description: The content of the message, can be up to 1,600 characters long. media: type: array items: {} nullable: true - description: An array of objects that describe the Message's media if attached, - otherwise, 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`.' 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. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of messages's author participant. + description: The unique ID of messages's author participant. Null in case + of `system` sent message. date_created: type: string format: date-time @@ -314,12 +341,13 @@ components: type: string format: date-time nullable: true - description: The date that this resource was last updated. + description: The date that this resource was last updated. `null` if the + message has not been edited. url: type: string format: uri nullable: true - description: An absolute API URL for this message. + description: An absolute API resource API URL for this message. delivery: nullable: true description: An object that contains the summary of delivery statuses for @@ -328,14 +356,16 @@ components: type: object format: uri-map nullable: true - description: Absolute URL to access the receipts of this message. + description: Contains an absolute API resource URL to access the delivery + & read receipts of this message. content_sid: type: string minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the multi-channel Rich Content template. + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) + template. conversation_message_enum_order_type: type: string enum: @@ -355,14 +385,16 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this participant. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this participant. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation for this message. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + for this message. sid: type: string minLength: 34 @@ -376,15 +408,16 @@ components: maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ nullable: true - description: The SID of the message the delivery receipt belongs to + description: The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + the delivery receipt belongs to channel_message_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: A messaging channel-specific identifier for the message delivered - to participant + description: 'A messaging channel-specific identifier for the message delivered + to participant e.g. `SMxx` for SMS, `WAxx` for Whatsapp etc. ' participant_sid: type: string minLength: 34 @@ -397,12 +430,13 @@ components: type: string $ref: '#/components/schemas/conversation_message_receipt_enum_delivery_status' nullable: true - description: The message delivery status + description: The message delivery status, can be `read`, `failed`, `delivered`, + `undelivered`, `sent` or null. error_code: type: integer nullable: true - description: The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) - for a `failed` status + description: 'The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) + for a `failed` status, ' date_created: type: string format: date-time @@ -412,12 +446,13 @@ components: type: string format: date-time nullable: true - description: The date that this resource was last updated. + description: The date that this resource was last updated. `null` if the + delivery receipt has not been updated. url: type: string format: uri nullable: true - description: An absolute URL for this delivery receipt. + description: An absolute API resource URL for this delivery receipt. conversation_message_receipt_enum_delivery_status: type: string enum: @@ -435,14 +470,16 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this participant. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this participant. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation for this participant. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + for this participant. sid: type: string minLength: 34 @@ -454,23 +491,28 @@ components: type: string nullable: true description: A unique string identifier for the conversation participant - as Conversation User. + 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. attributes: type: string nullable: true description: An optional string metadata field you can use to store any - data you wish. + data you wish. The string value must contain structurally valid JSON if + specified. **Note** that if the attributes are not set "{}" will be returned. messaging_binding: nullable: true description: Information about how this participant exchanges messages with - the conversation. + the conversation. A JSON parameter consisting of type and address fields + of the participant. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The SID of a conversation-level Role to assign to the participant + description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) + to assign to the participant. date_created: type: string format: date-time @@ -485,16 +527,16 @@ components: type: string format: uri nullable: true - description: An absolute URL for this participant. + description: An absolute API resource URL for this participant. last_read_message_index: type: integer nullable: true - description: "Index of last \u201Cread\u201D message in the Conversation\ + description: "Index of last \u201Cread\u201D message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." last_read_timestamp: type: string nullable: true - description: "Timestamp of last \u201Cread\u201D message in the Conversation\ + description: "Timestamp of last \u201Cread\u201D message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." conversation_participant_enum_webhook_enabled_type: type: string @@ -517,26 +559,28 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this conversation. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this conversation. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation for this webhook. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + for this webhook. target: type: string nullable: true - description: The target of this webhook. + description: 'The target of this webhook: `webhook`, `studio`, `trigger`' url: type: string format: uri nullable: true - description: An absolute URL for this webhook. + description: An absolute API resource URL for this webhook. configuration: nullable: true - description: The configuration of this webhook. + description: The configuration of this webhook. Is defined based on target. date_created: type: string format: date-time @@ -574,20 +618,24 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this credential. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this credential. friendly_name: type: string nullable: true - description: The human-readable name of this credential. + description: The human-readable name of this credential, limited to 64 characters. + Optional. type: type: string $ref: '#/components/schemas/credential_enum_push_type' nullable: true - description: The type of push-notification service the credential is for. + description: 'The type of push-notification service the credential is for. + Can be: `fcm`, `gcm`, or `apn`.' sandbox: type: string nullable: true - description: '[APN only] Whether to send the credential to sandbox APNs.' + description: '[APN only] Whether to send the credential to sandbox APNs. + Can be `true` to send to sandbox APNs or `false` to send to production.' date_created: type: string format: date-time @@ -602,7 +650,7 @@ components: type: string format: uri nullable: true - description: An absolute URL for this credential. + description: An absolute API resource URL for this credential. credential_enum_push_type: type: string enum: @@ -618,89 +666,99 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this conversation. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation Service this conversation - belongs to. + description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + this conversation belongs to. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Participant. + description: The unique ID of the [Participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource). participant_user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The unique ID for the conversation participant as Conversation - User. + description: The unique string that identifies the conversation participant + as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). participant_identity: type: string nullable: true description: A unique string identifier for the conversation participant - as Conversation User. + 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. participant_messaging_binding: nullable: true description: Information about how this participant exchanges messages with - the conversation. + the conversation. A JSON parameter consisting of type and address fields + of the participant. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation this Participant belongs - to. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + this Participant belongs to. conversation_unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - Conversation resource + Conversation resource. conversation_friendly_name: type: string nullable: true - description: The human-readable name of this conversation. + description: The human-readable name of this conversation, limited to 256 + characters. Optional. conversation_attributes: type: string nullable: true description: An optional string metadata field you can use to store any - data you wish. + data you wish. The string value must contain structurally valid JSON if + specified. **Note** that if the attributes are not set "{}" will be returned. conversation_date_created: type: string format: date-time nullable: true - description: The date that this conversation was created. + description: The date that this conversation was created, given in ISO 8601 + format. conversation_date_updated: type: string format: date-time nullable: true - description: The date that this conversation was last updated. + description: The date that this conversation was last updated, given in + ISO 8601 format. conversation_created_by: type: string nullable: true - description: Creator of this conversation. + description: Identity of the creator of this Conversation. conversation_state: type: string $ref: '#/components/schemas/participant_conversation_enum_state' nullable: true - description: The current state of this User Conversation + description: The current state of this User Conversation. One of `inactive`, + `active` or `closed`. conversation_timers: nullable: true - description: Timer date values for this conversation. + description: Timer date values representing state update for this conversation. links: type: object format: uri-map nullable: true - description: Absolute URLs to access the participant and conversation of - this Participant Conversation. + description: Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) + and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + of this conversation. participant_conversation_enum_state: type: string enum: @@ -716,53 +774,57 @@ components: maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Role resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Role resource. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Conversation Service that the resource is associated - with + description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + the Role resource is associated with. 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. type: type: string $ref: '#/components/schemas/role_enum_role_type' nullable: true - description: The type of role + description: 'The type of role. Can be: `conversation` for [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + roles or `service` for [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + roles.' permissions: type: array items: type: string nullable: true - description: An array of the permissions the role has been granted + description: An array of the permissions the role has been granted. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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: An absolute URL for this user role. + description: An absolute API resource URL for this user role. role_enum_role_type: type: string enum: @@ -777,7 +839,8 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this service. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this service. sid: type: string minLength: 34 @@ -788,7 +851,8 @@ components: friendly_name: type: string nullable: true - description: The human-readable name of this service. + description: The human-readable name of this service, limited to 256 characters. + Optional. date_created: type: string format: date-time @@ -803,13 +867,13 @@ components: type: string format: uri nullable: true - description: An absolute URL for this service. + description: An absolute API resource URL for this service. links: type: object format: uri-map nullable: true - description: Absolute URLs to access the conversations, users, roles, bindings - and configuration of this service. + description: Contains absolute API resource URLs to access conversations, + users, roles, bindings and configuration of this service. conversations.v1.service.service_binding: type: object properties: @@ -826,22 +890,25 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this binding. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this binding. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Conversation Service that the resource is associated - with. + description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + the Binding resource is associated with. credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Credential for the binding. + description: The SID of the [Credential](https://www.twilio.com/docs/conversations/api/credential-resource) + for the binding. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + for more info. date_created: type: string format: date-time @@ -855,27 +922,35 @@ components: endpoint: type: string nullable: true - description: The unique endpoint identifier for the Binding. + description: The unique endpoint identifier for the Binding. The format + of this value depends on the `binding_type`. identity: type: string nullable: true - description: The identity of Conversation User associated with this binding. + 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. binding_type: type: string $ref: '#/components/schemas/service_binding_enum_binding_type' nullable: true - description: The push technology to use for the binding. + description: 'The push technology to use for the Binding. Can be: `apn`, + `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) + for more info.' message_types: type: array items: type: string nullable: true - description: The Conversation message types the binding is subscribed to. + description: The [Conversation message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) + the binding is subscribed to. url: type: string format: uri nullable: true - description: An absolute URL for this binding. + description: An absolute API resource URL for this binding. service_binding_enum_binding_type: type: string enum: @@ -891,46 +966,51 @@ components: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Service configuration + resource. default_conversation_creator_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The role assigned to a conversation creator user when they - join a new conversation + 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. default_conversation_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The role assigned to users when they are added to a conversation + 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. default_chat_service_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The service role assigned to users when they are added to the - service + 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. url: type: string format: uri nullable: true - description: An absolute URL for this service configuration. + description: An absolute API resource URL for this service configuration. links: type: object format: uri-map nullable: true - description: Absolute URL to access the push notifications configuration - of this service. + description: Contains an absolute API resource URL to access the push notifications + configuration of this service. reachability_enabled: type: boolean nullable: true - description: Whether the Reachability Indicator feature is enabled for this - Conversations Service + description: Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) + is enabled for this Conversations Service. The default is `false`. conversations.v1.service.service_conversation: type: object properties: @@ -940,23 +1020,24 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this conversation. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation Service this conversation - belongs to. + description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + this conversation belongs to. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Messaging Service this conversation belongs - to. + description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) + this conversation belongs to. sid: type: string minLength: 34 @@ -967,22 +1048,26 @@ components: friendly_name: type: string nullable: true - description: The human-readable name of this conversation. + description: The human-readable name of this conversation, limited to 256 + characters. Optional. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used to address the resource in place of the resource's + `sid` in the URL. attributes: type: string nullable: true description: An optional string metadata field you can use to store any - data you wish. + data you wish. The string value must contain structurally valid JSON if + specified. **Note** that if the attributes are not set "{}" will be returned. state: type: string $ref: '#/components/schemas/service_conversation_enum_state' nullable: true - description: Current state of this conversation. + description: Current state of this conversation. Can be either `active`, + `inactive` or `closed` and defaults to `active` date_created: type: string format: date-time @@ -995,17 +1080,19 @@ components: description: The date that this resource was last updated. timers: nullable: true - description: Timer date values for this conversation. + description: Timer date values representing state update for this conversation. url: type: string format: uri nullable: true - description: An absolute URL for this conversation. + description: An absolute API resource URL for this conversation. links: type: object format: uri-map nullable: true - description: Absolute URLs to access the participants, messages and webhooks + description: Contains absolute URLs to access the [participants](https://www.twilio.com/docs/conversations/api/conversation-participant-resource), + [messages](https://www.twilio.com/docs/conversations/api/conversation-message-resource) + and [webhooks](https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource) of this conversation. bindings: nullable: true @@ -1029,22 +1116,24 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this message. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this message. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Conversation Service that the resource is associated - with. + description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + the Participant resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation for this message. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + for this message. sid: type: string minLength: 34 @@ -1055,32 +1144,39 @@ components: index: type: integer nullable: true - description: The index of the message within the Conversation. + description: The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource). author: type: string nullable: true - description: The channel specific identifier of the message's author. + description: The channel specific identifier of the message's author. Defaults + to `system`. body: type: string nullable: true - description: The content of the message. + description: The content of the message, can be up to 1,600 characters long. media: type: array items: {} nullable: true - description: An array of objects that describe the Message's media if attached, - otherwise, 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`.' 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. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of messages's author participant. + description: The unique ID of messages's author participant. Null in case + of `system` sent message. date_created: type: string format: date-time @@ -1090,7 +1186,8 @@ components: type: string format: date-time nullable: true - description: The date that this resource was last updated. + description: The date that this resource was last updated. `null` if the + message has not been edited. delivery: nullable: true description: An object that contains the summary of delivery statuses for @@ -1099,19 +1196,21 @@ components: type: string format: uri nullable: true - description: An absolute URL for this message. + description: An absolute API resource URL for this message. links: type: object format: uri-map nullable: true - description: Absolute URL to access the receipts of this message. + description: Contains an absolute API resource URL to access the delivery + & read receipts of this message. content_sid: type: string minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the multi-channel Rich Content template. + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) + template. service_conversation_message_enum_order_type: type: string enum: @@ -1131,29 +1230,32 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this participant. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this participant. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Conversation Service that the resource is associated - with. + description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + the Message resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation for this message. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + for this message. message_sid: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ nullable: true - description: The SID of the message the delivery receipt belongs to + description: The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + the delivery receipt belongs to sid: type: string minLength: 34 @@ -1167,8 +1269,8 @@ components: maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: A messaging channel-specific identifier for the message delivered - to participant + description: 'A messaging channel-specific identifier for the message delivered + to participant e.g. `SMxx` for SMS, `WAxx` for Whatsapp etc. ' participant_sid: type: string minLength: 34 @@ -1181,12 +1283,13 @@ components: type: string $ref: '#/components/schemas/service_conversation_message_receipt_enum_delivery_status' nullable: true - description: The message delivery status + description: The message delivery status, can be `read`, `failed`, `delivered`, + `undelivered`, `sent` or null. error_code: type: integer nullable: true - description: The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) - for a `failed` status + description: 'The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) + for a `failed` status, ' date_created: type: string format: date-time @@ -1196,12 +1299,13 @@ components: type: string format: date-time nullable: true - description: The date that this resource was last updated. + description: The date that this resource was last updated. `null` if the + delivery receipt has not been updated. url: type: string format: uri nullable: true - description: An absolute URL for this delivery receipt. + description: An absolute API resource URL for this delivery receipt. service_conversation_message_receipt_enum_delivery_status: type: string enum: @@ -1219,22 +1323,24 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this participant. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this participant. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Conversation Service that the resource is associated - with. + description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + the Participant resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation for this participant. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + for this participant. sid: type: string minLength: 34 @@ -1246,23 +1352,28 @@ components: type: string nullable: true description: A unique string identifier for the conversation participant - as Conversation User. + 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. attributes: type: string nullable: true description: An optional string metadata field you can use to store any - data you wish. + data you wish. The string value must contain structurally valid JSON if + specified. **Note** that if the attributes are not set "{}" will be returned. messaging_binding: nullable: true description: Information about how this participant exchanges messages with - the conversation. + the conversation. A JSON parameter consisting of type and address fields + of the participant. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The SID of a conversation-level Role to assign to the participant + description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) + to assign to the participant. date_created: type: string format: date-time @@ -1277,16 +1388,16 @@ components: type: string format: uri nullable: true - description: An absolute URL for this participant. + description: An absolute API resource URL for this participant. last_read_message_index: type: integer nullable: true - description: "Index of last \u201Cread\u201D message in the Conversation\ + description: "Index of last \u201Cread\u201D message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." last_read_timestamp: type: string nullable: true - description: "Timestamp of last \u201Cread\u201D message in the Conversation\ + description: "Timestamp of last \u201Cread\u201D message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." service_conversation_participant_enum_webhook_enabled_type: type: string @@ -1309,34 +1420,36 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this conversation. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Conversation Service that the resource is associated - with. + description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + the Participant resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation for this webhook. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + for this webhook. target: type: string nullable: true - description: The target of this webhook. + description: 'The target of this webhook: `webhook`, `studio`, `trigger`' url: type: string format: uri nullable: true - description: An absolute URL for this webhook. + description: An absolute API resource URL for this webhook. configuration: nullable: true - description: The configuration of this webhook. + description: The configuration of this webhook. Is defined based on target. date_created: type: string format: date-time @@ -1367,15 +1480,16 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this configuration. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this configuration. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Conversation Service that the Configuration - applies to. + description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + the Configuration applies to. new_message: nullable: true description: The Push Notification configuration for New Messages. @@ -1394,7 +1508,7 @@ components: type: string format: uri nullable: true - description: An absolute URL for this configuration. + description: An absolute API resource URL for this configuration. conversations.v1.service.service_participant_conversation: type: object properties: @@ -1404,47 +1518,51 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this conversation. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation Service this conversation - belongs to. + description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + this conversation belongs to. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Participant. + description: The unique ID of the [Participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource). participant_user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The unique ID for the conversation participant as Conversation - User. + description: The unique string that identifies the conversation participant + as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). participant_identity: type: string nullable: true description: A unique string identifier for the conversation participant - as Conversation User. + 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. participant_messaging_binding: nullable: true description: Information about how this participant exchanges messages with - the conversation. + the conversation. A JSON parameter consisting of type and address fields + of the participant. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation this Participant belongs - to. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + this Participant belongs to. conversation_unique_name: type: string nullable: true @@ -1453,40 +1571,46 @@ components: conversation_friendly_name: type: string nullable: true - description: The human-readable name of this conversation. + description: The human-readable name of this conversation, limited to 256 + characters. Optional. conversation_attributes: type: string nullable: true description: An optional string metadata field you can use to store any - data you wish. + data you wish. The string value must contain structurally valid JSON if + specified. **Note** that if the attributes are not set "{}" will be returned. conversation_date_created: type: string format: date-time nullable: true - description: The date that this conversation was created. + description: The date that this conversation was created, given in ISO 8601 + format. conversation_date_updated: type: string format: date-time nullable: true - description: The date that this conversation was last updated. + description: The date that this conversation was last updated, given in + ISO 8601 format. conversation_created_by: type: string nullable: true - description: Creator of this conversation. + description: Identity of the creator of this Conversation. conversation_state: type: string $ref: '#/components/schemas/service_participant_conversation_enum_state' nullable: true - description: The current state of this User Conversation + description: The current state of this User Conversation. One of `inactive`, + `active` or `closed`. conversation_timers: nullable: true - description: Timer date values for this conversation. + description: Timer date values representing state update for this conversation. links: type: object format: uri-map nullable: true - description: Absolute URLs to access the participant and conversation of - this Participant Conversation. + description: Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) + and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + of this conversation. service_participant_conversation_enum_state: type: string enum: @@ -1502,53 +1626,57 @@ components: maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Role resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Role resource. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Conversation Service that the resource is associated - with + description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + the Role resource is associated with. 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. type: type: string $ref: '#/components/schemas/service_role_enum_role_type' nullable: true - description: The type of role + description: 'The type of role. Can be: `conversation` for [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + roles or `service` for [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + roles.' permissions: type: array items: type: string nullable: true - description: An array of the permissions the role has been granted + description: An array of the permissions the role has been granted. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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: An absolute URL for this user role. + description: An absolute API resource URL for this user role. service_role_enum_role_type: type: string enum: @@ -1563,67 +1691,82 @@ components: maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the User resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the User resource. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Conversation Service that the resource is associated - with + description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + the User resource is associated with. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The SID of a service-level Role assigned to the user + description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) + assigned to the user. identity: type: string nullable: true - description: The string that identifies the resource's User + 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. 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. attributes: type: string nullable: true - description: The JSON Object string that stores application-specific data + description: The JSON Object string that stores application-specific data. + If attributes have not been set, `{}` is returned. is_online: type: boolean nullable: true description: Whether the User is actively connected to this Conversations - Service and online + Service and online. This value is only returned by Fetch actions that + return a single resource and `null` is always returned by a Read action. + This value is `null` if the Service's `reachability_enabled` is `false`, + if the User has never been online for this Conversations Service, even + if the Service's `reachability_enabled` is `true`. is_notifiable: type: boolean nullable: true description: Whether the User has a potentially valid Push Notification - registration for this Conversations Service + registration (APN or GCM) for this Conversations Service. If at least + one registration exists, `true`; otherwise `false`. This value is only + returned by Fetch actions that return a single resource and `null` is + always returned by a Read action. This value is `null` if the Service's + `reachability_enabled` is `false`, and if the User has never had a notification + registration, even if the Service's `reachability_enabled` is `true`. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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: An absolute URL for this user. + description: An absolute API resource URL for this user. links: type: object format: uri-map @@ -1642,85 +1785,96 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this conversation. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation Service this conversation - belongs to. + description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + this conversation belongs to. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation for this User Conversation. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + for this User Conversation. unread_messages_count: type: integer nullable: true - description: The number of unread Messages in the Conversation. + description: The number of unread Messages in the Conversation for the Participant. last_read_message_index: type: integer nullable: true - description: The index of the last read Message . + description: The index of the last Message in the Conversation that the + Participant has read. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true - description: Participant Sid. + description: The unique ID of the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) + the user conversation belongs to. user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The unique ID for the User. + description: The unique string that identifies the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). friendly_name: type: string nullable: true - description: The human-readable name of this conversation. + description: The human-readable name of this conversation, limited to 256 + characters. Optional. conversation_state: type: string $ref: '#/components/schemas/service_user_conversation_enum_state' nullable: true - description: The current state of this User Conversation + description: The current state of this User Conversation. One of `inactive`, + `active` or `closed`. timers: nullable: true - description: Timer date values for this conversation. + description: Timer date values representing state update for this conversation. attributes: type: string nullable: true description: An optional string metadata field you can use to store any - data you wish. + data you wish. The string value must contain structurally valid JSON if + specified. **Note** that if the attributes are not set "{}" will be returned. date_created: type: string format: date-time nullable: true - description: The date that this conversation was created. + description: The date that this conversation was created, given in ISO 8601 + format. date_updated: type: string format: date-time nullable: true - description: The date that this conversation was last updated. + description: The date that this conversation was last updated, given in + ISO 8601 format. created_by: type: string nullable: true - description: Creator of this conversation. + description: Identity of the creator of this Conversation. notification_level: type: string $ref: '#/components/schemas/service_user_conversation_enum_notification_level' nullable: true - description: The Notification Level of this User Conversation. + description: The Notification Level of this User Conversation. One of `default` + or `muted`. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - Conversation resource. + Conversation resource. It can be used to address the resource in place + of the resource's `conversation_sid` in the URL. url: type: string format: uri @@ -1729,8 +1883,9 @@ components: type: object format: uri-map nullable: true - description: Absolute URLs to access the participant and conversation of - this user conversation. + description: Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) + and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + of this conversation. service_user_conversation_enum_notification_level: type: string enum: @@ -1751,7 +1906,8 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this service. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this service. chat_service_sid: type: string minLength: 34 @@ -1778,17 +1934,24 @@ components: type: string nullable: true description: The list of events that your configured webhook targets will - receive. Events not configured here will not fire. + receive. Events not configured here will not fire. Possible values are + `onParticipantAdd`, `onParticipantAdded`, `onDeliveryUpdated`, `onConversationUpdated`, + `onConversationRemove`, `onParticipantRemove`, `onConversationUpdate`, + `onMessageAdd`, `onMessageRemoved`, `onParticipantUpdated`, `onConversationAdded`, + `onMessageAdded`, `onConversationAdd`, `onConversationRemoved`, `onParticipantUpdate`, + `onMessageRemove`, `onMessageUpdated`, `onParticipantRemoved`, `onMessageUpdate` + or `onConversationStateUpdated`. method: type: string $ref: '#/components/schemas/service_webhook_configuration_enum_method' nullable: true - description: The HTTP method to be used when sending a webhook request + description: The HTTP method to be used when sending a webhook request. + One of `GET` or `POST`. url: type: string format: uri nullable: true - description: An absolute URL for this webhook. + description: An absolute API resource URL for this webhook. service_webhook_configuration_enum_method: type: string enum: @@ -1803,67 +1966,82 @@ components: maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the User resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the User resource. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Conversation Service that the resource is associated - with + description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + the User resource is associated with. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true - description: The SID of a service-level Role assigned to the user + description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) + assigned to the user. identity: type: string nullable: true - description: The string that identifies the resource's User + 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. 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. attributes: type: string nullable: true - description: The JSON Object string that stores application-specific data + description: The JSON Object string that stores application-specific data. + If attributes have not been set, `{}` is returned. is_online: type: boolean nullable: true description: Whether the User is actively connected to this Conversations - Service and online + Service and online. This value is only returned by Fetch actions that + return a single resource and `null` is always returned by a Read action. + This value is `null` if the Service's `reachability_enabled` is `false`, + if the User has never been online for this Conversations Service, even + if the Service's `reachability_enabled` is `true`. is_notifiable: type: boolean nullable: true description: Whether the User has a potentially valid Push Notification - registration for this Conversations Service + registration (APN or GCM) for this Conversations Service. If at least + one registration exists, `true`; otherwise `false`. This value is only + returned by Fetch actions that return a single resource and `null` is + always returned by a Read action. This value is `null` if the Service's + `reachability_enabled` is `false`, and if the User has never had a notification + registration, even if the Service's `reachability_enabled` is `true`. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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: An absolute URL for this user. + description: An absolute API resource URL for this user. links: type: object format: uri-map @@ -1882,85 +2060,96 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account responsible for this conversation. + description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) + responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation Service this conversation - belongs to. + description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) + this conversation belongs to. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Conversation for this User Conversation. + description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + for this User Conversation. unread_messages_count: type: integer nullable: true - description: The number of unread Messages in the Conversation. + description: The number of unread Messages in the Conversation for the Participant. last_read_message_index: type: integer nullable: true - description: The index of the last read Message . + description: The index of the last Message in the Conversation that the + Participant has read. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true - description: Participant Sid. + description: The unique ID of the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) + the user conversation belongs to. user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The unique ID for the User. + description: The unique string that identifies the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). friendly_name: type: string nullable: true - description: The human-readable name of this conversation. + description: The human-readable name of this conversation, limited to 256 + characters. Optional. conversation_state: type: string $ref: '#/components/schemas/user_conversation_enum_state' nullable: true - description: The current state of this User Conversation + description: The current state of this User Conversation. One of `inactive`, + `active` or `closed`. timers: nullable: true - description: Timer date values for this conversation. + description: Timer date values representing state update for this conversation. attributes: type: string nullable: true description: An optional string metadata field you can use to store any - data you wish. + data you wish. The string value must contain structurally valid JSON if + specified. **Note** that if the attributes are not set "{}" will be returned. date_created: type: string format: date-time nullable: true - description: The date that this conversation was created. + description: The date that this conversation was created, given in ISO 8601 + format. date_updated: type: string format: date-time nullable: true - description: The date that this conversation was last updated. + description: The date that this conversation was last updated, given in + ISO 8601 format. created_by: type: string nullable: true - description: Creator of this conversation. + description: Identity of the creator of this Conversation. notification_level: type: string $ref: '#/components/schemas/user_conversation_enum_notification_level' nullable: true - description: The Notification Level of this User Conversation. + description: The Notification Level of this User Conversation. One of `default` + or `muted`. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - Conversation resource. + Conversation resource. It can be used to address the resource in place + of the resource's `conversation_sid` in the URL. url: type: string format: uri @@ -1969,8 +2158,9 @@ components: type: object format: uri-map nullable: true - description: Absolute URLs to access the participant and conversation of - this user conversation. + description: Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) + and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + of this conversation. user_conversation_enum_notification_level: type: string enum: diff --git a/spec/yaml/twilio_events_v1.yaml b/spec/yaml/twilio_events_v1.yaml index 15c3b8a4..a5b611c2 100644 --- a/spec/yaml/twilio_events_v1.yaml +++ b/spec/yaml/twilio_events_v1.yaml @@ -6,25 +6,28 @@ components: type: type: string nullable: true - description: The Event Type identifier. + description: A string that uniquely identifies this Event Type. schema_id: type: string nullable: true - description: The Schema identifier for this Event Type. + description: A string that uniquely identifies the Schema this Event Type + adheres to. date_created: type: string format: date-time nullable: true - description: The date this Event Type was created. + description: The date that this Event Type was created, given in ISO 8601 + format. date_updated: type: string format: date-time nullable: true - description: The date this Event Type was updated. + description: The date that this Event Type was updated, given in ISO 8601 + format. description: type: string nullable: true - description: Event Type description. + description: A human readable description for this Event Type. url: type: string format: uri @@ -40,7 +43,8 @@ components: id: type: string nullable: true - description: Schema Identifier. + description: The unique identifier of the schema. Each schema can have multiple + versions, that share the same id. url: type: string format: uri @@ -50,23 +54,26 @@ components: type: object format: uri-map nullable: true - description: Nested resource URLs. + description: Contains a dictionary of URL links to nested resources of this + schema. latest_version_date_created: type: string format: date-time nullable: true - description: The date that the latest schema version was created. + description: The date that the latest schema version was created, given + in ISO 8601 format. latest_version: type: integer nullable: true - description: Latest schema version. + description: The latest version published of this schema. events.v1.schema.schema_version: type: object properties: id: type: string nullable: true - description: The unique identifier of the schema. + description: The unique identifier of the schema. Each schema can have multiple + versions, that share the same id. schema_version: type: integer nullable: true @@ -75,7 +82,8 @@ components: type: string format: date-time nullable: true - description: The date the schema version was created. + description: The date the schema version was created, given in ISO 8601 + format. url: type: string format: uri @@ -92,36 +100,38 @@ components: type: string format: date-time nullable: true - description: The date this Sink was created + description: The date that this Sink was created, given in ISO 8601 format. date_updated: type: string format: date-time nullable: true - description: The date this Sink was updated + description: The date that this Sink was updated, given in ISO 8601 format. description: type: string nullable: true - description: Sink Description + description: A human readable description for the Sink sid: type: string minLength: 34 maxLength: 34 pattern: ^DG[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Sink. + description: A 34 character string that uniquely identifies this Sink. sink_configuration: nullable: true - description: JSON Sink configuration. + description: The information required for Twilio to connect to the provided + Sink encoded as JSON. sink_type: type: string $ref: '#/components/schemas/sink_enum_sink_type' nullable: true - description: Sink type. + description: The Sink type. Can only be "kinesis" or "webhook" currently. status: type: string $ref: '#/components/schemas/sink_enum_status' nullable: true - description: The Status of this Sink + description: The Status of this Sink. One of `initialized`, `validating`, + `active` or `failed`. url: type: string format: uri @@ -131,7 +141,8 @@ components: type: object format: uri-map nullable: true - description: Nested resource URLs. + description: Contains a dictionary of URL links to nested resources of this + Sink. sink_enum_status: type: string enum: @@ -168,7 +179,7 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account SID. + description: The unique SID identifier of the Account. type: type: string nullable: true @@ -183,7 +194,7 @@ components: maxLength: 34 pattern: ^DF[0-9a-fA-F]{32}$ nullable: true - description: Subscription SID. + description: The unique SID identifier of the Subscription. url: type: string format: uri @@ -198,35 +209,38 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account SID. + description: The unique SID identifier of the Account. sid: type: string minLength: 34 maxLength: 34 pattern: ^DF[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Subscription. + description: A 34 character string that uniquely identifies this Subscription. date_created: type: string format: date-time nullable: true - description: The date this Subscription was created + description: The date that this Subscription was created, given in ISO 8601 + format. date_updated: type: string format: date-time nullable: true - description: The date this Subscription was updated + description: The date that this Subscription was updated, given in ISO 8601 + format. description: type: string nullable: true - description: Subscription description + description: A human readable description for the Subscription sink_sid: type: string minLength: 34 maxLength: 34 pattern: ^DG[0-9a-fA-F]{32}$ nullable: true - description: Sink SID. + 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. url: type: string format: uri @@ -236,7 +250,8 @@ components: type: object format: uri-map nullable: true - description: Nested resource URLs. + description: Contains a dictionary of URL links to nested resources of this + Subscription. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_flex_v1.yaml b/spec/yaml/twilio_flex_v1.yaml index 5021c73c..086a00c9 100644 --- a/spec/yaml/twilio_flex_v1.yaml +++ b/spec/yaml/twilio_flex_v1.yaml @@ -17,53 +17,55 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource and owns this - Workflow + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Channel 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 + 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 identifies the resource + description: The unique string that we created to identify the Channel resource. user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The SID of the chat user + description: The SID of the chat user. task_sid: type: string minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ nullable: true - description: The SID of the TaskRouter Task + description: The SID of the TaskRouter Task. Only valid when integration + type is `task`. `null` for integration types `studio` & `external` url: type: string format: uri nullable: true - description: The absolute URL of the Flex chat channel resource + description: The absolute URL of the Flex chat channel resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Flex chat channel - was created + description: The date and time in GMT when the Flex chat channel 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 ISO 8601 date and time in GMT when the Flex chat channel - was last updated + description: The date and time in GMT when the Flex chat channel was last + updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. flex.v1.configuration: type: object properties: @@ -73,166 +75,170 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Configuration resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Configuration resource - was created + description: The date and time in GMT when the Configuration 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 ISO 8601 date and time in GMT when the Configuration resource - was last updated + description: The date and time in GMT when the Configuration resource was + last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. attributes: nullable: true - description: An object that contains application-specific data + description: An object that contains application-specific data. status: type: string $ref: '#/components/schemas/configuration_enum_status' nullable: true - description: The status of the Flex onboarding + description: 'The status of the Flex onboarding. Can be: `ok`, `inprogress`,`notstarted`.' taskrouter_workspace_sid: type: string minLength: 34 maxLength: 34 pattern: ^WS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the TaskRouter Workspace + description: The SID of the TaskRouter Workspace. taskrouter_target_workflow_sid: type: string minLength: 34 maxLength: 34 pattern: ^WW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the TaskRouter target Workflow + description: The SID of the TaskRouter target Workflow. taskrouter_target_taskqueue_sid: type: string minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ nullable: true - description: The SID of the TaskRouter Target TaskQueue + description: The SID of the TaskRouter Target TaskQueue. taskrouter_taskqueues: type: array items: {} nullable: true - description: The list of TaskRouter TaskQueues + description: The list of TaskRouter TaskQueues. taskrouter_skills: type: array items: {} nullable: true - description: The Skill description for TaskRouter workers + description: The Skill description for TaskRouter workers. taskrouter_worker_channels: nullable: true description: The TaskRouter default channel capacities and availability - for workers + for workers. taskrouter_worker_attributes: nullable: true - description: The TaskRouter Worker attributes + description: The TaskRouter Worker attributes. taskrouter_offline_activity_sid: type: string minLength: 34 maxLength: 34 pattern: ^WA[0-9a-fA-F]{32}$ nullable: true - description: The TaskRouter SID of the offline activity + description: The TaskRouter SID of the offline activity. runtime_domain: type: string format: uri nullable: true - description: The URL where the Flex instance is hosted + description: The URL where the Flex instance is hosted. messaging_service_instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Messaging service instance + description: The SID of the Messaging service instance. chat_service_instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the chat service this user belongs to + description: The SID of the chat service this user belongs to. flex_service_instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flex service instance + description: The SID of the Flex service instance. ui_language: type: string nullable: true - description: The primary language of the Flex UI + description: The primary language of the Flex UI. ui_attributes: nullable: true - description: The object that describes Flex UI characteristics and settings + description: The object that describes Flex UI characteristics and settings. ui_dependencies: nullable: true description: The object that defines the NPM packages and versions to be - used in Hosted Flex + used in Hosted Flex. ui_version: type: string nullable: true - description: The Pinned UI version + description: The Pinned UI version. service_version: type: string nullable: true - description: The Flex Service version + description: The Flex Service version. call_recording_enabled: type: boolean nullable: true - description: Whether call recording is enabled + description: Whether call recording is enabled. call_recording_webhook_url: type: string format: uri nullable: true - description: The call recording webhook URL + description: The call recording webhook URL. crm_enabled: type: boolean nullable: true - description: Whether CRM is present for Flex + description: Whether CRM is present for Flex. crm_type: type: string nullable: true - description: The CRM Type + description: The CRM type. crm_callback_url: type: string format: uri nullable: true - description: The CRM Callback URL + description: The CRM Callback URL. crm_fallback_url: type: string format: uri nullable: true - description: The CRM Fallback URL + description: The CRM Fallback URL. crm_attributes: nullable: true - description: An object that contains the CRM attributes + description: An object that contains the CRM attributes. public_attributes: nullable: true - description: The list of public attributes + description: The list of public attributes, which are visible to unauthenticated + clients. plugin_service_enabled: type: boolean nullable: true - description: Whether the plugin service enabled + description: Whether the plugin service enabled. plugin_service_attributes: nullable: true - description: The plugin service attributes + description: The plugin service attributes. integrations: type: array items: {} nullable: true description: A list of objects that contain the configurations for the Integrations - supported in this configuration + supported in this configuration. outbound_call_flows: nullable: true - description: The list of outbound call flows + description: The list of outbound call flows. serverless_service_sids: type: array items: @@ -241,28 +247,29 @@ components: maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true - description: The list of serverless service SIDs + description: The list of serverless service SIDs. queue_stats_configuration: nullable: true - description: Configurable parameters for Queues Statistics + description: Configurable parameters for Queues Statistics. notifications: nullable: true - description: Configurable parameters for Notifications + description: Configurable parameters for Notifications. markdown: nullable: true - description: Configurable parameters for Markdown + description: Configurable parameters for Markdown. url: type: string format: uri nullable: true - description: The absolute URL of the Configuration resource + description: The absolute URL of the Configuration resource. flex_insights_hr: nullable: true - description: Object that controls workspace reporting + description: Object with enabled/disabled flag with list of workspaces. flex_insights_drilldown: type: boolean nullable: true - description: Setting to enable Flex UI redirection + description: Setting this to true will redirect Flex UI to the URL set in + flex_url flex_url: type: string format: uri @@ -272,13 +279,14 @@ components: type: array items: {} nullable: true - description: Flex Conversations channels' attachments configurations + description: Settings for different limits for Flex Conversations channels + attachments. debugger_integration: nullable: true - description: Configurable parameters for Debugger Integration + description: Configurable parameters for Debugger Integration. flex_ui_status_report: nullable: true - description: Configurable parameters for Flex UI Status report + description: Configurable parameters for Flex UI Status report. configuration_enum_status: type: string enum: @@ -294,70 +302,85 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Flex Flow resource and owns this Workflow. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. sid: type: string minLength: 34 maxLength: 34 pattern: ^FO[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Flex Flow + resource. 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. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the chat service + description: The SID of the chat service. channel_type: type: string $ref: '#/components/schemas/flex_flow_enum_channel_type' nullable: true - description: The 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." contact_identity: type: string nullable: true - description: The channel contact's Identity + description: The channel contact's Identity. enabled: type: boolean nullable: true - description: Whether the Flex Flow is enabled + description: Whether the Flex Flow is enabled. integration_type: type: string $ref: '#/components/schemas/flex_flow_enum_integration_type' nullable: true - description: The software that will handle inbound messages. + 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: nullable: true - description: An object that contains specific parameters for the integration + description: An object that contains specific parameters for the integration. long_lived: type: boolean nullable: true - description: Re-use this chat channel for future interactions with a contact + 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`. janitor_enabled: type: boolean nullable: true - description: Remove active Proxy sessions if the corresponding Task is deleted. + 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`. url: type: string format: uri nullable: true - description: The absolute URL of the Flex Flow resource + description: The absolute URL of the Flex Flow resource. flex_flow_enum_channel_type: type: string enum: @@ -383,15 +406,15 @@ components: session_expiry: type: string nullable: true - description: The session expiry date and time + description: The session expiry date and time, given in ISO 8601 format. session_id: type: string nullable: true - description: Unique session ID + description: The unique ID for the session base_url: type: string nullable: true - description: Base URL to fetch reports and dashboards + description: The base URL to fetch reports and dashboards url: type: string format: uri @@ -406,14 +429,23 @@ components: maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string created by Twilio to identify an Interaction + resource, prefixed with KD. channel: nullable: true - description: The Interaction's channel + description: "A JSON object that defines the Interaction\u2019s communication\ + \ channel and includes details about the channel. See the [Outbound SMS](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions)\ + \ and [inbound (API-initiated)](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#api-initiated-contact)\ + \ Channel object examples." routing: nullable: true - description: A JSON Object representing the routing rules for the Interaction - Channel + description: "A JSON Object representing the routing rules for the Interaction\ + \ Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions)\ + \ for an example Routing object. The Interactions resource uses TaskRouter\ + \ for all routing functionality. \n All attributes in the Routing object\ + \ on your Interaction request body are added \u201Cas is\u201D to the\ + \ task. For a list of known attributes consumed by the Flex UI and/or\ + \ Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes)." url: type: string format: uri @@ -431,19 +463,25 @@ components: maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string created by Twilio to identify an Interaction + Channel resource, prefixed with UO. interaction_sid: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource. + description: The unique string created by Twilio to identify an Interaction + resource, prefixed with KD. type: type: string $ref: '#/components/schemas/interaction_channel_enum_type' nullable: true - description: The Interaction Channel's type. + 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" status: type: string $ref: '#/components/schemas/interaction_channel_enum_channel_status' @@ -497,25 +535,31 @@ components: maxLength: 34 pattern: ^KG[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string created by Twilio to identify an Interaction + Channel Invite resource. interaction_sid: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ nullable: true - description: The Interaction SID for this Channel + description: The Interaction SID for this Channel. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ nullable: true - description: The Channel SID for this Invite + description: The Channel SID for this Invite. routing: nullable: true - description: A JSON object representing the routing rules for the Interaction - Channel + description: "A JSON object representing the routing rules for the Interaction\ + \ Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions)\ + \ for an example Routing object. The Interactions resource uses TaskRouter\ + \ for all routing functionality. \n All attributes in the Routing object\ + \ on your Interaction request body are added \u201Cas is\u201D to the\ + \ task. For a list of known attributes consumed by the Flex UI and/or\ + \ Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes)." url: type: string format: uri @@ -538,12 +582,14 @@ components: maxLength: 34 pattern: ^UT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string created by Twilio to identify an Interaction + Channel Participant resource. type: type: string $ref: '#/components/schemas/interaction_channel_participant_enum_type' nullable: true - description: Participant type. + description: 'Participant type. Can be: `agent`, `customer`, `supervisor`, + `external`, `unknown`' interaction_sid: type: string minLength: 34 @@ -597,38 +643,40 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource and owns this - Workflow + 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 + 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 identifies the WebChannel resource + 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 + description: The absolute URL of the WebChannel resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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: diff --git a/spec/yaml/twilio_flex_v2.yaml b/spec/yaml/twilio_flex_v2.yaml index c5c9ffc1..d1eb6e79 100644 --- a/spec/yaml/twilio_flex_v2.yaml +++ b/spec/yaml/twilio_flex_v2.yaml @@ -9,11 +9,14 @@ components: maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true - description: The unique string representing the Conversation resource created + description: The unique string representing the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource) + created. identity: type: string nullable: true - description: The unique string representing the User created + 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 diff --git a/spec/yaml/twilio_frontline_v1.yaml b/spec/yaml/twilio_frontline_v1.yaml index bb365202..c22a6210 100644 --- a/spec/yaml/twilio_frontline_v1.yaml +++ b/spec/yaml/twilio_frontline_v1.yaml @@ -9,33 +9,37 @@ components: maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the User resource. identity: type: string nullable: true - description: The string that identifies the resource's User + 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. 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. avatar: type: string nullable: true - description: The avatar URL which will be shown in Frontline application + description: The avatar URL which will be shown in Frontline application. state: type: string $ref: '#/components/schemas/user_enum_state_type' nullable: true - description: Current state of this user + description: Current state of this user. Can be either `active` or `deactivated` + and defaults to `active` is_available: type: boolean nullable: true - description: Whether the User is available for new conversations + description: Whether the User is available for new conversations. Defaults + to `false` for new users. url: type: string format: uri nullable: true - description: An absolute URL for this user. + description: An absolute API resource URL for this user. user_enum_state_type: type: string enum: diff --git a/spec/yaml/twilio_insights_v1.yaml b/spec/yaml/twilio_insights_v1.yaml index 4ae6e814..580cfa18 100644 --- a/spec/yaml/twilio_insights_v1.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -28,47 +28,65 @@ components: maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: Call SID. + 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: Account SID. + description: The unique SID identifier of the Account. answered_by: type: string $ref: '#/components/schemas/annotation_enum_answered_by' nullable: true - description: Indicates the answering entity as determined by Answering Machine - Detection. + 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.' connectivity_issue: type: string $ref: '#/components/schemas/annotation_enum_connectivity_issue' nullable: true - description: Indicates if the call had any 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.' quality_issues: type: array items: type: string nullable: true - description: Indicates if the call had audio quality issues. + 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 nullable: true - description: Call spam indicator + 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.' call_score: type: integer nullable: true - description: Call Score + 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].' comment: type: string nullable: true - description: User comments + 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." incident: type: string nullable: true - description: Call tag for incidents or support ticket + 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." url: type: string format: uri @@ -256,33 +274,35 @@ components: maxLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ nullable: true - description: Conference SID. + description: The unique SID identifier of the Conference. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account SID. + description: The unique SID identifier of the Account. friendly_name: type: string nullable: true - description: Custom label for the conference. + description: Custom label for the conference resource, up to 64 characters. create_time: type: string format: date-time nullable: true - description: Conference creation date/time. + description: Conference creation date and time in ISO 8601 format. start_time: type: string format: date-time nullable: true - description: Timestamp in ISO 8601 format when the conference started. + description: Timestamp in ISO 8601 format when the conference started. Conferences + do not start until at least two participants join, at least one of whom + has startConferenceOnEnter=true. end_time: type: string format: date-time nullable: true - description: Conference end date/time. + description: Conference end date and time in ISO 8601 format. duration_seconds: type: integer nullable: true @@ -290,68 +310,79 @@ components: connect_duration_seconds: type: integer nullable: true - description: Duration of the conference in seconds. + description: Duration of the between conference start event and conference + end event in seconds. status: type: string $ref: '#/components/schemas/conference_enum_conference_status' nullable: true - description: Status of conference + description: Status of this Conference; `in_progress`, `not_started`, `completed` + or `summary_timeout`. if Twilio don't receive `last_participant_left` + event, summary will be timeout after 24 hours max_participants: type: integer nullable: true - description: Max participants specified in config. + description: Maximum number of concurrent participants as specified by the + configuration. max_concurrent_participants: type: integer nullable: true - description: Actual maximum concurrent participants. + description: Actual maximum number of concurrent participants in the conference. unique_participants: type: integer nullable: true - description: Unique conference participants. + description: Unique conference participants based on caller ID. end_reason: type: string $ref: '#/components/schemas/conference_enum_conference_end_reason' nullable: true - description: Conference end reason. + description: Conference end reason; e.g. last participant left, modified + by API, etc. ended_by: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: Call SID that ended the conference. + description: Call SID of the participant whose actions ended the conference. mixer_region: type: string $ref: '#/components/schemas/conference_enum_region' nullable: true - description: Region where the conference was mixed. + description: Twilio region where the conference media was mixed. mixer_region_requested: type: string $ref: '#/components/schemas/conference_enum_region' nullable: true - description: Configuration-requested conference mixer region. + description: Twilio region where conference mixed was specified to be mixed + in configuration. recording_enabled: type: boolean nullable: true - description: Boolean. Indicates whether recording was enabled. + description: Boolean. Indicates whether recording was enabled at the conference + mixer. detected_issues: nullable: true - description: Potential issues detected during the conference. + description: Potential issues detected by Twilio during the conference. tags: type: array items: type: string $ref: '#/components/schemas/conference_enum_tag' nullable: true - description: Tags for detected conference conditions and participant behaviors. + description: Tags for detected conference conditions and participant behaviors + which may be of interest. tag_info: nullable: true - description: Object. Contains details about conference tags. + description: Object. Contains details about conference tags including severity. processing_state: type: string $ref: '#/components/schemas/conference_enum_processing_state' nullable: true - description: Processing state for the Conference Summary resource. + description: Processing state for the Conference Summary resource. Will + be `in_progress` while data is being aggregated, `timeout` if Twilio couldn't + process the summary in 24hrs, and `complete` once aggregations and analysis + has ended. url: type: string format: uri @@ -361,7 +392,8 @@ components: type: object format: uri-map nullable: true - description: Nested resource URLs. + description: Contains a dictionary of URL links to nested resources of this + Conference. conference_enum_conference_status: type: string enum: @@ -427,26 +459,27 @@ components: maxLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ nullable: true - description: Conference SID. + description: The unique SID identifier of the Conference. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: Unique SID identifier of the call. + description: Unique SID identifier of the call that generated the Participant + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account SID. + description: The unique SID identifier of the Account. call_direction: type: string $ref: '#/components/schemas/conference_participant_enum_call_direction' nullable: true - description: Call direction of the participant. + description: Call direction of the participant; inbound or outbound. from: type: string nullable: true @@ -463,7 +496,8 @@ components: country_code: type: string nullable: true - description: ISO alpha-2 country code of the participant. + description: ISO alpha-2 country code of the participant based on caller + ID or called number. is_moderator: type: boolean nullable: true @@ -486,16 +520,17 @@ components: outbound_queue_length: type: integer nullable: true - description: Estimated time in queue at call creation. + description: Add Participant API only. Estimated time in queue at call creation. outbound_time_in_queue: type: integer nullable: true - description: Actual time in queue (seconds). + description: Add Participant API only. Actual time in queue in seconds. jitter_buffer_size: type: string $ref: '#/components/schemas/conference_participant_enum_jitter_buffer_size' nullable: true - description: The Jitter Buffer Size of this Conference Participant. + description: The Jitter Buffer Size of this Conference Participant. One + of `large`, `small`, `medium` or `off`. is_coach: type: boolean nullable: true @@ -515,27 +550,32 @@ components: type: string $ref: '#/components/schemas/conference_participant_enum_region' nullable: true - description: The Conference Region of this Conference Participant. + description: The Conference Region of this Conference Participant. One of + `us1`, `us2`, `au1`, `br1`, `ie1`, `jp1`, `sg1` or `de1`. call_type: type: string $ref: '#/components/schemas/conference_participant_enum_call_type' nullable: true - description: The Call Type of this Conference Participant. + description: The Call Type of this Conference Participant. One of `carrier`, + `client` or `sip`. processing_state: type: string $ref: '#/components/schemas/conference_participant_enum_processing_state' nullable: true - description: Processing state of the Participant Summary. + description: Processing state of the Participant Summary. Will be `in_progress` + while data is being aggregated, `timeout` if Twilio couldn't process the + summary in 24hrs, and `complete` once aggregations and analysis has ended. properties: nullable: true description: Participant properties and metadata. events: nullable: true description: Object containing information of actions taken by participants. - Nested resource URLs. + Contains a dictionary of URL links to nested resources of this Conference + Participant. metrics: nullable: true - description: Object. Contains participant quality metrics. + description: Object. Contains participant call quality metrics. url: type: string format: uri @@ -826,7 +866,7 @@ components: type: string format: date-time nullable: true - description: When the participant left the room + description: When the participant left the room. duration_sec: type: integer format: int64 @@ -850,18 +890,20 @@ components: type: string $ref: '#/components/schemas/video_participant_summary_enum_room_status' nullable: true - description: Status of the room. + description: Status of the room. Can be `in_progress` or `completed`. codecs: type: array items: type: string $ref: '#/components/schemas/video_participant_summary_enum_codec' nullable: true - description: Codecs detected from the participant. + description: Codecs detected from the participant. Can be `VP8`, `H264`, + or `VP9`. end_reason: type: string nullable: true - description: Reason the participant left the room. + 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). error_code: type: integer nullable: true @@ -874,19 +916,25 @@ components: type: string $ref: '#/components/schemas/video_participant_summary_enum_twilio_realm' nullable: true - description: Twilio media region the participant connected to. + description: Twilio media region the participant connected to. See [the + list of possible media servers here](https://www.twilio.com/docs/video/ip-addresses). properties: nullable: true description: Object containing information about the participant's data - from the room. + from the room. See [below](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#properties) + for more information. edge_location: type: string $ref: '#/components/schemas/video_participant_summary_enum_edge_location' nullable: true - description: Name of the edge location the participant connected to. + description: Name of the edge location the participant connected to. See + [the list of public edge locations](https://www.twilio.com/docs/global-infrastructure/edge-locations#public-edge-locations) + for the possible values. 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. url: type: string format: uri @@ -948,7 +996,7 @@ components: room_name: type: string nullable: true - description: room friendly name. + description: Room friendly name. create_time: type: string format: date-time @@ -963,12 +1011,12 @@ components: type: string $ref: '#/components/schemas/video_room_summary_enum_room_type' nullable: true - description: Type of room. + description: Type of room. Can be `go`, `peer_to_peer`, `group`, or `group_small`. room_status: type: string $ref: '#/components/schemas/video_room_summary_enum_room_status' nullable: true - description: Status of the room. + description: Status of the room. Can be `in_progress` or `completed`. status_callback: type: string format: uri @@ -990,12 +1038,12 @@ components: type: string $ref: '#/components/schemas/video_room_summary_enum_created_method' nullable: true - description: How the room was created. + description: How the room was created. Can be `sdk`, `ad_hoc`, or `api`. end_reason: type: string $ref: '#/components/schemas/video_room_summary_enum_end_reason' nullable: true - description: Reason the room ended. + description: Reason the room ended. Can be `room_ended_via_api` or `timeout`. max_participants: type: integer nullable: true @@ -1025,12 +1073,14 @@ components: type: string $ref: '#/components/schemas/video_room_summary_enum_codec' nullable: true - description: Codecs used by participants in the room. + description: Codecs used by participants in the room. Can be `VP8`, `H264`, + or `VP9`. media_region: type: string $ref: '#/components/schemas/video_room_summary_enum_twilio_realm' nullable: true - description: Region of Twilio media servers for the room. + description: Region of Twilio media servers for the room. See [the list + of possible media servers here](https://www.twilio.com/docs/video/ip-addresses). duration_sec: type: integer format: int64 @@ -1052,7 +1102,8 @@ components: $ref: '#/components/schemas/video_room_summary_enum_processing_state' nullable: true description: Video Log Analyzer resource state. Will be either `in-progress` - or `complete`. + or `complete`. `in-progress` indicates that more details may be appended + to the resource. `complete` indicates no further information will be added. recording_enabled: type: boolean nullable: true @@ -1061,7 +1112,9 @@ components: type: string $ref: '#/components/schemas/video_room_summary_enum_edge_location' nullable: true - description: Edge location of Twilio media servers for the room. + description: Edge location of Twilio media servers for the room. See [the + list of public edge locations](https://www.twilio.com/docs/global-infrastructure/edge-locations#public-edge-locations) + for the possible values. url: type: string format: uri diff --git a/spec/yaml/twilio_lookups_v1.yaml b/spec/yaml/twilio_lookups_v1.yaml index 5911d76c..63a76ebd 100644 --- a/spec/yaml/twilio_lookups_v1.yaml +++ b/spec/yaml/twilio_lookups_v1.yaml @@ -5,31 +5,37 @@ components: properties: caller_name: nullable: true - description: The name of the phone number's owner + description: The name of the phone number's owner. If `null`, that information + was not available. country_code: type: string nullable: true - description: The ISO country code for the phone number + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + for the phone number. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. national_format: type: string nullable: true - description: The phone number, in national format + description: The phone number, in national format. carrier: nullable: true - description: The telecom company that provides the phone number + description: The telecom company that provides the phone number. 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). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. phone_number_enum_type: type: string enum: diff --git a/spec/yaml/twilio_lookups_v2.yaml b/spec/yaml/twilio_lookups_v2.yaml index 036ea9f9..a1ab36be 100644 --- a/spec/yaml/twilio_lookups_v2.yaml +++ b/spec/yaml/twilio_lookups_v2.yaml @@ -6,54 +6,66 @@ components: calling_country_code: type: string nullable: true - description: International dialing prefix + description: International dialing prefix of the phone number defined in + the E.164 standard. country_code: type: string nullable: true - description: Phone number's ISO country code + description: The phone number's [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). phone_number: type: string format: phone-number nullable: true - description: Phone number in E.164 format + 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. national_format: type: string nullable: true - description: Phone number in national format + description: The phone number in [national format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers). valid: type: boolean nullable: true - description: Boolean which indicates if the phone number is valid + description: Boolean which indicates if the phone number is in a valid range + that can be freely assigned by a carrier to a user. validation_errors: type: array items: type: string $ref: '#/components/schemas/phone_number_enum_validation_error' nullable: true - description: Contains reasons why a phone number is invalid + description: 'Contains reasons why a phone number is invalid. Possible values: + TOO_SHORT, TOO_LONG, INVALID_BUT_POSSIBLE, INVALID_COUNTRY_CODE, INVALID_LENGTH, + NOT_A_NUMBER.' caller_name: nullable: true - description: An object that contains caller name information + 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). sim_swap: nullable: true - description: An object that contains SIM swap information + description: An object that contains information on the last date the subscriber + identity module (SIM) was changed for a mobile phone number. call_forwarding: nullable: true - description: An object that contains call forwarding status information + description: An object that contains information on the unconditional call + forwarding status of mobile phone number. live_activity: nullable: true - description: An object that contains live activity information + description: An object that contains live activity information for a mobile + phone number. line_type_intelligence: nullable: true - description: An object that contains line type information + description: An object that contains line type information including the + carrier name, mobile country code, and mobile network code. identity_match: nullable: true - description: An object that contains identity match information + 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 url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. phone_number_enum_type: type: string enum: diff --git a/spec/yaml/twilio_media_v1.yaml b/spec/yaml/twilio_media_v1.yaml index 922be28e..660ad76e 100644 --- a/spec/yaml/twilio_media_v1.yaml +++ b/spec/yaml/twilio_media_v1.yaml @@ -9,52 +9,65 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the MediaProcessor resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^ZX[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string generated to identify the MediaProcessor + resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. extension: type: string nullable: true - description: The Media Extension name or URL + description: 'The [Media Extension](/docs/live/api/media-extensions-overview) + name or URL. Ex: `video-composer-v2`' extension_context: type: string nullable: true - description: The Media Extension context + 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. status: type: string $ref: '#/components/schemas/media_processor_enum_status' nullable: true - description: The status of the MediaProcessor + description: 'The status of the MediaProcessor. Can be: `started`, `ended` + or `failed`.' url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. ended_reason: type: string nullable: true - description: The reason why a MediaProcessor ended + description: The reason why a MediaProcessor ended. When a MediaProcessor + is in progress, will be `null`. When a MediaProcessor is completed, can + be `ended-via-api`, `max-duration-exceeded`, `error-loading-extension`, + `error-streaming-media` or `internal-service-error`. See [ended reasons](/docs/live/api/mediaprocessors#mediaprocessor-ended-reason-values) + for more details. status_callback: type: string format: uri nullable: true - description: The URL to which Twilio will send MediaProcessor event updates + description: The URL to which Twilio will send asynchronous webhook requests + for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) + for details. status_callback_method: type: string format: http-method @@ -67,11 +80,14 @@ components: - DELETE nullable: true description: The HTTP method Twilio should use to call the `status_callback` - URL + URL. Can be `POST` or `GET` and the default is `POST`. max_duration: type: integer nullable: true - description: Maximum MediaProcessor duration in seconds + description: The maximum time, in seconds, that the MediaProcessor can run + 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 MediaProcessor, regardless of whether media is still streaming. media_processor_enum_status: type: string enum: @@ -96,72 +112,80 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the MediaRecording resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. duration: type: integer nullable: true - description: The duration of the MediaRecording + description: The duration of the MediaRecording in seconds. format: type: string $ref: '#/components/schemas/media_recording_enum_format' nullable: true - description: The format of the MediaRecording + description: The format of the MediaRecording, either `mp4` or `webm`. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. processor_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZX[0-9a-fA-F]{32}$ nullable: true - description: The SID of the MediaProcessor + description: The SID of the MediaProcessor resource which produced the MediaRecording. resolution: type: string nullable: true - description: The dimensions of the video image in pixels + description: The dimensions of the video image in pixels expressed as columns + (width) and rows (height). source_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource that generated the original media + description: The SID of the resource that generated the original media track(s) + of the MediaRecording. sid: type: string minLength: 34 maxLength: 34 pattern: ^KV[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string generated to identify the MediaRecording + resource. media_size: type: integer format: int64 nullable: true - description: The size of the recording media + description: The size of the recording media in bytes. status: type: string $ref: '#/components/schemas/media_recording_enum_status' nullable: true - description: The status of the MediaRecording + description: 'The status of the MediaRecording. Can be: `processing`, `completed`, + `deleted`, or `failed`.' status_callback: type: string format: uri nullable: true - description: The URL to which Twilio will send MediaRecording event updates + 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. status_callback_method: type: string format: http-method @@ -174,12 +198,12 @@ components: - DELETE nullable: true description: The HTTP method Twilio should use to call the `status_callback` - URL + URL. Can be `POST` or `GET` and the default is `POST`. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. media_recording_enum_format: type: string enum: @@ -206,49 +230,57 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the PlayerStreamer resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. video: type: boolean nullable: true - description: Whether the PlayerStreamer is configured to stream video + description: Specifies whether the PlayerStreamer is configured to stream + video. Defaults to `true`. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. sid: type: string minLength: 34 maxLength: 34 pattern: ^VJ[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string generated to identify the PlayerStreamer + resource. status: type: string $ref: '#/components/schemas/player_streamer_enum_status' nullable: true - description: The status of the PlayerStreamer + description: 'The status of the PlayerStreamer. Can be: `created`, `started`, + `ended`, or `failed`. See [status](/docs/live/api/playerstreamers#status) + for more information.' url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. status_callback: type: string format: uri nullable: true - description: The URL to which Twilio will send PlayerStreamer event updates + 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. status_callback_method: type: string format: http-method @@ -261,16 +293,24 @@ components: - DELETE nullable: true description: The HTTP method Twilio should use to call the `status_callback` - URL + URL. Can be `POST` or `GET` and the default is `POST`. ended_reason: type: string $ref: '#/components/schemas/player_streamer_enum_ended_reason' nullable: true - description: The reason why a PlayerStreamer ended + description: The reason why a PlayerStreamer ended. When a PlayerStreamer + is in progress, will be `null`. When a PlayerStreamer is completed, can + be `ended-via-api`, `max-duration-exceeded`, `stream-disconnected-by-source` + or `unexpected-failure`. See [ended reasons](/docs/live/api/playerstreamers#ended-reason) + for more details. max_duration: type: integer nullable: true - description: Maximum PlayerStreamer duration in seconds + 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. player_streamer_enum_status: type: string enum: @@ -303,25 +343,27 @@ components: maxLength: 34 pattern: ^VJ[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the PlayerStreamer associated - with this PlaybackGrant. + description: The unique string generated to identify the PlayerStreamer + resource that this PlaybackGrant authorizes views for. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created this resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. grant: nullable: true description: The grant that authorizes the player sdk to connect to the diff --git a/spec/yaml/twilio_messaging_v1.yaml b/spec/yaml/twilio_messaging_v1.yaml index 3551a06f..4f038cf0 100644 --- a/spec/yaml/twilio_messaging_v1.yaml +++ b/spec/yaml/twilio_messaging_v1.yaml @@ -9,48 +9,52 @@ components: maxLength: 34 pattern: ^AI[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the AlphaSender + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the AlphaSender resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the resource is associated with. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. alpha_sender: type: string nullable: true - description: The Alphanumeric Sender ID string + description: The Alphanumeric Sender ID string. capabilities: type: array items: type: string nullable: true - description: An array of values that describe whether the number can receive - calls or messages + description: 'An array of values that describe whether the number can receive + calls or messages. Can be: `SMS`.' url: type: string format: uri nullable: true - description: The absolute URL of the AlphaSender resource + description: The absolute URL of the AlphaSender resource. messaging.v1.brand_registrations: type: object properties: @@ -60,93 +64,106 @@ components: maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ nullable: true - description: A2P BrandRegistration Sid + description: The unique string to identify Brand Registration. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Brand Registration resource. customer_profile_bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: A2P Messaging Profile Bundle BundleSid + description: A2P Messaging Profile Bundle BundleSid. a2p_profile_bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: A2P Messaging Profile Bundle BundleSid + description: A2P Messaging Profile Bundle BundleSid. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. brand_type: type: string nullable: true - description: 'Type of brand. One of: "STANDARD", "STARTER".' + description: 'Type of brand. One of: "STANDARD", "STARTER". STARTER is for + the low volume, STARTER campaign use case. There can only be one STARTER + campaign created per STARTER brand. STANDARD is for all other campaign + use cases. Multiple campaign use cases can be created per STANDARD brand.' status: type: string $ref: '#/components/schemas/brand_registrations_enum_status' nullable: true - description: Brand Registration status. + description: Brand Registration status. One of "PENDING", "APPROVED", "FAILED", + "IN_REVIEW", "DELETED". tcr_id: type: string nullable: true - description: Campaign Registry (TCR) Brand ID + description: Campaign Registry (TCR) Brand ID. Assigned only after successful + brand registration. failure_reason: type: string nullable: true - description: A reason why brand registration has failed + description: A reason why brand registration has failed. Only applicable + when status is FAILED. url: type: string format: uri nullable: true - description: The absolute URL of the Brand Registration + description: The absolute URL of the Brand Registration resource. brand_score: type: integer nullable: true - description: Brand score + description: The secondary vetting score if it was done. Otherwise, it will + be the brand score if it's returned from TCR. It may be null if no score + is available. brand_feedback: type: array items: type: string $ref: '#/components/schemas/brand_registrations_enum_brand_feedback' nullable: true - description: Brand feedback + description: Feedback on how to improve brand score identity_status: type: string $ref: '#/components/schemas/brand_registrations_enum_identity_status' nullable: true - description: Identity Status + description: When a brand is registered, TCR will attempt to verify the + identity of the brand based on the supplied information. russell_3000: type: boolean nullable: true - description: Russell 3000 + description: Publicly traded company identified in the Russell 3000 Index government_entity: type: boolean nullable: true - description: Government Entity + description: Identified as a government entity tax_exempt_status: type: string nullable: true - description: Tax Exempt Status + description: Nonprofit organization tax-exempt status per section 501 of + the U.S. tax code. skip_automatic_sec_vet: type: boolean nullable: true - description: Skip Automatic Secondary Vetting + description: A flag to disable automatic secondary vetting for brands which + it would otherwise be done. mock: type: boolean nullable: true @@ -189,54 +206,60 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the vetting + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the vetting record. brand_sid: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ nullable: true - description: A2P BrandRegistration Sid + description: The unique string to identify Brand Registration. brand_vetting_sid: type: string minLength: 34 maxLength: 34 pattern: ^VT[0-9a-fA-F]{32}$ nullable: true - description: SID for third-party vetting record + description: The Twilio SID of the third-party vetting record. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated + 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. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. vetting_id: type: string nullable: true - description: The unique ID of the vetting + description: The unique identifier of the vetting from the third-party provider. vetting_class: type: string nullable: true - description: The type of vetting + description: "The type of vetting that has been conducted. One of \u201C\ + STANDARD\u201D (Aegis) or \u201CPOLITICAL\u201D (Campaign Verify)." vetting_status: type: string nullable: true - description: Status of vetting attempt + description: "The status of the import vetting attempt. One of \u201CPENDING,\u201D\ + \ \u201CSUCCESS,\u201D or \u201CFAILED\u201D." vetting_provider: type: string $ref: '#/components/schemas/brand_vetting_enum_vetting_provider' nullable: true - description: Third-party provider that has conducted the vetting + description: "The third-party provider that has conducted the vetting. One\ + \ of \u201CCampaignVerify\u201D (Campaign Verify tokens) or \u201CAEGIS\u201D\ + \ (Secondary Vetting)." url: type: string format: uri nullable: true - description: The absolute URL of the Brand Vetting + description: The absolute URL of the Brand Vetting resource. brand_vetting_enum_vetting_provider: type: string enum: @@ -248,7 +271,9 @@ components: type: string format: uri nullable: true - description: Redirect url to the list of deactivated numbers. + description: Returns an authenticated url that redirects to a file containing + the deactivated numbers for the requested day. This url is valid for up + to two minutes. messaging.v1.domain_cert_v4: type: object properties: @@ -268,12 +293,15 @@ components: type: string format: date-time nullable: true - description: Expiration date for your private certificate. + description: Date that the private certificate associated with this domain + expires. You will need to update the certificate before that date to ensure + your shortened links will continue to work. date_created: type: string format: date-time nullable: true - description: Date this Domain SID was created. + description: Date that this Domain was registered to the Twilio platform + to create a new Domain object. domain_name: type: string format: uri @@ -294,7 +322,7 @@ components: validated: type: boolean nullable: true - description: Certificate validation field + description: Boolean value indicating whether certificate has been validated messaging.v1.domain_config: type: object properties: @@ -326,8 +354,10 @@ components: type: string format: uri nullable: true - description: We will redirect requests to urls we are unable to identify - to this url. + description: Any requests we receive to this domain that do not match an + existing shortened message will be redirected to the fallback url. These + will likely be either expired messages, random misdirected traffic, or + intentional scraping. callback_url: type: string format: uri @@ -358,13 +388,15 @@ components: pattern: ^QE[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies a US A2P Compliance resource + `QE2c6890da8086d771620e9b13fadeba0b`. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that the Campaign belongs to. campaign_id: type: string nullable: true @@ -375,13 +407,14 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Messaging Service the resource is associated - with + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + that the resource is associated with. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. messaging.v1.service.phone_number: type: object properties: @@ -391,53 +424,60 @@ components: maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the PhoneNumber + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the PhoneNumber resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the resource is associated with. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. country_code: type: string nullable: true - description: The 2-character ISO Country Code of the number + description: The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) + of the number. capabilities: type: array items: type: string nullable: true - description: An array of values that describe whether the number can receive - calls or messages + description: 'An array of values that describe whether the number can receive + calls or messages. Can be: `Voice`, `SMS`, and `MMS`.' url: type: string format: uri nullable: true - description: The absolute URL of the PhoneNumber resource + description: The absolute URL of the PhoneNumber resource. messaging.v1.service: type: object properties: @@ -447,36 +487,42 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Service resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Service resource. 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. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. inbound_request_url: type: string format: uri nullable: true - description: The URL we call using inbound_method when a message is received - by any phone number or short code in the Service. This field will be overridden - if the `use_inbound_webhook_on_number` field is enabled. + description: The URL we call using `inbound_method` when a message is received + by any phone number or short code in the Service. When this property is + `null`, receiving inbound messages is disabled. All messages sent to the + Twilio phone number or short code will not be logged and received on the + Account. If the `use_inbound_webhook_on_number` field is enabled then + the webhook url defined on the phone number will override the `inbound_request_url` + defined for the Messaging Service. inbound_method: type: string format: http-method @@ -488,15 +534,17 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call inbound_request_url + description: The HTTP method we use to call `inbound_request_url`. Can be + `GET` or `POST`. fallback_url: type: string format: uri nullable: true - description: The URL that we call using fallback_method if an error occurs + description: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. - This field will be overridden if the `use_inbound_webhook_on_number` field - is enabled. + If the `use_inbound_webhook_on_number` field is enabled then the webhook + url defined on the phone number will override the `fallback_url` defined + for the Messaging Service. fallback_method: type: string format: http-method @@ -508,63 +556,69 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call fallback_url + description: 'The HTTP method we use to call `fallback_url`. Can be: `GET` + or `POST`.' status_callback: type: string format: uri nullable: true - description: The URL we call to pass status updates about message delivery + description: The URL we call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) + about message delivery. sticky_sender: type: boolean nullable: true - description: Whether to enable Sticky Sender on the Service instance + description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) + on the Service instance. mms_converter: type: boolean nullable: true - description: Whether to enable the MMS Converter for messages sent through - the Service instance + description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) + for messages sent through the Service instance. smart_encoding: type: boolean nullable: true - description: Whether to enable Encoding for messages sent through the Service - instance + description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) + for messages sent through the Service instance. scan_message_content: type: string $ref: '#/components/schemas/service_enum_scan_message_content' nullable: true - description: Reserved + description: Reserved. fallback_to_long_code: type: boolean nullable: true - description: Whether to enable Fallback to Long Code for messages sent through - the Service instance + 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. area_code_geomatch: type: boolean nullable: true - description: Whether to enable Area Code Geomatch on the Service Instance + description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) + on the Service Instance. synchronous_validation: type: boolean nullable: true - description: Reserved + description: Reserved. validity_period: type: integer nullable: true - description: How long, in seconds, messages sent from the Service are valid + description: How long, in seconds, messages sent from the Service are valid. + Can be an integer from `1` to `14,400`. url: type: string format: uri nullable: true - description: The absolute URL of the Service resource + description: The absolute URL of the Service resource. links: type: object format: uri-map nullable: true - description: The absolute URLs of related resources + description: The absolute URLs of related resources. usecase: type: string nullable: true - description: A string describing the scenario in which the Messaging Service - will be used + description: 'A string that describes the scenario in which the Messaging + Service will be used. Examples: [notification, marketing, verification, + poll ..]' us_app_to_person_registered: type: boolean nullable: true @@ -572,9 +626,12 @@ components: use_inbound_webhook_on_number: type: boolean nullable: true - description: If enabled, the webhook url configured on the phone number - will be used and will override the `inbound_request_url`/`fallback_url` - url called when an inbound message is received. + 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. service_enum_scan_message_content: type: string enum: @@ -590,52 +647,58 @@ components: maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the ShortCode + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the ShortCode resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) + the resource is associated with. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. short_code: type: string nullable: true - description: The E.164 format of the short code + description: The [E.164](https://www.twilio.com/docs/glossary/what-e164) + format of the short code. country_code: type: string nullable: true - description: The 2-character ISO Country Code of the number + description: The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) + of the number. capabilities: type: array items: type: string nullable: true - description: An array of values that describe whether the number can receive - calls or messages + description: 'An array of values that describe whether the number can receive + calls or messages. Can be: `SMS` and `MMS`.' url: type: string format: uri nullable: true - description: The absolute URL of the ShortCode resource + description: The absolute URL of the ShortCode resource. messaging.v1.tollfree_verification: type: object properties: @@ -645,155 +708,157 @@ components: maxLength: 34 pattern: ^HH[0-9a-fA-F]{32}$ nullable: true - description: Tollfree Verification Sid + 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 that created the resource + 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 + 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 + description: Tollfree TrustProduct Bundle BundleSid. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 + 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 + number. business_street_address: type: string nullable: true description: The address of the business or organization using the Tollfree - number + number. business_street_address2: type: string nullable: true description: The address of the business or organization using the Tollfree - number + number. business_city: type: string nullable: true description: The city of the business or organization using the Tollfree - number + number. business_state_province_region: type: string nullable: true description: The state/province/region of the business or organization using - the Tollfree number + the Tollfree number. business_postal_code: type: string nullable: true description: The postal code of the business or organization using the Tollfree - number + number. business_country: type: string nullable: true description: The country of the business or organization using the Tollfree - number + number. business_website: type: string nullable: true description: The website of the business or organization using the Tollfree - number + 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 + 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 + 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 + using the Tollfree number. business_contact_phone: type: string format: phone-number nullable: true description: The phone number of the contact for the business or organization - using the Tollfree number + using the Tollfree number. notification_email: type: string nullable: true - description: 'The email address to receive the notification about the verification - result. ' + 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. + as many are applicable.. use_case_summary: type: string nullable: true - description: Further explaination on how messaging is used by the business - or organization + 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 + 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 + 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 + 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 + description: Estimate monthly volume of messages from the Tollfree Number. additional_information: type: string nullable: true - description: Additional information to be provided for verification + 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 + description: The SID of the Phone Number associated with the Tollfree Verification. status: type: string $ref: '#/components/schemas/tollfree_verification_enum_status' @@ -803,11 +868,11 @@ components: type: string format: uri nullable: true - description: The absolute URL of the Tollfree Verification + description: The absolute URL of the Tollfree Verification resource. resource_links: nullable: true description: The URLs of the documents associated with the Tollfree Verification - resource + resource. tollfree_verification_enum_status: type: string enum: @@ -833,56 +898,63 @@ components: pattern: ^QE[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies a US A2P Compliance resource + `QE2c6890da8086d771620e9b13fadeba0b`. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that the Campaign belongs to. brand_registration_sid: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ nullable: true - description: A2P Brand Registration SID + description: The unique string to identify the A2P brand. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Messaging Service the resource is associated - with + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + that the resource is associated with. description: type: string nullable: true - description: A short description of what this SMS campaign does + description: 'A short description of what this SMS campaign does. Min length: + 40 characters. Max length: 4096 characters.' message_samples: type: array items: type: string nullable: true - description: Message samples + description: Message samples, at least 1 and up to 5 sample messages (at + least 2 for starter/sole proprietor), >=20 chars, <=1024 chars each. us_app_to_person_usecase: type: string nullable: true - description: A2P Campaign Use Case. + description: 'A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING, + STARTER...]. STARTER campaign use cases can only be created by STARTER + Brands, and there can only be one STARTER campaign created per STARTER + Brand.' has_embedded_links: type: boolean nullable: true description: Indicate that this SMS campaign will send messages that contain - links + links. has_embedded_phone: type: boolean nullable: true description: Indicates that this SMS campaign will send messages that contain - phone numbers + phone numbers. campaign_status: type: string nullable: true - description: Campaign status + description: 'Campaign status. Examples: IN_PROGRESS, VERIFIED, FAILED.' campaign_id: type: string nullable: true @@ -891,64 +963,99 @@ components: type: boolean nullable: true description: Indicates whether the campaign was registered externally or - not + not. rate_limits: nullable: true - description: Rate limit and/or classification set by each carrier + description: Rate limit and/or classification set by each carrier, Ex. AT&T + or T-Mobile. message_flow: type: string nullable: true - description: Consumer opt-in flow + description: 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. opt_in_message: type: string nullable: true - description: Opt In Message + 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. opt_out_message: type: string nullable: true - description: Opt Out Message + 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. help_message: type: string nullable: true - description: Help Message + 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. opt_in_keywords: type: array items: type: string nullable: true - description: Opt In Keywords + 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. opt_out_keywords: type: array items: type: string nullable: true - description: Opt Out Keywords + 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. help_keywords: type: array items: type: string nullable: true - description: Help Keywords + 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. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 US App to Person resource + description: The absolute URL of the US App to Person resource. mock: type: boolean nullable: true description: A boolean that specifies whether campaign is a mock or not. + Mock campaigns will be automatically created if using a mock brand. Mock + campaigns should only be used for testing purposes. messaging.v1.service.us_app_to_person_usecase: type: object properties: @@ -956,7 +1063,9 @@ components: type: array items: {} nullable: true - description: Human readable A2P Use Case details + description: Human readable name, code, description and post_approval_required + (indicates whether or not post approval is required for this Use Case) + of A2P Campaign Use Cases. messaging.v1.usecase: type: object properties: @@ -964,7 +1073,8 @@ components: type: array items: {} nullable: true - description: Human readable Messaging Service Use Case details + description: Human readable use case details (usecase, description and purpose) + of Messaging Service Use Cases. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_microvisor_v1.yaml b/spec/yaml/twilio_microvisor_v1.yaml index 6cb11184..9b4f8142 100644 --- a/spec/yaml/twilio_microvisor_v1.yaml +++ b/spec/yaml/twilio_microvisor_v1.yaml @@ -9,32 +9,37 @@ components: maxLength: 34 pattern: ^KA[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this App. + description: A 34-character string that uniquely identifies this App. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The Account SID. + description: The unique SID identifier of the Account. hash: type: string nullable: true - description: App manifest hash represented as hash_algorithm:hash_value. + description: App manifest hash represented as `hash_algorithm:hash_value`. unique_name: type: string nullable: true - description: An developer-defined string that uniquely identifies the App. + description: A developer-defined string that uniquely identifies the App. + This value must be unique for all Apps on this Account. The `unique_name` + value may be used as an alternative to the `sid` in the URL path to address + the resource. date_created: type: string format: date-time nullable: true - description: The date that this App was created. + description: The date that this App was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. date_updated: type: string format: date-time nullable: true - description: The date that this App was last updated. + description: The date that this App was last updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. url: type: string format: uri @@ -49,36 +54,43 @@ components: maxLength: 34 pattern: ^UV[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Device. + description: A 34-character string that uniquely identifies this Device. unique_name: type: string nullable: true description: A developer-defined string that uniquely identifies the Device. + This value must be unique for all Devices on this Account. The `unique_name` + value may be used as an alternative to the `sid` in the URL path to address + the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account SID. + description: The unique SID identifier of the Account. app: nullable: true description: Information about the target App and the App reported by this - Device. + Device. Contains the properties `target_sid`, `date_targeted`, `update_status` + (one of `up-to-date`, `pending` and `error`), `update_error_code`, `reported_sid` + and `date_reported`. logging: nullable: true description: Object specifying whether application logging is enabled for - this Device. + this Device. Contains the properties `enabled` and `date_expires`. date_created: type: string format: date-time nullable: true - description: The date that this Device was created. + description: The date that this Device was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. date_updated: type: string format: date-time nullable: true - description: The date that this Device was last updated. + description: The date that this Device was last updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. url: type: string format: uri @@ -88,7 +100,7 @@ components: type: object format: uri-map nullable: true - description: The absolute URLs of related resources + description: The absolute URLs of related resources. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_monitor_v1.yaml b/spec/yaml/twilio_monitor_v1.yaml index 9f782918..63462b49 100644 --- a/spec/yaml/twilio_monitor_v1.yaml +++ b/spec/yaml/twilio_monitor_v1.yaml @@ -9,45 +9,51 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Alert resource. alert_text: type: string nullable: true - description: The text of the alert + description: The text of the alert. api_version: type: string nullable: true - description: The API version used when the alert was generated + description: The API version used when the alert was generated. Can be + empty for events that don't have a specific API version. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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_generated: type: string format: date-time nullable: true - description: The date and time when the alert was generated specified in - ISO 8601 format + description: The date and time in GMT when the alert was generated specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. Due + to buffering, this can be different than `date_created`. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated + 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. error_code: type: string nullable: true - description: The error code for the condition that generated the alert + description: The error code for the condition that generated the alert. + See the [Error Dictionary](https://www.twilio.com/docs/api/errors) for + possible causes and solutions to the error. log_level: type: string nullable: true - description: The log level + description: 'The log level. Can be: `error`, `warning`, `notice`, or `debug`.' more_info: type: string nullable: true - description: The URL of the page in our Error Dictionary with more information - about the error condition + description: The URL of the page in our [Error Dictionary](https://www.twilio.com/docs/api/errors) + with more information about the error condition. request_method: type: string format: http-method @@ -59,37 +65,48 @@ components: - PUT - DELETE nullable: true - description: The method used by the request that generated the alert + description: The method used by the request that generated the alert. If + the alert was generated by a request we made to your server, this is the + method we used. If the alert was generated by a request from your application + to our API, this is the method your application used. request_url: type: string nullable: true - description: The URL of the request that generated the alert + description: The URL of the request that generated the alert. If the alert + was generated by a request we made to your server, this is the URL on + your server that generated the alert. If the alert was generated by a + request from your application to our API, this is the URL of the resource + requested. resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource for which the alert was generated + description: The SID of the resource for which the alert was generated. For + instance, if your server failed to respond to an HTTP request during the + flow of a particular call, this value would be the SID of the server. This + value is empty if the alert was not generated for a particular resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^NO[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Alert resource. url: type: string format: uri nullable: true - description: The absolute URL of the Alert resource + description: The absolute URL of the Alert resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the service or resource that generated the alert + description: The SID of the service or resource that generated the alert. + Can be `null`. monitor.v1.alert-instance: type: object properties: @@ -99,45 +116,51 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Alert resource. alert_text: type: string nullable: true - description: The text of the alert + description: The text of the alert. api_version: type: string nullable: true - description: The API version used when the alert was generated + description: The API version used when the alert was generated. Can be + empty for events that don't have a specific API version. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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_generated: type: string format: date-time nullable: true - description: The date and time when the alert was generated specified in - ISO 8601 format + description: The date and time in GMT when the alert was generated specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. Due + to buffering, this can be different than `date_created`. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated + 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. error_code: type: string nullable: true - description: The error code for the condition that generated the alert + description: The error code for the condition that generated the alert. + See the [Error Dictionary](https://www.twilio.com/docs/api/errors) for + possible causes and solutions to the error. log_level: type: string nullable: true - description: The log level + description: 'The log level. Can be: `error`, `warning`, `notice`, or `debug`.' more_info: type: string nullable: true - description: The URL of the page in our Error Dictionary with more information - about the error condition + description: The URL of the page in our [Error Dictionary](https://www.twilio.com/docs/api/errors) + with more information about the error condition. request_method: type: string format: http-method @@ -149,53 +172,68 @@ components: - PUT - DELETE nullable: true - description: The method used by the request that generated the alert + description: The method used by the request that generated the alert. If + the alert was generated by a request we made to your server, this is the + method we used. If the alert was generated by a request from your application + to our API, this is the method your application used. request_url: type: string nullable: true - description: The URL of the request that generated the alert + description: The URL of the request that generated the alert. If the alert + was generated by a request we made to your server, this is the URL on + your server that generated the alert. If the alert was generated by a + request from your application to our API, this is the URL of the resource + requested. request_variables: type: string nullable: true - description: The variables passed in the request that generated the alert + description: The variables passed in the request that generated the alert. + This value is only returned when a single Alert resource is fetched. resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource for which the alert was generated + description: The SID of the resource for which the alert was generated. For + instance, if your server failed to respond to an HTTP request during the + flow of a particular call, this value would be the SID of the server. This + value is empty if the alert was not generated for a particular resource. response_body: type: string nullable: true - description: The response body of the request that generated the alert + description: The response body of the request that generated the alert. + This value is only returned when a single Alert resource is fetched. response_headers: type: string nullable: true - description: The response headers of the request that generated the alert + description: The response headers of the request that generated the alert. + This value is only returned when a single Alert resource is fetched. sid: type: string minLength: 34 maxLength: 34 pattern: ^NO[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Alert resource. url: type: string format: uri nullable: true - description: The absolute URL of the Alert resource + description: The absolute URL of the Alert resource. request_headers: type: string nullable: true - description: The request headers of the request that generated the alert + description: The request headers of the request that generated the alert. + This value is only returned when a single Alert resource is fetched. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the service or resource that generated the alert + description: The SID of the service or resource that generated the alert. + Can be `null`. monitor.v1.event: type: object properties: @@ -205,71 +243,88 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Event resource. actor_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The SID of the actor that caused the event, if available + description: The SID of the actor that caused the event, if available. Can + be `null`. actor_type: type: string nullable: true - description: The type of actor that caused the event + description: 'The type of actor that caused the event. Can be: `user` for + a change made by a logged-in user in the Twilio Console, `account` for + an event caused by an API request by an authenticating Account, `twilio-admin` + for an event caused by a Twilio employee, and so on.' description: type: string nullable: true - description: A description of the event + description: A description of the event. Can be `null`. event_data: nullable: true - description: A JSON string that represents an object with additional data - about the event + description: An object with additional data about the event. The contents + depend on `event_type`. For example, event-types of the form `RESOURCE.updated`, + this value contains a `resource_properties` dictionary that describes + the previous and updated properties of the resource. event_date: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the event was recorded + description: The date and time in GMT when the event was recorded specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. event_type: type: string nullable: true - description: The event's type + description: 'The event''s type. Event-types are typically in the form: + `RESOURCE_TYPE.ACTION`, where `RESOURCE_TYPE` is the type of resource + that was affected and `ACTION` is what happened to it. For example, `phone-number.created`. + For a full list of all event-types, see the [Monitor Event Types](https://www.twilio.com/docs/usage/monitor-events#event-types).' resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource that was affected + description: The SID of the resource that was affected. resource_type: type: string nullable: true - description: The type of resource that was affected + description: The type of resource that was affected. For a full list of + all resource-types, see the [Monitor Event Types](https://www.twilio.com/docs/usage/monitor-events#event-types). sid: type: string minLength: 34 maxLength: 34 pattern: ^AE[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Event resource. source: type: string nullable: true - description: The originating system or interface that caused the event + description: 'The originating system or interface that caused the event. Can + be: `web` for events caused by user action in the Twilio Console, `api` + for events caused by a request to our API, or `twilio` for events caused + by an automated or internal Twilio system.' source_ip_address: type: string nullable: true - description: The IP address of the source + description: The IP address of the source, if the source is outside the + Twilio cloud. This value is `null` for events with `source` of `twilio` url: type: string format: uri nullable: true - description: The absolute URL of the resource that was affected + description: The absolute URL of the resource that was affected. Can be + `null`. links: type: object format: uri-map nullable: true - description: The absolute URLs of related resources + description: The absolute URLs of related resources. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_notify_v1.yaml b/spec/yaml/twilio_notify_v1.yaml index a672183c..a3de2e3b 100644 --- a/spec/yaml/twilio_notify_v1.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -9,76 +9,95 @@ components: maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Binding resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Binding resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) + the resource is associated with. credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Credential resource to be used to send notifications - to this Binding + description: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) + resource to be used to send notifications to this Binding. If present, + this overrides the Credential specified in the Service resource. Applicable + only to `apn`, `fcm`, and `gcm` type Bindings. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. notification_protocol_version: type: string nullable: true - description: The protocol version to use to send the notification + description: The protocol version to use to send the notification. This + defaults to the value of `default_xxxx_notification_protocol_version` + in the [Service](https://www.twilio.com/docs/notify/api/service-resource) + for the protocol. The current version is `"3"` for `apn`, `fcm`, and `gcm` + type Bindings. The parameter is not applicable to `sms` and `facebook-messenger` + type Bindings as the data format is fixed. endpoint: type: string nullable: true - description: Deprecated + description: Deprecated. identity: type: string nullable: true - description: The `identity` value that identifies the new resource's User + 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. binding_type: type: string nullable: true - description: The type of the Binding + description: 'The transport technology to use for the Binding. Can be: `apn`, + `fcm`, `gcm`, `sms`, or `facebook-messenger`.' address: type: string nullable: true - description: The channel-specific address + 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. tags: type: array items: type: string nullable: true - description: The list of tags associated with this Binding + 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. url: type: string format: uri nullable: true - description: The absolute URL of the Binding resource + description: The absolute URL of the Binding resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. binding_enum_binding_type: type: string enum: @@ -97,43 +116,47 @@ components: maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Credential + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Credential resource. 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. type: type: string $ref: '#/components/schemas/credential_enum_push_service' nullable: true - description: The Credential type, one of `gcm`, `fcm`, or `apn` + description: 'The Credential type. Can be: `gcm`, `fcm`, or `apn`.' sandbox: type: string nullable: true - description: '[APN only] Whether to send the credential to sandbox APNs' + description: '[APN only] Whether to send the credential to sandbox APNs. + Can be `true` to send to sandbox APNs or `false` to send to production.' date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri nullable: true - description: The absolute URL of the Credential resource + description: The absolute URL of the Credential resource. credential_enum_push_service: type: string enum: @@ -149,94 +172,154 @@ components: maxLength: 34 pattern: ^NT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Notification + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Notification resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) + the resource is associated with. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. identities: type: array items: type: string nullable: true - description: The list of identity values of the Users to notify + 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. tags: type: array items: type: string nullable: true - description: The tags that select the Bindings to notify + 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. segments: type: array items: type: string nullable: true - description: The list of Segments to notify + description: The list of Segments to notify. The [Segment](https://www.twilio.com/docs/notify/api/segment-resource) + resource is deprecated. Use the `tags` property, instead. priority: type: string $ref: '#/components/schemas/notification_enum_priority' nullable: true - description: The priority of the notification + description: 'The priority of the notification. Can be: `low` or `high` + and the default is `high`. A value of `low` optimizes the client app''s + battery consumption; however, notifications may be delivered with unspecified + delay. For FCM and GCM, `low` priority is the same as `Normal` priority. + For APNS `low` priority is the same as `5`. A value of `high` sends the + notification immediately, and can wake up a sleeping device. For FCM and + GCM, `high` is the same as `High` priority. For APNS, `high` is a priority + `10`. SMS does not support this property.' ttl: type: integer nullable: true - description: How long, in seconds, the notification is valid + description: How long, in seconds, the notification is valid. Can be an + integer between 0 and 2,419,200, which is 4 weeks, the default and the + maximum supported time to live (TTL). Delivery should be attempted if + the device is offline until the TTL elapses. Zero means that the notification + delivery is attempted immediately, only once, and is not stored for future + delivery. SMS does not support this property. title: type: string nullable: true - description: The notification title + description: The notification title. For FCM and GCM, this translates to + the `data.twi_title` value. For APNS, this translates to the `aps.alert.title` + value. SMS does not support this property. This field is not visible on + iOS phones and tablets but appears on Apple Watch and Android devices. body: type: string nullable: true - description: The notification body text + 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. sound: type: string nullable: true - description: The name of the sound to be played for the notification + description: The name of the sound to be played for the notification. For + FCM and GCM, this Translates to `data.twi_sound`. For APNS, this translates + to `aps.sound`. SMS does not support this property. action: type: string nullable: true - description: The actions to display for the notification + description: The actions to display for the notification. For APNS, translates + to the `aps.category` value. For GCM, translates to the `data.twi_action` + value. For SMS, this parameter is not supported and is omitted from deliveries + to those channels. data: nullable: true - description: The custom key-value pairs of the notification's payload + description: The custom key-value pairs of the notification's payload. For + FCM and GCM, this value translates to `data` in the FCM and GCM payloads. + FCM and GCM [reserve certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) + that cannot be used in those channels. For APNS, attributes of `data` + are inserted into the APNS payload as custom properties outside of the + `aps` dictionary. In all channels, we reserve keys that start with `twi_` + for future use. Custom keys that start with `twi_` are not allowed and + are rejected as 400 Bad request with no delivery attempted. For SMS, this + parameter is not supported and is omitted from deliveries to those channels. apn: nullable: true description: The APNS-specific payload that overrides corresponding attributes - in a generic payload for APNS Bindings + in the generic payload for APNS Bindings. This property maps to the APNS + `Payload` item, therefore the `aps` key must be used to change standard + attributes. Adds custom key-value pairs to the root of the dictionary. + See the [APNS documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) + for more details. We reserve keys that start with `twi_` for future use. + Custom keys that start with `twi_` are not allowed. gcm: nullable: true description: The GCM-specific payload that overrides corresponding attributes - in generic payload for GCM Bindings + in the generic payload for GCM Bindings. This property maps to the root + JSON dictionary. 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. fcm: nullable: true description: The FCM-specific payload that overrides corresponding attributes - in generic payload for FCM Bindings + in the generic payload for FCM Bindings. This property maps to the root + JSON dictionary. See the [FCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) + for more details. Target parameters `to`, `registration_ids`, `condition`, + and `notification_key` are not allowed in this parameter. We reserve keys + that start with `twi_` for future use. Custom keys that start with `twi_` + are not allowed. FCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref), + which cannot be used in that channel. sms: nullable: true - description: The SMS-specific payload that overrides corresponding attributes - in generic payload for SMS Bindings + 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/api/message-resource) + 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.' facebook_messenger: nullable: true - description: Deprecated + description: Deprecated. alexa: nullable: true - description: Deprecated + description: Deprecated. notification_enum_priority: type: string enum: @@ -251,103 +334,119 @@ components: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Service resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Service resource. 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. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. apn_credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Credential to use for APN Bindings + description: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) + to use for APN Bindings. gcm_credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Credential to use for GCM Bindings + description: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) + to use for GCM Bindings. fcm_credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Credential to use for FCM Bindings + description: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) + to use for FCM Bindings. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Messaging Service to use for SMS Bindings + 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. facebook_messenger_page_id: type: string nullable: true - description: Deprecated + description: Deprecated. default_apn_notification_protocol_version: type: string nullable: true - description: The protocol version to use for sending APNS notifications + description: The protocol version to use for sending APNS notifications. + Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) + resource. default_gcm_notification_protocol_version: type: string nullable: true - description: The protocol version to use for sending GCM notifications + description: The protocol version to use for sending GCM notifications. + Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) + resource. default_fcm_notification_protocol_version: type: string nullable: true - description: The protocol version to use for sending FCM notifications + description: The protocol version to use for sending FCM notifications. + Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) + resource. log_enabled: type: boolean nullable: true - description: Whether to log notifications + description: 'Whether to log notifications. Can be: `true` or `false` and + the default is `true`.' url: type: string format: uri nullable: true - description: The absolute URL of the Service resource + description: The absolute URL of the Service resource. links: type: object format: uri-map nullable: true - description: The URLs of the resources related to the service + description: The URLs of the Binding, Notification, Segment, and User resources + related to the service. alexa_skill_id: type: string nullable: true - description: Deprecated + description: Deprecated. default_alexa_notification_protocol_version: type: string nullable: true - description: Deprecated + description: Deprecated. delivery_callback_url: type: string nullable: true - description: Webhook URL + description: URL to send delivery status callback. delivery_callback_enabled: type: boolean nullable: true - description: Enable delivery callbacks + description: Callback configuration that enables delivery callbacks, default + false securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_numbers_v2.yaml b/spec/yaml/twilio_numbers_v2.yaml index a78106f7..4963e503 100644 --- a/spec/yaml/twilio_numbers_v2.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -9,40 +9,43 @@ components: maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource. + 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 that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Bundle resource. regulation_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true - description: The unique string of a regulation. + description: The unique string of a regulation that is associated to the + Bundle resource. 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. status: type: string $ref: '#/components/schemas/bundle_enum_status' nullable: true - description: The verification status of the Bundle resource + description: The verification status of the Bundle resource. valid_until: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource will be - valid until. + description: The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format when the resource will be valid until. email: type: string nullable: true - description: The email address + description: The email address that will receive updates when the Bundle + resource changes status. status_callback: type: string format: uri @@ -52,23 +55,24 @@ components: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 Bundle resource + description: The absolute URL of the Bundle resource. links: type: object format: uri-map nullable: true - description: The URLs of the Assigned Items of the Bundle resource + description: The URLs of the Assigned Items of the Bundle resource. bundle_enum_status: type: string enum: @@ -102,56 +106,60 @@ components: maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + 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 that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Bundle resource. regulation_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true - description: The unique string of a regulation + description: The unique string of a regulation that is associated to the + Bundle resource. 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. status: type: string $ref: '#/components/schemas/bundle_copy_enum_status' nullable: true - description: The verification status of the Bundle resource + description: The verification status of the Bundle resource. valid_until: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource will be - valid until + description: The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format when the resource will be valid until. email: type: string nullable: true - description: The email address + description: The email address that will receive updates when the Bundle + resource changes status. status_callback: type: string format: uri nullable: true - description: The URL we call to inform your application of status changes + description: The URL we call to inform your application of status changes. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. bundle_copy_enum_status: type: string enum: @@ -175,42 +183,47 @@ components: maxLength: 34 pattern: ^IT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string created by Twilio to identify the End User + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the End User resource. 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. type: type: string $ref: '#/components/schemas/end_user_enum_type' nullable: true - description: The type of end user of the Bundle resource + description: The type of end user of the Bundle resource - can be `individual` + or `business`. attributes: nullable: true - description: The set of parameters that compose the End Users resource + description: The set of parameters that are the attributes of the End Users + resource which are listed in the End User Types. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 End User resource + description: The absolute URL of the End User resource. end_user_enum_type: type: string enum: @@ -225,25 +238,30 @@ components: maxLength: 34 pattern: ^OY[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the End-User Type resource + description: The unique string that identifies the End-User Type resource. friendly_name: type: string nullable: true - description: A human-readable description of the End-User Type resource + description: A human-readable description that is assigned to describe the + End-User Type resource. Examples can include first name, last name, email, + business name, etc machine_name: type: string nullable: true - description: A machine-readable description of the End-User Type resource + description: A machine-readable description of the End-User Type resource. + Examples can include first_name, last_name, email, business_name, etc. fields: type: array items: {} nullable: true - description: The required information for creating an End-User. + description: The required information for creating an End-User. The required + fields will change as regulatory needs change and will differ for businesses + and individuals. url: type: string format: uri nullable: true - description: The absolute URL of the End-User Type resource + description: The absolute URL of the End-User Type resource. numbers.v2.regulatory_compliance.bundle.evaluation: type: object properties: @@ -253,38 +271,41 @@ components: maxLength: 34 pattern: ^EL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Evaluation resource + description: The unique string that identifies the Evaluation resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Bundle resource. regulation_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true - description: The unique string of a regulation + description: The unique string of a regulation that is associated to the + Bundle resource. bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Bundle resource. status: type: string $ref: '#/components/schemas/evaluation_enum_status' nullable: true - description: The compliance status of the Evaluation resource + description: The compliance status of the Evaluation resource. results: type: array items: {} nullable: true - description: The results of the Evaluation resource + description: The results of the Evaluation which includes the valid and + invalid attributes. date_created: type: string format: date-time @@ -307,38 +328,42 @@ components: maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + 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 identifies the Bundle resource. + 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 that created the resource + 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 + 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 ISO 8601 date and time in GMT when the resource was created + 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 + description: The absolute URL of the Identity resource. numbers.v2.regulatory_compliance.regulation: type: object properties: @@ -348,32 +373,39 @@ components: maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Regulation resource + description: The unique string that identifies the Regulation resource. friendly_name: type: string nullable: true - description: A human-readable description of the Regulation resource + 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 + 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 + 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 $ref: '#/components/schemas/regulation_enum_end_user_type' nullable: true - description: The type of End User of the Regulation resource + description: The type of End User the regulation requires - can be `individual` + or `business`. requirements: nullable: true - description: The sid of a regulation object that dictates requirements + description: The SID of an object that holds the regulatory information + of the phone number country, phone number type, and end user type. url: type: string format: uri nullable: true - description: The absolute URL of the Regulation resource + description: The absolute URL of the Regulation resource. regulation_enum_end_user_type: type: string enum: @@ -391,56 +423,60 @@ components: maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + 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 that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Bundle resource. regulation_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true - description: The unique string of a regulation + description: The unique string of a regulation that is associated to the + Bundle resource. 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. status: type: string $ref: '#/components/schemas/replace_items_enum_status' nullable: true - description: The verification status of the Bundle resource + description: The verification status of the Bundle resource. valid_until: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource will be - valid until + description: The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format when the resource will be valid until. email: type: string nullable: true - description: The email address + description: The email address that will receive updates when the Bundle + resource changes status. status_callback: type: string format: uri nullable: true - description: The URL we call to inform your application of status changes + description: The URL we call to inform your application of status changes. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. replace_items_enum_status: type: string enum: @@ -464,27 +500,29 @@ components: maxLength: 34 pattern: ^RD[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string created by Twilio to identify the Supporting + Document resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Document resource. 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. mime_type: type: string nullable: true - description: The image type of the file + description: The image type uploaded in the Supporting Document container. status: type: string $ref: '#/components/schemas/supporting_document_enum_status' nullable: true - description: The verification status of the Supporting Document resource + description: The verification status of the Supporting Document resource. failure_reason: type: string nullable: true @@ -492,27 +530,28 @@ components: type: type: string nullable: true - description: The type of the Supporting Document + description: The type of the Supporting Document. attributes: nullable: true - description: The set of parameters that compose the Supporting Documents - resource + description: The set of parameters that are the attributes of the Supporting + Documents resource which are listed in the Supporting Document Types. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 Supporting Document resource + description: The absolute URL of the Supporting Document resource. supporting_document_enum_status: type: string enum: @@ -532,27 +571,29 @@ components: pattern: ^OY[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Supporting Document Type - resource + resource. friendly_name: type: string nullable: true description: A human-readable description of the Supporting Document Type - resource + resource. machine_name: type: string nullable: true description: The machine-readable description of the Supporting Document - Type resource + Type resource. fields: type: array items: {} nullable: true - description: The required information for creating a Supporting Document + description: The required information for creating a Supporting Document. + The required fields will change as regulatory needs change and will differ + for businesses and individuals. url: type: string format: uri nullable: true - description: The absolute URL of the Supporting Document Type resource + description: The absolute URL of the Supporting Document Type resource. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_oauth_v1.yaml b/spec/yaml/twilio_oauth_v1.yaml index 8ca1f956..22166ab2 100644 --- a/spec/yaml/twilio_oauth_v1.yaml +++ b/spec/yaml/twilio_oauth_v1.yaml @@ -5,7 +5,8 @@ components: properties: keys: nullable: true - description: A collection of certificates + description: A collection of certificates where are signed Twilio-issued + tokens. url: type: string format: uri @@ -16,30 +17,31 @@ components: device_code: type: string nullable: true - description: The device verification code + description: The device verification code. user_code: type: string nullable: true - description: The verification code for the end user + 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 request + description: The URI that the end user visits to verify authorization request. verification_uri_complete: type: string nullable: true - description: he URI with user_code that the end-user alternatively visits - to verify request + 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 + 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 + wait between polling requests to the token endpoint. oauth.v1.openid_discovery: type: object properties: @@ -47,67 +49,79 @@ components: type: string format: uri nullable: true - description: The issuer URL + 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 URL of authorization endpoint + description: The endpoint that validates all authorization requests. device_authorization_endpoint: type: string format: uri nullable: true - description: The URL of device code authorization endpoint + description: The endpoint that validates all device code related authorization + requests. token_endpoint: type: string format: uri nullable: true - description: The URL of token endpoint + 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 user info endpoint + 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 URL of revocation endpoint + 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 public JWK endpoint + 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: List of response type supported for identity token + description: A collection of response type supported by authorization server. subject_type_supported: type: array items: type: string nullable: true - description: List of subject supported for identity token + description: A collection of subject by authorization server. id_token_signing_alg_values_supported: type: array items: type: string nullable: true - description: List of JWS signing algorithms supported for identity token + 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: List of scopes supported identity token + description: A collection of scopes supported by authorization server for + identity token claims_supported: type: array items: type: string nullable: true - description: List of claims supported for identity token + description: A collection of claims supported by authorization server for + identity token url: type: string format: uri @@ -119,12 +133,12 @@ components: type: string nullable: true description: Token which carries the necessary information to access a Twilio - resource directly + resource directly. refresh_token: type: string nullable: true description: Token which carries the information necessary to get a new - access token + access token. id_token: type: string nullable: true @@ -132,12 +146,14 @@ components: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the refresh token expires + 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 RFC 2822 date and time in GMT when the access token expires + 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: @@ -147,23 +163,24 @@ components: maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true - description: The user sid + 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 + description: The first name of the end-user. last_name: type: string nullable: true - description: The last name of the end-user + description: The last name of the end-user. friendly_name: type: string nullable: true - description: The friendly name of the end-user + description: The friendly name of the end-user. email: type: string nullable: true - description: The end-user's preferred email address + description: The end-user's preferred email address. url: type: string format: uri diff --git a/spec/yaml/twilio_preview.yaml b/spec/yaml/twilio_preview.yaml index c3f00d88..497aed1f 100644 --- a/spec/yaml/twilio_preview.yaml +++ b/spec/yaml/twilio_preview.yaml @@ -9,48 +9,56 @@ components: maxLength: 34 pattern: ^CY[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Certificate. + description: Contains a 34 character string that uniquely identifies this + Certificate credential resource. url: type: string format: uri nullable: true - description: URL of this Certificate. + description: Contains an absolute URL for this Certificate credential resource. friendly_name: type: string nullable: true - description: A human readable description for this Certificate. + description: Contains a human readable descriptive text for this Certificate + credential, up to 256 characters long. fleet_sid: type: string nullable: true - description: The unique identifier of the Fleet. + 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 that identifies this Account. + description: Specifies the unique string identifier of the Account responsible + for this Certificate credential. device_sid: type: string minLength: 34 maxLength: 34 pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - description: The unique identifier of a mapped Device. + description: Specifies the unique string identifier of a Device authenticated + with this Certificate credential. thumbprint: type: string nullable: true - description: A Certificate unique payload hash. + 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: The date this Certificate was created. + description: Specifies the date this Certificate credential was created, + given in UTC ISO 8601 format. date_updated: type: string format: date-time nullable: true - description: The date this Certificate was updated. + description: Specifies the date this Certificate credential was last updated, + given in UTC ISO 8601 format. preview.deployed_devices.fleet.deployment: type: object properties: @@ -60,44 +68,51 @@ components: maxLength: 34 pattern: ^DL[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Deployment. + description: Contains a 34 character string that uniquely identifies this + Deployment resource. url: type: string format: uri nullable: true - description: URL of this Deployment. + description: Contains an absolute URL for this Deployment resource. friendly_name: type: string nullable: true - description: A human readable description for this Deployment + description: Contains a human readable descriptive text for this Deployment, + up to 64 characters long fleet_sid: type: string nullable: true - description: The unique identifier of the Fleet. + description: Specifies the unique string identifier of the Fleet that the + given Deployment belongs to. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique SID that identifies this Account. + description: Specifies the unique string identifier of the Account responsible + for this Deployment. sync_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique identifier of the Sync service instance. + description: Specifies the unique string identifier of the Twilio Sync service + instance linked to and accessible by this Deployment. date_created: type: string format: date-time nullable: true - description: The date this Deployment was created. + description: Specifies the date this Deployment was created, given in UTC + ISO 8601 format. date_updated: type: string format: date-time nullable: true - description: The date this Deployment was updated. + description: Specifies the date this Deployment was last updated, given + in UTC ISO 8601 format. preview.deployed_devices.fleet.device: type: object properties: @@ -107,61 +122,73 @@ components: maxLength: 34 pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Device. + description: Contains a 34 character string that uniquely identifies this + Device resource. url: type: string format: uri nullable: true - description: URL of this Device. + description: Contains an absolute URL for this Device resource. unique_name: type: string nullable: true - description: A unique, addressable name of this Device. + description: Contains a unique and addressable name of this Device, assigned + by the developer, up to 128 characters long. friendly_name: type: string nullable: true - description: A human readable description for this Device + description: Contains a human readable descriptive text for this Device, + up to 256 characters long fleet_sid: type: string nullable: true - description: The unique identifier of the Fleet. + description: Specifies the unique string identifier of the Fleet that the + given Device belongs to. enabled: type: boolean nullable: true - description: Device enabled flag. + 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 - description: The unique SID that identifies this Account. + description: Specifies the unique string identifier of the Account responsible + for this Device. identity: type: string nullable: true - description: An identifier of the Device user. + description: Contains an arbitrary string identifier representing a human + user associated with this Device, assigned by the developer, up to 256 + characters long. deployment_sid: type: string minLength: 34 maxLength: 34 pattern: ^DL[0-9a-fA-F]{32}$ nullable: true - description: The unique SID of the Deployment group. + 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 this Device 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 this Device was updated. + description: Specifies the date this Device was last updated, given in UTC + ISO 8601 format. date_authenticated: type: string format: date-time nullable: true - description: The date this Device was authenticated. + description: Specifies the date this Device was last authenticated, given + in UTC ISO 8601 format. preview.deployed_devices.fleet: type: object properties: @@ -171,49 +198,57 @@ components: maxLength: 34 pattern: ^TH[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Fleet. + description: Contains a 34 character string that uniquely identifies this + Fleet resource. url: type: string format: uri nullable: true - description: URL of this Fleet. + description: Contains an absolute URL for this Fleet resource. unique_name: type: string nullable: true - description: A unique, addressable name of this Fleet. + 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: A human readable description for this Fleet. + 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 SID that identifies this Account. + 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: The unique SID that identifies this Fleet's default Deployment. + 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 this Fleet 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 this Fleet was updated. + description: Specifies the date this Fleet was last updated, given in UTC + ISO 8601 format. links: type: object format: uri-map nullable: true - description: Nested resource URLs. + description: Contains a dictionary of URL links to nested resources of this + Fleet. preview.deployed_devices.fleet.key: type: object properties: @@ -223,48 +258,56 @@ components: maxLength: 34 pattern: ^KY[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Key. + description: Contains a 34 character string that uniquely identifies this + Key credential resource. url: type: string format: uri nullable: true - description: URL of this Key. + description: Contains an absolute URL for this Key credential resource. friendly_name: type: string nullable: true - description: A human readable description for this Key. + description: Contains a human readable descriptive text for this Key credential, + up to 256 characters long. fleet_sid: type: string nullable: true - description: The unique identifier of the Fleet. + 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: The unique SID that identifies this Account. + 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: The unique identifier of a mapped Device. + description: Specifies the unique string identifier of a Device authenticated + with this Key credential. secret: type: string nullable: true - description: The key secret. + 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: The date this Key credential was created. + 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: The date this Key credential was updated. + description: Specifies the date this Key credential was last updated, given + in UTC ISO 8601 format. preview.hosted_numbers.authorization_document: type: object properties: @@ -274,39 +317,46 @@ components: maxLength: 34 pattern: ^PX[0-9a-fA-F]{32}$ nullable: true - description: AuthorizationDocument sid. + 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: Address sid. + 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: The Status of this AuthorizationDocument. + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' email: type: string nullable: true - description: Email. + description: Email that this AuthorizationDocument will be sent to for signing. cc_emails: type: array items: type: string nullable: true - description: A list of emails. + 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 AuthorizationDocument was created. + 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 this AuthorizationDocument was updated. + 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 @@ -332,40 +382,44 @@ components: maxLength: 34 pattern: ^HR[0-9a-fA-F]{32}$ nullable: true - description: HostedNumberOrder sid. + 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: Account sid. + 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: IncomingPhoneNumber sid. + 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: Address 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: ^PX[0-9a-fA-F]{32}$ nullable: true - description: LOA document sid. + 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. + description: An E164 formatted phone number hosted by this HostedNumberOrder. capabilities: type: object format: phone-number-capabilities @@ -379,70 +433,84 @@ components: fax: type: boolean nullable: true - description: A mapping of phone number capabilities. + 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. + description: A human readable description of this resource, up to 64 characters. unique_name: type: string nullable: true - description: A unique, developer assigned name of this HostedNumberOrder. + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in + addition to SID. status: type: string $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' nullable: true - description: The Status of this HostedNumberOrder. + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' failure_reason: type: string nullable: true - description: Why a hosted_number_order reached status "action-required" + 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 HostedNumberOrder was created. + 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 this HostedNumberOrder was updated. + 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. + number that is being hosted. email: type: string nullable: true - description: Email. + 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. + description: Email recipients who will be informed when an Authorization + Document has been sent and signed verification_type: type: string $ref: '#/components/schemas/dependent_hosted_number_order_enum_verification_type' nullable: true description: The method used for verifying ownership of the number to be - hosted. + hosted. One of phone-call (default) or phone-bill. verification_document_sid: type: string minLength: 34 maxLength: 34 pattern: ^RI[0-9a-fA-F]{32}$ nullable: true - description: Verification Document Sid. + 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: Phone extension to use for ownership verification call. + description: A numerical extension to be used when making the ownership + verification call. call_delay: type: integer nullable: true - description: Seconds (0-30) to delay ownership verification call by. + description: A value between 0-30 specifying the number of seconds to delay + initiating the ownership verification call. verification_code: type: string nullable: true @@ -452,7 +520,8 @@ components: items: type: string nullable: true - description: List of IDs for ownership verification calls. + 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: @@ -479,40 +548,45 @@ components: maxLength: 34 pattern: ^HR[0-9a-fA-F]{32}$ nullable: true - description: HostedNumberOrder sid. + 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: Account Sid. + 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: IncomingPhoneNumber sid. + 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: Address 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: ^PX[0-9a-fA-F]{32}$ nullable: true - description: LOA document sid. + 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: An E164 formatted phone number. + 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 @@ -526,49 +600,61 @@ components: fax: type: boolean nullable: true - description: A mapping of phone number capabilities. + 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. + description: A 64 character string that is a human-readable text that describes + this resource. unique_name: type: string nullable: true - description: A unique, developer assigned name of this HostedNumberOrder. + 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: The Status of this HostedNumberOrder. + 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: Why a hosted_number_order reached status "action-required" + 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 HostedNumberOrder was created. + 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 this HostedNumberOrder was updated. + 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. + number that is being hosted. email: type: string nullable: true - description: Email. + 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. + description: A list of emails that LOA document for this HostedNumberOrder + will be carbon copied to. url: type: string format: uri @@ -578,33 +664,39 @@ components: type: string $ref: '#/components/schemas/hosted_number_order_enum_verification_type' nullable: true - description: The method used for verifying ownership of the number to be - hosted. + 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: Verification Document Sid. + 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: Phone extension to use for ownership verification call. + description: A numerical extension to be used when making the ownership + verification call. call_delay: type: integer nullable: true - description: Seconds (0-30) to delay ownership verification call by. + description: A value between 0-30 specifying the number of seconds to delay + initiating the ownership verification call. verification_code: type: string nullable: true - description: The digits passed during the ownership verification call. + description: A verification code provided in the response for a user to + enter when they pick up the phone call. verification_call_sids: type: array items: type: string nullable: true - description: List of IDs for ownership verification calls. + 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: @@ -631,33 +723,34 @@ components: maxLength: 34 pattern: ^XB[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + 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: The string that you assigned to describe the resource. description: type: string nullable: true - description: A short description of the Add-on's functionality + 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 + 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 + when installing a given Add-on. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. preview.marketplace.available_add_on.available_add_on_extension: type: object properties: @@ -667,7 +760,8 @@ components: maxLength: 34 pattern: ^XF[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the AvailableAddOnExtension + resource. available_add_on_sid: type: string minLength: 34 @@ -675,25 +769,25 @@ components: pattern: ^XB[0-9a-fA-F]{32}$ nullable: true description: The SID of the AvailableAddOn resource to which this extension - applies + 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 nullable: true - description: The name of the Extension's Product + description: The name of the Product this Extension is used within. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. preview.marketplace.installed_add_on: type: object properties: @@ -703,52 +797,56 @@ components: maxLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the InstalledAddOn + resource. This Sid can also be found in the Console on that specific Add-ons + page as the 'Available Add-on Sid'. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the InstalledAddOn resource. friendly_name: type: string nullable: true - description: The string that you assigned to describe the resource + description: The string that you assigned to describe the resource. description: type: string nullable: true - description: A short description of the Add-on's functionality + description: A short description of the Add-on's functionality. configuration: nullable: true description: The JSON object that represents the current configuration of - installed Add-on + installed Add-on. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. preview.marketplace.installed_add_on.installed_add_on_extension: type: object properties: @@ -758,7 +856,8 @@ components: maxLength: 34 pattern: ^XF[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the InstalledAddOn + Extension resource. installed_add_on_sid: type: string minLength: 34 @@ -766,29 +865,29 @@ components: pattern: ^XE[0-9a-fA-F]{32}$ nullable: true description: The SID of the InstalledAddOn resource to which this extension - applies + 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 nullable: true - description: The name of the Extension's Product + description: The name of the Product this Extension is used within. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. enabled: type: boolean nullable: true - description: Whether the Extension will be invoked + description: Whether the Extension will be invoked. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. preview.sync.service.document: type: object properties: @@ -846,42 +945,47 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Twilio Account SID. + description: The unique SID identifier of the Twilio Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: Sync Service Instance SID. + description: The unique SID identifier of the Sync Service Instance. document_sid: type: string minLength: 34 maxLength: 34 pattern: ^ET[0-9a-fA-F]{32}$ nullable: true - description: Sync Document SID. + description: The unique SID identifier of the Sync Document to which the + Permission applies. identity: type: string nullable: true - description: Identity of the user to whom the Sync Document Permission applies. + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. read: type: boolean nullable: true - description: Read access. + description: Boolean flag specifying whether the identity can read the Sync + Document. write: type: boolean nullable: true - description: Write access. + description: Boolean flag specifying whether the identity can update the + Sync Document. manage: type: boolean nullable: true - description: Manage access. + description: Boolean flag specifying whether the identity can delete the + Sync Document. url: type: string format: uri nullable: true - description: URL of this Sync Document Permission. + description: Contains an absolute URL for this Sync Document Permission. preview.sync.service: type: object properties: @@ -1035,42 +1139,47 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Twilio Account SID. + description: The unique SID identifier of the Twilio Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: Sync Service Instance SID. + description: The unique SID identifier of the Sync Service Instance. list_sid: type: string minLength: 34 maxLength: 34 pattern: ^ES[0-9a-fA-F]{32}$ nullable: true - description: Sync List SID. + description: The unique SID identifier of the Sync List to which the Permission + applies. identity: type: string nullable: true - description: Identity of the user to whom the Sync List Permission applies. + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. read: type: boolean nullable: true - description: Read access. + description: Boolean flag specifying whether the identity can read the Sync + List and its Items. write: type: boolean nullable: true - description: Write access. + description: Boolean flag specifying whether the identity can create, update + and delete Items of the Sync List. manage: type: boolean nullable: true - description: Manage access. + description: Boolean flag specifying whether the identity can delete the + Sync List. url: type: string format: uri nullable: true - description: URL of this Sync List Permission. + description: Contains an absolute URL for this Sync List Permission. preview.sync.service.sync_map: type: object properties: @@ -1180,42 +1289,47 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Twilio Account SID. + description: The unique SID identifier of the Twilio Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: Sync Service Instance SID. + description: The unique SID identifier of the Sync Service Instance. map_sid: type: string minLength: 34 maxLength: 34 pattern: ^MP[0-9a-fA-F]{32}$ nullable: true - description: Sync Map SID. + description: The unique SID identifier of the Sync Map to which the Permission + applies. identity: type: string nullable: true - description: Identity of the user to whom the Sync Map Permission applies. + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. read: type: boolean nullable: true - description: Read access. + description: Boolean flag specifying whether the identity can read the Sync + Map and its Items. write: type: boolean nullable: true - description: Write access. + description: Boolean flag specifying whether the identity can create, update + and delete Items of the Sync Map. manage: type: boolean nullable: true - description: Manage access. + description: Boolean flag specifying whether the identity can delete the + Sync Map. url: type: string format: uri nullable: true - description: URL of this Sync Map Permission. + description: Contains an absolute URL for this Sync Map Permission. preview.understand.assistant: type: object properties: @@ -1381,8 +1495,9 @@ components: field_type: type: string nullable: true - description: The Field Type of this field. It can be any Built-in Field - Type or unique_name or the Field Type sid of a custom Field Type. + 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: type: string minLength: 34 @@ -1722,8 +1837,8 @@ components: 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' + 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: diff --git a/spec/yaml/twilio_pricing_v1.yaml b/spec/yaml/twilio_pricing_v1.yaml index ece9c681..e65d25a9 100644 --- a/spec/yaml/twilio_pricing_v1.yaml +++ b/spec/yaml/twilio_pricing_v1.yaml @@ -20,29 +20,29 @@ components: country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. pricing.v1.messaging.messaging_country-instance: type: object properties: country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). outbound_sms_prices: type: array items: @@ -67,7 +67,9 @@ components: number_type: type: string nullable: true - description: The list of OutboundSMSPrice records + description: The list of [OutboundSMSPrice](https://www.twilio.com/docs/sms/api/pricing#outbound-sms-price) + records that represent the price to send a message for each MCC/MNC applicable + in this country. inbound_sms_prices: type: array items: @@ -81,18 +83,21 @@ components: number_type: type: string nullable: true - description: The list of InboundPrice records + description: The list of [InboundPrice](https://www.twilio.com/docs/sms/api/pricing#inbound-price) + records that describe the price to receive an inbound SMS to the different + Twilio phone number types supported in this country price_unit: type: string format: currency nullable: true - description: The currency in which prices are measured, in ISO 4127 format - (e.g. usd, eur, jpy) + description: The currency in which prices are measured, specified in [ISO + 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format + (e.g. `usd`, `eur`, `jpy`). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. pricing.v1.phone_number: type: object properties: @@ -113,29 +118,29 @@ components: country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: 'The ISO country code ' + description: The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. pricing.v1.phone_number.phone_number_country-instance: type: object properties: country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: 'The ISO country code ' + description: The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). phone_number_prices: type: array items: @@ -149,18 +154,20 @@ components: number_type: type: string nullable: true - description: The list of PhoneNumberPrices records + description: The list of [PhoneNumberPrice](https://www.twilio.com/docs/phone-numbers/pricing#phone-number-price) + records. price_unit: type: string format: currency nullable: true - description: The currency in which prices are measured, in ISO 4127 format - (e.g. usd, eur, jpy) + description: The currency in which prices are measured, specified in [ISO + 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format + (e.g. `usd`, `eur`, `jpy`). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. pricing.v1.voice: type: object properties: @@ -181,29 +188,29 @@ components: country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. pricing.v1.voice.voice_country-instance: type: object properties: country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). outbound_prefix_prices: type: array items: @@ -221,7 +228,9 @@ components: friendly_name: type: string nullable: true - description: The list of OutboundPrefixPrice records + description: The list of OutboundPrefixPrice records, which include a list + of the `prefixes`, the `friendly_name`, `base_price`, and the `current_price` + for those prefixes. inbound_call_prices: type: array items: @@ -235,18 +244,20 @@ components: number_type: type: string nullable: true - description: The list of InboundCallPrice records + description: The list of [InboundCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) + records. price_unit: type: string format: currency nullable: true - description: The currency in which prices are measured, in ISO 4127 format - (e.g. usd, eur, jpy) + description: The currency in which prices are measured, specified in [ISO + 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format + (e.g. `usd`, `eur`, `jpy`). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. pricing.v1.voice.voice_number: type: object properties: @@ -254,16 +265,16 @@ components: type: string format: phone-number nullable: true - description: The phone number + description: The phone number. country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). outbound_call_price: type: object format: outbound-call-price @@ -273,7 +284,8 @@ components: current_price: type: number nullable: true - description: The OutboundCallPrice record + description: The OutboundCallPrice record, which includes a list of `origination_prefixes` + and the `base_price` and `current_price` for those prefixes. inbound_call_price: type: object format: inbound-call-price @@ -285,18 +297,21 @@ components: number_type: type: string nullable: true - description: The InboundCallPrice record + description: The [InboundCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) + record. If `null`, the Phone Number is not a Twilio number owned by this + account. price_unit: type: string format: currency nullable: true - description: The currency in which prices are measured, in ISO 4127 format - (e.g. usd, eur, jpy) + description: The currency in which prices are measured, specified in [ISO + 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format + (e.g. `usd`, `eur`, `jpy`). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_pricing_v2.yaml b/spec/yaml/twilio_pricing_v2.yaml index 117d530d..9a3fab7b 100644 --- a/spec/yaml/twilio_pricing_v2.yaml +++ b/spec/yaml/twilio_pricing_v2.yaml @@ -6,29 +6,29 @@ components: country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. pricing.v2.trunking_country-instance: type: object properties: country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). terminating_prefix_prices: type: array items: @@ -50,7 +50,8 @@ components: friendly_name: type: string nullable: true - description: The list of TerminatingPrefixPrice records + description: The list of [TerminatingPrefixPrice](https://www.twilio.com/docs/voice/pricing#outbound-prefix-price-with-origin) + records. originating_call_prices: type: array items: @@ -64,18 +65,20 @@ components: number_type: type: string nullable: true - description: The list of OriginatingCallPrice records + description: The list of [OriginatingCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) + records. price_unit: type: string format: currency nullable: true - description: The currency in which prices are measured, in ISO 4127 format - (e.g. usd, eur, jpy) + description: The currency in which prices are measured, specified in [ISO + 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format + (e.g. `usd`, `eur`, `jpy`). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. pricing.v2.trunking_number: type: object properties: @@ -83,21 +86,25 @@ components: type: string format: phone-number nullable: true - description: The destination phone number, in E.164 format + description: The destination 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. origination_number: type: string format: phone-number nullable: true - description: The origination phone number, in E.164 format + description: The origination 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. country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) terminating_prefix_prices: type: array items: @@ -130,64 +137,66 @@ components: number_type: type: string nullable: true - description: The OriginatingCallPrice record + description: The [OriginatingCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) + record. price_unit: type: string format: currency nullable: true - description: The currency in which prices are measured, in ISO 4127 format - (e.g. usd, eur, jpy) + description: The currency in which prices are measured, specified in [ISO + 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format + (e.g. `usd`, `eur`, `jpy`). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. pricing.v2.voice: type: object properties: name: type: string nullable: true - description: The resource name + description: The resource name. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of the related Countries and Numbers resources + description: The URLs of the related Countries and Numbers resources. pricing.v2.voice.voice_country: type: object properties: country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. pricing.v2.voice.voice_country-instance: type: object properties: country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). outbound_prefix_prices: type: array items: @@ -209,7 +218,8 @@ components: friendly_name: type: string nullable: true - description: The list of OutboundPrefixPriceWithOrigin records + description: The list of [OutboundPrefixPriceWithOrigin](https://www.twilio.com/docs/voice/pricing#outbound-prefix-price-with-origin) + records. inbound_call_prices: type: array items: @@ -223,18 +233,20 @@ components: number_type: type: string nullable: true - description: The list of InboundCallPrice records + description: The list of [InboundCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) + records. price_unit: type: string format: currency nullable: true - description: The currency in which prices are measured, in ISO 4127 format - (e.g. usd, eur, jpy) + description: The currency in which prices are measured, specified in [ISO + 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format + (e.g. `usd`, `eur`, `jpy`). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. pricing.v2.voice.voice_number: type: object properties: @@ -242,21 +254,25 @@ components: type: string format: phone-number nullable: true - description: The destination phone number, in E.164 format + description: The destination 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. origination_number: type: string format: phone-number nullable: true - description: The origination phone number, in E.164 format + description: The origination 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. country: type: string nullable: true - description: The name of the country + description: The name of the country. iso_country: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) outbound_call_prices: type: array items: @@ -272,7 +288,8 @@ components: items: type: string nullable: true - description: The list of OutboundCallPriceWithOrigin records + description: The list of [OutboundCallPriceWithOrigin](https://www.twilio.com/docs/voice/pricing#outbound-call-price-with-origin) + records. inbound_call_price: type: object format: inbound-call-price @@ -284,18 +301,20 @@ components: number_type: type: string nullable: true - description: The InboundCallPrice record + description: The [InboundCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) + record. price_unit: type: string format: currency nullable: true - description: The currency in which prices are measured, in ISO 4127 format - (e.g. usd, eur, jpy) + description: The currency in which prices are measured, specified in [ISO + 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format + (e.g. `usd`, `eur`, `jpy`). url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_proxy_v1.yaml b/spec/yaml/twilio_proxy_v1.yaml index bd45878e..83e6337c 100644 --- a/spec/yaml/twilio_proxy_v1.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -9,60 +9,71 @@ components: maxLength: 34 pattern: ^KI[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Interaction + resource. session_sid: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource's parent Session + description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) + resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource's parent Service + description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Interaction resource. data: type: string nullable: true - description: A JSON string that includes the message body of message interactions + 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"}`).' type: type: string $ref: '#/components/schemas/interaction_enum_type' nullable: true - description: The Type of the Interaction + description: 'The Type of the Interaction. Can be: `message`, `voice` or + `unknown`.' inbound_participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true - description: The SID of the inbound Participant resource + description: The SID of the inbound [Participant](https://www.twilio.com/docs/proxy/api/participant) + resource. inbound_resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the inbound resource + 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. inbound_resource_status: type: string $ref: '#/components/schemas/interaction_enum_resource_status' nullable: true - description: The inbound resource status of the Interaction + description: The inbound resource status of the Interaction. Will always + be `delivered` for messages and `in-progress` for calls. inbound_resource_type: type: string nullable: true - description: The inbound resource type + description: The inbound resource type. Can be [Call](https://www.twilio.com/docs/voice/api/call-resource) + or [Message](https://www.twilio.com/docs/sms/api/message-resource). inbound_resource_url: type: string format: uri @@ -74,45 +85,51 @@ components: maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true - description: The SID of the outbound Participant + description: The SID of the outbound [Participant](https://www.twilio.com/docs/proxy/api/participant)). outbound_resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the outbound resource + description: The SID of the outbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) + or [Message](https://www.twilio.com/docs/sms/api/message-resource). outbound_resource_status: type: string $ref: '#/components/schemas/interaction_enum_resource_status' nullable: true - description: The outbound resource status of the Interaction + description: 'The outbound resource status of the Interaction. Can be: `accepted`, + `canceled`, `deleted`, `delivered`, `delivery-unknown`, `failed`, `partially-delivered`, + `queued`, `read`, `received`, `receiving`, `scheduled`, `sending`, `sent`, + `undelivered`, or `unknown` for messages. Can be `initiated` or `completed` + or `unknown` for calls.' outbound_resource_type: type: string nullable: true - description: The outbound resource type + description: 'The outbound resource type. Can be: [Call](https://www.twilio.com/docs/voice/api/call-resource) + or [Message](https://www.twilio.com/docs/sms/api/message-resource).' outbound_resource_url: type: string format: uri nullable: true - description: The URL of the Twilio outbound resource + description: The URL of the Twilio outbound resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Interaction was - created + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the Interaction was created. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was last updated. url: type: string format: uri nullable: true - description: The absolute URL of the Interaction resource + description: The absolute URL of the Interaction resource. interaction_enum_type: type: string enum: @@ -152,116 +169,127 @@ components: maxLength: 34 pattern: ^KI[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the MessageInteraction + resource. session_sid: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource's parent Session + description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) + resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource's parent Service + description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the MessageInteraction resource. data: type: string nullable: true - description: A JSON string that includes the message body sent to the participant + description: 'A JSON string that includes the message body sent to the participant. + (e.g. `{"body": "hello"}`)' type: type: string $ref: '#/components/schemas/message_interaction_enum_type' nullable: true - description: The Type of Message Interaction + description: The Type of Message Interaction. This value is always `message`. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Participant resource + description: The SID of the [Participant](https://www.twilio.com/docs/proxy/api/participant) + resource. inbound_participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true - description: Always empty for Message Interactions + description: Always empty for created Message Interactions. inbound_resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: Always empty for Message Interactions + description: Always empty for created Message Interactions. inbound_resource_status: type: string $ref: '#/components/schemas/message_interaction_enum_resource_status' nullable: true - description: Always empty for Message Interactions + description: Always empty for created Message Interactions. inbound_resource_type: type: string nullable: true - description: Always empty for Message Interactions + description: Always empty for created Message Interactions. inbound_resource_url: type: string format: uri nullable: true - description: Always empty for Message Interactions + description: Always empty for created Message Interactions. outbound_participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true - description: The SID of the outbound Participant resource + description: The SID of the outbound [Participant](https://www.twilio.com/docs/proxy/api/participant) + resource. outbound_resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the outbound Message resource + description: The SID of the outbound [Message](https://www.twilio.com/docs/sms/api/message-resource) + resource. outbound_resource_status: type: string $ref: '#/components/schemas/message_interaction_enum_resource_status' nullable: true - description: The outbound resource status + description: 'The outbound message resource status. Can be: `accepted`, + `deleted`, `delivered`, `delivery-unknown`, `failed`, `queued`, `received`, + `receiving`, `scheduled`, `sending`, `sent`, `undelivered`, or `unknown`.' outbound_resource_type: type: string nullable: true - description: The outbound resource type + description: The outbound resource type. This value is always `Message`. outbound_resource_url: type: string format: uri nullable: true - description: The URL of the Twilio message resource + description: The URL of the Twilio message resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was created. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was last updated. url: type: string format: uri nullable: true - description: The absolute URL of the MessageInteraction resource + description: The absolute URL of the MessageInteraction resource. message_interaction_enum_type: type: string enum: @@ -301,73 +329,84 @@ components: maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Participant + resource. session_sid: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource's parent Session + description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) + resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource's parent Service + description: The SID of the resource's parent [Service](https://www.twilio.com/docs/proxy/api/service) + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Participant resource. friendly_name: type: string nullable: true - description: The string that you assigned to describe the participant + description: The string that you assigned to describe the participant. This + value must be 255 characters or fewer. Supports UTF-8 characters. **This + value should not have PII.** identifier: type: string nullable: true - description: The phone number or channel identifier of the Participant + description: The phone number or channel identifier of the Participant. + This value must be 191 characters or fewer. Supports UTF-8 characters. proxy_identifier: type: string nullable: true - description: The phone number or short code of the participant's partner + description: The phone number or short code (masked number) of the participant's + partner. The participant will call or message the partner participant + at this number. proxy_identifier_sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Proxy Identifier assigned to the Participant + description: The SID of the Proxy Identifier assigned to the Participant. date_deleted: type: string format: date-time nullable: true - description: The ISO 8601 date the Participant was removed + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + when the Participant was removed from the session. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was created. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was last updated. url: type: string format: uri nullable: true - description: The absolute URL of the Participant resource + description: The absolute URL of the Participant resource. links: type: object format: uri-map nullable: true - description: The URLs to resources related the participant + description: The URLs to resources related the participant. proxy.v1.service.phone_number: type: object properties: @@ -377,45 +416,51 @@ components: maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the PhoneNumber + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the PhoneNumber resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the PhoneNumber resource's parent Service resource + description: The SID of the PhoneNumber resource's parent [Service](https://www.twilio.com/docs/proxy/api/service) + resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was created. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was last updated. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. 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. iso_country: type: string nullable: true - description: The ISO Country Code + description: The ISO Country Code for the phone number. capabilities: type: object format: phone-number-capabilities @@ -429,21 +474,24 @@ components: fax: type: boolean nullable: true - description: The capabilities of the phone number + description: The capabilities of the phone number. url: type: string format: uri nullable: true - description: The absolute URL of the PhoneNumber resource + description: The absolute URL of the PhoneNumber resource. is_reserved: type: boolean nullable: true - description: Reserve the phone number for manual assignment to participants - only + 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. in_use: type: integer nullable: true - description: The number of open session assigned to the number. + description: The number of open session assigned to the number. See the + [How many Phone Numbers do I need?](https://www.twilio.com/docs/proxy/phone-numbers-needed) + guide for more information. proxy.v1.service: type: object properties: @@ -453,78 +501,103 @@ components: maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Service resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. This value must be 191 characters or fewer in length and be + unique. Supports UTF-8 characters. **This value should not have PII.** account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Service resource. chat_instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Chat Service Instance + 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. callback_url: type: string format: uri nullable: true - description: The URL we call when the interaction status changes + description: The URL we call when the interaction status changes. default_ttl: type: integer nullable: true - description: Default TTL for a Session, in seconds + description: The default `ttl` value for Sessions created in the Service. + The TTL (time to live) is measured in seconds after the Session's last + create or last Interaction. The default value of `0` indicates an unlimited + Session length. You can override a Session's default TTL value by setting + its `ttl` value. number_selection_behavior: type: string $ref: '#/components/schemas/service_enum_number_selection_behavior' nullable: true - description: The preference for Proxy Number selection for the Service instance + description: 'The preference for Proxy Number selection in the Service instance. + Can be: `prefer-sticky` or `avoid-sticky`. `prefer-sticky` means that + we will try and select the same Proxy Number for a given participant if + they have previous [Sessions](https://www.twilio.com/docs/proxy/api/session), + but we will not fail if that Proxy Number cannot be used. `avoid-sticky` + means that we will try to use different Proxy Numbers as long as that + is possible within a given pool rather than try and use a previously assigned + number.' geo_match_level: type: string $ref: '#/components/schemas/service_enum_geo_match_level' nullable: true - description: Where a proxy number must be located relative to the participant - identifier + description: 'Where a proxy number must be located relative to the participant + identifier. Can be: `country`, `area-code`, or `extended-area-code`. The + default value is `country` and more specific areas than `country` are + only available in North America.' intercept_callback_url: type: string format: uri nullable: true - description: The URL we call on each interaction + description: The URL we call on each interaction. If we receive a 403 status, + we block the interaction; otherwise the interaction continues. out_of_session_callback_url: 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 + 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. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was created. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was last updated. url: type: string format: uri nullable: true - description: The absolute URL of the Service resource + description: The absolute URL of the Service resource. links: type: object format: uri-map nullable: true - description: The URLs of resources related to the Service + description: The URLs of resources related to the Service. service_enum_geo_match_level: type: string enum: @@ -546,85 +619,97 @@ components: maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Session resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource's parent Service + description: The SID of the [Service](https://www.twilio.com/docs/proxy/api/service) + the session is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Session resource. date_started: type: string format: date-time nullable: true - description: The ISO 8601 date when the Session started + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + when the Session started. date_ended: type: string format: date-time nullable: true - description: The ISO 8601 date when the Session ended + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + when the Session ended. date_last_interaction: type: string format: date-time nullable: true - description: The ISO 8601 date when the Session last had an interaction + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + when the Session last had an interaction. date_expiry: type: string format: date-time nullable: true - description: The ISO 8601 date when the Session should expire + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + when the Session should expire. If this is value is present, it overrides + the `ttl` value. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. This value must be 191 characters or fewer in length and be + unique. Supports UTF-8 characters. **This value should not have PII.** status: type: string $ref: '#/components/schemas/session_enum_status' nullable: true - description: The status of the Session + description: 'The status of the Session. Can be: `open`, `in-progress`, + `closed`, `failed`, or `unknown`.' closed_reason: type: string nullable: true - description: The reason the Session ended + description: The reason the Session ended. ttl: type: integer nullable: true - description: When the session will expire + description: The time, in seconds, when the session will expire. The time + is measured from the last Session create or the Session's last Interaction. mode: type: string $ref: '#/components/schemas/session_enum_mode' nullable: true - description: The Mode of the Session + description: 'The Mode of the Session. Can be: `message-only`, `voice-only`, + or `voice-and-message`.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was created. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was last updated. url: type: string format: uri nullable: true - description: The absolute URL of the Session resource + description: The absolute URL of the Session resource. links: type: object format: uri-map nullable: true - description: The URLs of resources related to the Session + description: The URLs of resources related to the Session. session_enum_status: type: string enum: @@ -648,40 +733,44 @@ components: maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the ShortCode + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the ShortCode resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource's parent Service + description: The SID of the ShortCode resource's parent [Service](https://www.twilio.com/docs/proxy/api/service) + resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was created. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the resource was last updated. short_code: type: string nullable: true - description: The short code's number + description: The short code's number. iso_country: type: string nullable: true - description: The ISO Country Code + description: The ISO Country Code for the short code. capabilities: type: object format: phone-number-capabilities @@ -695,17 +784,18 @@ components: fax: type: boolean nullable: true - description: The capabilities of the short code + description: The capabilities of the short code. url: type: string format: uri nullable: true - description: The absolute URL of the ShortCode resource + description: The absolute URL of the ShortCode resource. is_reserved: type: boolean nullable: true - description: Whether the short code should be reserved for manual assignment - to participants only + 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 diff --git a/spec/yaml/twilio_routes_v2.yaml b/spec/yaml/twilio_routes_v2.yaml index ca062182..e3dc3da5 100644 --- a/spec/yaml/twilio_routes_v2.yaml +++ b/spec/yaml/twilio_routes_v2.yaml @@ -6,32 +6,32 @@ components: phone_number: type: string nullable: true - description: The phone number + description: The phone number in E.164 format url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^QQ[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies the Inbound Processing Region - assignments for this phone number. + description: A 34 character string that uniquely identifies the Inbound + Processing Region assignments for this phone number. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account Sid. + description: The unique SID identifier of the Account. friendly_name: type: string nullable: true description: A human readable description of the Inbound Processing Region - assignments for this phone number. + assignments for this phone number, up to 64 characters. voice_region: type: string nullable: true @@ -42,13 +42,13 @@ components: format: date-time nullable: true description: The date that this phone number was assigned an Inbound Processing - Region. + Region, given in ISO 8601 format. date_updated: type: string format: date-time nullable: true description: The date that the Inbound Processing Region was updated for - this phone number. + this phone number, given in ISO 8601 format. routes.v2.sip_domain: type: object properties: @@ -91,32 +91,32 @@ components: sip_trunk_domain: type: string nullable: true - description: The SIP Trunk + description: The absolute URL of the SIP Trunk url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^QQ[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies the Inbound Processing Region - assignments for this SIP Trunk. + description: A 34 character string that uniquely identifies the Inbound + Processing Region assignments for this SIP Trunk. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account Sid. + description: The unique SID identifier of the Account. friendly_name: type: string nullable: true description: A human readable description of the Inbound Processing Region - assignments for this SIP Trunk. + assignments for this SIP Trunk, up to 64 characters. voice_region: type: string nullable: true @@ -126,13 +126,13 @@ components: format: date-time nullable: true description: The date that this SIP Trunk was assigned an Inbound Processing - Region. + Region, given in ISO 8601 format. date_updated: type: string format: date-time nullable: true description: The date that the Inbound Processing Region was updated for - this SIP Trunk. + this SIP Trunk, given in ISO 8601 format. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_serverless_v1.yaml b/spec/yaml/twilio_serverless_v1.yaml index 5c427f92..049f2fab 100644 --- a/spec/yaml/twilio_serverless_v1.yaml +++ b/spec/yaml/twilio_serverless_v1.yaml @@ -9,14 +9,15 @@ components: maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Asset resource + description: The unique string that we created to identify the Asset resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Asset resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Asset resource. service_sid: type: string minLength: 34 @@ -24,33 +25,34 @@ components: pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Asset resource is associated - with + with. friendly_name: type: string nullable: true - description: The string that you assigned to describe the Asset resource + description: The string that you assigned to describe the Asset resource. + It can be a maximum of 255 characters. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Asset resource was - created + description: The date and time in GMT when the Asset 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 ISO 8601 date and time in GMT when the Asset resource was - last updated + description: The date and time in GMT when the Asset 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 Asset resource + description: The absolute URL of the Asset resource. links: type: object format: uri-map nullable: true - description: The URLs of the Asset resource's nested resources + description: The URLs of the Asset resource's nested resources. serverless.v1.service.asset.asset_version: type: object properties: @@ -60,14 +62,16 @@ components: maxLength: 34 pattern: ^ZN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Asset Version resource + description: The unique string that we created to identify the Asset Version + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Asset Version resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Asset Version resource. service_sid: type: string minLength: 34 @@ -75,7 +79,7 @@ components: pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Asset Version resource is associated - with + with. asset_sid: type: string minLength: 34 @@ -83,28 +87,33 @@ components: pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true description: The SID of the Asset resource that is the parent of the Asset - Version + Version. path: type: string nullable: true - description: The URL-friendly string by which the Asset Version can be referenced + 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. visibility: type: string $ref: '#/components/schemas/asset_version_enum_visibility' nullable: true - description: The access control that determines how the Asset Version can - be accessed + description: 'The access control that determines how the Asset Version resource + can be accessed. Can be: `public`, `protected`, or `private`.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Asset Version resource - was created + description: The date and time in GMT when the Asset Version 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 Asset Version resource + description: The absolute URL of the Asset Version resource. asset_version_enum_visibility: type: string enum: @@ -120,14 +129,15 @@ components: maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Build resource + description: The unique string that we created to identify the Build resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Build resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Build resource. service_sid: type: string minLength: 34 @@ -135,52 +145,54 @@ components: pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Build resource is associated - with + with. status: type: string $ref: '#/components/schemas/build_enum_status' nullable: true - description: The status of the Build + description: 'The status of the Build. Can be: `building`, `completed`, + or `failed`.' asset_versions: type: array items: {} nullable: true description: The list of Asset Version resource SIDs that are included in - the Build + the Build. function_versions: type: array items: {} nullable: true description: The list of Function Version resource SIDs that are included - in the Build + in the Build. dependencies: type: array items: {} nullable: true description: A list of objects that describe the Dependencies included in - the Build + the Build. Each object contains the `name` and `version` of the dependency. runtime: type: string $ref: '#/components/schemas/build_enum_runtime' nullable: true - description: The Runtime version that will be used to run the Build. + description: The Runtime version that will be used to run the Build resource + when it is deployed. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Build resource was - created + description: The date and time in GMT when the Build 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 ISO 8601 date and time in GMT when the Build resource was - last updated + description: The date and time in GMT when the Build 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 Build resource + description: The absolute URL of the Build resource. links: type: object format: uri-map @@ -208,14 +220,15 @@ components: maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Build resource + description: The unique string that we created to identify the Build resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Build resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Build resource. service_sid: type: string minLength: 34 @@ -223,17 +236,18 @@ components: pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Build resource is associated - with + with. status: type: string $ref: '#/components/schemas/build_status_enum_status' nullable: true - description: The status of the Build + description: 'The status of the Build. Can be: `building`, `completed`, + or `failed`.' url: type: string format: uri nullable: true - description: The absolute URL of the Build Status resource + description: The absolute URL of the Build Status resource. build_status_enum_status: type: string enum: @@ -249,14 +263,16 @@ components: maxLength: 34 pattern: ^ZD[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Deployment resource + description: The unique string that we created to identify the Deployment + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Deployment resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Deployment resource. service_sid: type: string minLength: 34 @@ -264,38 +280,39 @@ components: pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Deployment resource is associated - with + with. environment_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Environment for the Deployment + description: The SID of the Environment for the Deployment. build_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Build for the deployment + description: The SID of the Build for the deployment. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Deployment resource - was created + description: The date and time in GMT when the Deployment 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 ISO 8601 date and time in GMT when the Deployment resource - was last updated + description: The date and time in GMT when the Deployment 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 Deployment resource + description: The absolute URL of the Deployment resource. serverless.v1.service.environment: type: object properties: @@ -305,14 +322,16 @@ components: maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Environment resource + description: The unique string that we created to identify the Environment + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Environment resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Environment resource. service_sid: type: string minLength: 34 @@ -320,50 +339,54 @@ components: pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Environment resource is associated - with + with. build_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ nullable: true - description: The SID of the build deployed in the environment + description: The SID of the build deployed in the environment. unique_name: type: string nullable: true description: A user-defined string that uniquely identifies the Environment - resource + resource. domain_suffix: type: string nullable: true - description: A URL-friendly name that represents the environment + description: A URL-friendly name that represents the environment and forms + part of the domain name. domain_name: type: string nullable: true description: The domain name for all Functions and Assets deployed in the - Environment + Environment, using the Service unique name, a randomly-generated Service + suffix, and an optional Environment domain suffix. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Environment resource - was created + description: The date and time in GMT when the Environment 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 ISO 8601 date and time in GMT when the Environment resource - was last updated + description: The date and time in GMT when the Environment 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 Environment resource + description: The absolute URL of the Environment resource. links: type: object format: uri-map nullable: true - description: The URLs of the Environment resource's nested resources + description: The URLs of the Environment resource's nested resources. serverless.v1.service.function: type: object properties: @@ -373,14 +396,16 @@ components: maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Function resource + description: The unique string that we created to identify the Function + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Function resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Function resource. service_sid: type: string minLength: 34 @@ -388,33 +413,35 @@ components: pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Function resource is associated - with + with. friendly_name: type: string nullable: true - description: The string that you assigned to describe the Function resource + description: The string that you assigned to describe the Function resource. + It can be a maximum of 255 characters. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Function resource - was created + description: The date and time in GMT when the Function 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 ISO 8601 date and time in GMT when the Function resource - was last updated + description: The date and time in GMT when the Function 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 Function resource + description: The absolute URL of the Function resource. links: type: object format: uri-map nullable: true - description: The URLs of nested resources of the Function resource + description: The URLs of nested resources of the Function resource. serverless.v1.service.function.function_version: type: object properties: @@ -424,14 +451,16 @@ components: maxLength: 34 pattern: ^ZN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Function Version resource + description: The unique string that we created to identify the Function + Version resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Function Version resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Function Version resource. service_sid: type: string minLength: 34 @@ -439,7 +468,7 @@ components: pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Function Version resource is - associated with + associated with. function_sid: type: string minLength: 34 @@ -447,29 +476,33 @@ components: pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true description: The SID of the Function resource that is the parent of the - Function Version resource + Function Version resource. path: type: string nullable: true description: The URL-friendly string by which the Function Version resource - can be referenced + 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. visibility: type: string $ref: '#/components/schemas/function_version_enum_visibility' nullable: true - description: The access control that determines how the Function Version - resource can be accessed + description: 'The access control that determines how the Function Version + resource can be accessed. Can be: `public`, `protected`, or `private`.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Function Version - resource was created + description: The date and time in GMT when the Function Version 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 Function Version resource + description: The absolute URL of the Function Version resource. links: type: object format: uri-map @@ -489,14 +522,16 @@ components: maxLength: 34 pattern: ^ZN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Function Version resource + description: The unique string that we created to identify the Function + Version resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Function Version resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Function Version resource. service_sid: type: string minLength: 34 @@ -504,7 +539,7 @@ components: pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Function Version resource is - associated with + associated with. function_sid: type: string minLength: 34 @@ -512,11 +547,11 @@ components: pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true description: The SID of the Function that is the parent of the Function - Version + Version. content: type: string nullable: true - description: The content of the Function Version resource + description: The content of the Function Version resource. url: type: string format: uri @@ -530,14 +565,15 @@ components: maxLength: 34 pattern: ^NO[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Log resource + description: The unique string that we created to identify the Log resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Log resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Log resource. service_sid: type: string minLength: 34 @@ -545,62 +581,62 @@ components: pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Log resource is associated - with + with. environment_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ nullable: true - description: The SID of the environment in which the log occurred + description: The SID of the environment in which the log occurred. build_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ nullable: true - description: The SID of the build that corresponds to the log + description: The SID of the build that corresponds to the log. deployment_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZD[0-9a-fA-F]{32}$ nullable: true - description: The SID of the deployment that corresponds to the log + description: The SID of the deployment that corresponds to the log. function_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true - description: The SID of the function whose invocation produced the log + description: The SID of the function whose invocation produced the log. request_sid: type: string minLength: 34 maxLength: 34 pattern: ^RQ[0-9a-fA-F]{32}$ nullable: true - description: The SID of the request associated with the log + description: The SID of the request associated with the log. level: type: string $ref: '#/components/schemas/log_enum_level' nullable: true - description: The log level + description: 'The log level. Can be: `info`, `warn`, or `error`.' message: type: string nullable: true - description: The log message + description: The log message. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Log resource was - created + description: The date and time in GMT when the Log 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 Log resource + description: The absolute URL of the Log resource. log_enum_level: type: string enum: @@ -616,60 +652,63 @@ components: maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Service resource + description: The unique string that we created to identify the Service resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Service resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Service resource. 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. unique_name: type: string nullable: true description: A user-defined string that uniquely identifies the Service - resource + resource. It can be used in place of the Service resource's `sid` in the + URL to address the Service resource. include_credentials: type: boolean nullable: true description: Whether to inject Account credentials into a function invocation - context + context. ui_editable: type: boolean nullable: true description: Whether the Service resource's properties and subresources - can be edited via the UI + can be edited via the UI. domain_base: type: string nullable: true description: The base domain name for this Service, which is a combination - of the unique name and a randomly generated string + of the unique name and a randomly generated string. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Service resource - was created + description: The date and time in GMT when the Service 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 ISO 8601 date and time in GMT when the Service resource - was last updated + description: The date and time in GMT when the Service 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 Service resource + description: The absolute URL of the Service resource. links: type: object format: uri-map nullable: true - description: The URLs of the Service's nested resources + description: The URLs of the Service's nested resources. serverless.v1.service.environment.variable: type: object properties: @@ -679,14 +718,16 @@ components: maxLength: 34 pattern: ^ZV[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Variable resource + description: The unique string that we created to identify the Variable + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the Variable resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Variable resource. service_sid: type: string minLength: 34 @@ -694,39 +735,40 @@ components: pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Variable resource is associated - with + with. environment_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Environment in which the Variable exists + description: The SID of the Environment in which the Variable exists. 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. 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. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Variable resource - was created + description: The date and time in GMT when the Variable 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 ISO 8601 date and time in GMT when the Variable resource - was last updated + description: The date and time in GMT when the Variable 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 Variable resource + description: The absolute URL of the Variable resource. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_studio_v1.yaml b/spec/yaml/twilio_studio_v1.yaml index 00d19feb..d69db3ab 100644 --- a/spec/yaml/twilio_studio_v1.yaml +++ b/spec/yaml/twilio_studio_v1.yaml @@ -9,62 +9,70 @@ components: maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Engagement + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Engagement resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flow + description: The SID of the Flow. contact_sid: type: string minLength: 34 maxLength: 34 pattern: ^FC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Contact + description: The SID of the Contact. contact_channel_address: type: string nullable: true description: The phone number, SIP address or Client identifier that triggered - this Engagement + this Engagement. Phone numbers are in E.164 format (+16175551212). SIP + addresses are formatted as `name@company.com`. Client identifiers are + formatted `client:name`. context: nullable: true - description: The current state of the execution flow + description: The current state of the execution flow. As your flow executes, + we save the state in a flow context. Your widgets can access the data + in the flow context as variables, either in configuration fields or in + text areas as variable substitution. status: type: string $ref: '#/components/schemas/engagement_enum_status' nullable: true - description: The status of the Engagement + description: 'The status of the Engagement. Can be: `active` or `ended`.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Engagement was created + description: The date and time in GMT when the Engagement was created in + [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Engagement was last - updated + description: The date and time in GMT when the Engagement was updated in + [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of the Engagement's nested resources + description: The URLs of the Engagement's nested resources. engagement_enum_status: type: string enum: @@ -79,29 +87,32 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account SID + description: The SID of the Account. context: nullable: true - description: Flow state + description: As your flow executes, we save the state in what's called the + Flow Context. Any data in the flow context can be accessed by your widgets + as variables, either in configuration fields or in text areas as variable + substitution. engagement_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: Engagement SID + description: The SID of the Engagement. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: Flow SID + description: The SID of the Flow. url: type: string format: uri nullable: true - description: The URL of the resource + description: The URL of the resource. studio.v1.flow.execution: type: object properties: @@ -111,62 +122,70 @@ components: maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Execution + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Execution resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flow + description: The SID of the Flow. contact_sid: type: string minLength: 34 maxLength: 34 pattern: ^FC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Contact + description: The SID of the Contact. contact_channel_address: type: string nullable: true description: The phone number, SIP address or Client identifier that triggered - the Execution + 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`. context: nullable: true - description: The current state of the flow + 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. status: type: string $ref: '#/components/schemas/execution_enum_status' nullable: true - description: The status of the Execution + description: 'The status of the Execution. Can be: `active` or `ended`.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: Nested resource URLs + description: The URLs of nested resources. execution_enum_status: type: string enum: @@ -181,29 +200,33 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the ExecutionContext resource. context: nullable: true - description: The current state of the flow + 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. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flow + description: The SID of the Flow. execution_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Execution + description: The SID of the context's Execution resource. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. studio.v1.flow.execution.execution_step: type: object properties: @@ -213,64 +236,70 @@ components: maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the ExecutionStep + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the ExecutionStep resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flow + description: The SID of the Flow. execution_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Execution + description: The SID of the Step's Execution resource. name: type: string nullable: true - description: The event that caused the Flow to transition to the Step + description: The event that caused the Flow to transition to the Step. context: nullable: true - description: The current state of the flow + 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. transitioned_from: type: string nullable: true - description: The Widget that preceded the Widget for the Step + description: The Widget that preceded the Widget for the Step. transitioned_to: type: string nullable: true - description: The Widget that will follow the Widget for the Step + description: The Widget that will follow the Widget for the Step. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. studio.v1.flow.execution.execution_step.execution_step_context: type: object properties: @@ -280,36 +309,40 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the ExecutionStepContext resource. context: nullable: true - description: The current state of the flow + 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. execution_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Execution + description: The SID of the context's Execution resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flow + description: The SID of the Flow. step_sid: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true - description: Step SID + description: The SID of the Step that the context is associated with. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. studio.v1.flow: type: object properties: @@ -319,48 +352,50 @@ components: maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Flow resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Flow resource. friendly_name: type: string nullable: true - description: The string that you assigned to describe the Flow + description: The string that you assigned to describe the Flow. status: type: string $ref: '#/components/schemas/flow_enum_status' nullable: true - description: The status of the Flow + description: 'The status of the Flow. Can be: `draft` or `published`.' version: type: integer nullable: true - description: The latest version number of the Flow's definition + description: The latest version number of the Flow's definition. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: Nested resource URLs + description: The URLs of the Flow's nested resources. flow_enum_status: type: string enum: @@ -375,64 +410,69 @@ components: maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Step resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Step resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flow + description: The SID of the Flow. engagement_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Engagement + description: The SID of the Engagement. name: type: string nullable: true - description: The event that caused the Flow to transition to the Step + description: The event that caused the Flow to transition to the Step. context: nullable: true - description: The current state of the flow + 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. transitioned_from: type: string nullable: true - description: The Widget that preceded the Widget for the Step + description: The Widget that preceded the Widget for the Step. transitioned_to: type: string nullable: true - description: The Widget that will follow the Widget for the Step + description: The Widget that will follow the Widget for the Step. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. studio.v1.flow.engagement.step.step_context: type: object properties: @@ -442,36 +482,40 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the StepContext resource. context: nullable: true - description: The current state of the flow + 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. engagement_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Engagement + description: The SID of the Engagement. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flow + description: The SID of the Flow. step_sid: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true - description: Step SID + description: The SID of the Step the context is associated with. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_studio_v2.yaml b/spec/yaml/twilio_studio_v2.yaml index ac956eaa..dfb15b29 100644 --- a/spec/yaml/twilio_studio_v2.yaml +++ b/spec/yaml/twilio_studio_v2.yaml @@ -9,55 +9,63 @@ components: maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Execution + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Execution resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flow + description: The SID of the Flow. contact_channel_address: type: string nullable: true description: The phone number, SIP address or Client identifier that triggered - the Execution + 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`. context: nullable: true - description: The current state of the flow + 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. status: type: string $ref: '#/components/schemas/execution_enum_status' nullable: true - description: The status of the Execution + description: 'The status of the Execution. Can be: `active` or `ended`.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: Nested resource URLs + description: The URLs of nested resources. execution_enum_status: type: string enum: @@ -72,29 +80,33 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the ExecutionContext resource. context: nullable: true - description: The current state of the flow + 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. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flow + description: The SID of the Flow. execution_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Execution + description: The SID of the context's Execution resource. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. studio.v2.flow.execution.execution_step: type: object properties: @@ -104,64 +116,70 @@ components: maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the ExecutionStep + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the ExecutionStep resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flow + description: The SID of the Flow. execution_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Execution + description: The SID of the Step's Execution resource. name: type: string nullable: true - description: The event that caused the Flow to transition to the Step + description: The event that caused the Flow to transition to the Step. context: nullable: true - description: The current state of the flow + 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. transitioned_from: type: string nullable: true - description: The Widget that preceded the Widget for the Step + description: The Widget that preceded the Widget for the Step. transitioned_to: type: string nullable: true - description: The Widget that will follow the Widget for the Step + description: The Widget that will follow the Widget for the Step. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. studio.v2.flow.execution.execution_step.execution_step_context: type: object properties: @@ -171,36 +189,40 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the ExecutionStepContext resource. context: nullable: true - description: The current state of the flow + 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. execution_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Execution + description: The SID of the context's Execution resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flow + description: The SID of the Flow. step_sid: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true - description: Step SID + description: The SID of the Step that the context is associated with. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. studio.v2.flow: type: object properties: @@ -210,59 +232,61 @@ components: maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Flow resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Flow resource. friendly_name: type: string nullable: true - description: The string that you assigned to describe the Flow + description: The string that you assigned to describe the Flow. definition: nullable: true - description: JSON representation of flow definition + description: JSON representation of flow definition. status: type: string $ref: '#/components/schemas/flow_enum_status' nullable: true - description: The status of the Flow + description: 'The status of the Flow. Can be: `draft` or `published`.' revision: type: integer nullable: true - description: The latest revision number of the Flow's definition + description: The latest revision number of the Flow's definition. commit_message: type: string nullable: true - description: Description of change made in the revision + description: Description of change made in the revision. valid: type: boolean nullable: true - description: Boolean if the flow definition is valid + description: Boolean if the flow definition is valid. errors: type: array items: {} nullable: true - description: List of error in the flow definition + description: List of error in the flow definition. warnings: type: array items: {} nullable: true - description: List of warnings in the flow definition + description: List of warnings in the flow definition. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. webhook_url: type: string format: uri @@ -271,12 +295,12 @@ components: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: Nested resource URLs + description: The URLs of the Flow's nested resources. flow_enum_status: type: string enum: @@ -291,59 +315,61 @@ components: maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Flow resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Flow resource. friendly_name: type: string nullable: true - description: The string that you assigned to describe the Flow + description: The string that you assigned to describe the Flow. definition: nullable: true - description: JSON representation of flow definition + description: JSON representation of flow definition. status: type: string $ref: '#/components/schemas/flow_revision_enum_status' nullable: true - description: The status of the Flow + description: 'The status of the Flow. Can be: `draft` or `published`.' revision: type: integer nullable: true - description: The latest revision number of the Flow's definition + description: The latest revision number of the Flow's definition. commit_message: type: string nullable: true - description: Description of change made in the revision + description: Description of change made in the revision. valid: type: boolean nullable: true - description: Boolean if the flow definition is valid + description: Boolean if the flow definition is valid. errors: type: array items: {} nullable: true - description: List of error in the flow definition + description: List of error in the flow definition. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. flow_revision_enum_status: type: string enum: @@ -355,7 +381,7 @@ components: valid: type: boolean nullable: true - description: Boolean if the flow definition is valid + description: Boolean if the flow definition is valid. flow_validate_enum_status: type: string enum: diff --git a/spec/yaml/twilio_supersim_v1.yaml b/spec/yaml/twilio_supersim_v1.yaml index 782d8c95..8851a7ff 100644 --- a/spec/yaml/twilio_supersim_v1.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -9,47 +9,51 @@ components: maxLength: 34 pattern: ^HB[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Billing Period + description: The SID of the Billing Period. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account the Super SIM belongs to + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + the Super SIM belongs to. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Super SIM the Billing Period belongs to + description: The SID of the Super SIM the Billing Period belongs to. start_time: type: string format: date-time nullable: true - description: The start time of the Billing Period + description: The start time of the Billing Period specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. end_time: type: string format: date-time nullable: true - description: The end time of the Billing Period + description: The end time of the Billing Period specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. period_type: type: string $ref: '#/components/schemas/billing_period_enum_bp_type' nullable: true - description: The type of the Billing Period + description: The type of Billing Period. Can be `ready` or `active`. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. billing_period_enum_bp_type: type: string enum: @@ -64,66 +68,74 @@ components: maxLength: 34 pattern: ^HP[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the eSIM Profile + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account to which the eSIM Profile resource belongs + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + to which the eSIM Profile resource belongs. iccid: type: string nullable: true - description: The ICCID associated with the Sim resource + description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) + associated with the Sim resource. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sim resource that this eSIM Profile controls + description: The SID of the [Sim](https://www.twilio.com/docs/wireless/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 + 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.' eid: type: string nullable: true - description: Identifier of the eUICC that can claim the eSIM Profile + description: Identifier of the eUICC that can claim the eSIM Profile. smdp_plus_address: type: string format: uri nullable: true description: Address of the SM-DP+ server from which the Profile will be - downloaded + downloaded. The URL will appear once the eSIM Profile reaches the status + `available`. error_code: type: string nullable: true description: Code indicating the failure if the download of the SIM Profile - failed and the eSIM Profile is in `failed` state + failed and the eSIM Profile is in `failed` state. error_message: type: string nullable: true description: Error message describing the failure if the download of the - SIM Profile failed and the eSIM Profile is in `failed` state + SIM Profile failed and the eSIM Profile is in `failed` state. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 eSIM Profile resource + description: The absolute URL of the eSIM Profile resource. esim_profile_enum_status: type: string enum: @@ -142,61 +154,69 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Fleet resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^HF[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Fleet resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 Fleet resource + description: The absolute URL of the Fleet resource. data_enabled: type: boolean nullable: true - description: Defines whether SIMs in the Fleet are capable of using data - connectivity + description: Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M + data connectivity. Defaults to `true`. data_limit: type: integer nullable: true description: The total data usage (download and upload combined) in Megabytes - that each Super SIM assigned to the Fleet can consume + 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). data_metering: type: string $ref: '#/components/schemas/fleet_enum_data_metering' nullable: true - description: The model by which a SIM is metered and billed + description: The model by which a SIMs usage is metered and billed. Defaults + to `payg`. sms_commands_enabled: type: boolean nullable: true description: Defines whether SIMs in the Fleet are capable of sending and - receiving machine-to-machine SMS via Commands + receiving machine-to-machine SMS via Commands. Defaults to `true`. sms_commands_url: type: string format: uri nullable: true description: The URL that will receive a webhook when a Super SIM in the - Fleet is used to send an SMS from your device to the SMS Commands number + Fleet is used to send an SMS from your device to the SMS Commands number. + Your server should respond with an HTTP status code in the 200 range; + any response body will be ignored. sms_commands_method: type: string format: http-method @@ -209,20 +229,24 @@ components: - DELETE nullable: true description: A string representing the HTTP method to use when making a - request to `sms_commands_url` + request to `sms_commands_url`. Can be one of `POST` or `GET`. Defaults + to `POST`. network_access_profile_sid: type: string minLength: 34 maxLength: 34 pattern: ^HA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Network Access Profile of the Fleet + description: The SID of the Network Access Profile that controls which cellular + networks the Fleet's SIMs can connect to. ip_commands_url: type: string format: uri nullable: true description: The URL that will receive a webhook when a Super SIM in the - Fleet is used to send an IP Command from your device + Fleet is used to send an IP Command from your device to a special IP address. + Your server should respond with an HTTP status code in the 200 range; + any response body will be ignored. ip_commands_method: type: string format: http-method @@ -235,7 +259,8 @@ components: - DELETE nullable: true description: A string representing the HTTP method to use when making a - request to `ip_commands_url` + request to `ip_commands_url`. Can be one of `POST` or `GET`. Defaults + to `POST`. fleet_enum_data_metering: type: string enum: @@ -249,72 +274,93 @@ components: maxLength: 34 pattern: ^HG[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the IP Command + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the IP Command resource. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Super SIM that this IP Command was sent to or - from + description: The SID of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) + that this IP Command was sent to or from. sim_iccid: type: string nullable: true - description: The ICCID of the Super SIM that this IP Command was sent to - or from + description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) + of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) + that this IP Command was sent to or from. status: type: string $ref: '#/components/schemas/ip_command_enum_status' nullable: true - description: The status of the IP Command + description: "The delivery status of the IP Command. This is one of the\ + \ following: \u201Cqueued\u201D, \u201Csent\u201D, \u201Cfailed\u201D\ + \ or \u201Creceived\u201D." direction: type: string $ref: '#/components/schemas/ip_command_enum_direction' nullable: true - description: The direction of the IP Command + description: Either `to_sim` or `from_sim`. Indicates whether the IP Command + resource was sent from or to the Super SIM. device_ip: type: string nullable: true - description: The IP address of the device that the IP Command was sent to - or received from + description: "The IP address of the device that the IP Command was sent\ + \ to or received from. For an IP Command sent to a Super SIM, `device_ip`\ + \ starts out as `null`, and once the IP Command is \u201Csent\u201D, the\ + \ `device_ip` will be filled out. An IP Command sent from a Super SIM\ + \ have its `device_ip` always set." device_port: type: integer nullable: true - description: The port that the IP Command either originated from or was - sent to + description: For an IP Command sent to a Super SIM, it would be the destination + port of the IP message. For an IP Command sent from a Super SIM, it would + be the source port of the IP message. payload_type: type: string $ref: '#/components/schemas/ip_command_enum_payload_type' nullable: true - description: The payload type of the IP Command + description: "Either \u201Ctext\u201D or \u201Cbinary\u201D. For an IP Command\ + \ sent to a Super SIM, `payload_type` is configurable. For an IP Command\ + \ sent from a Super SIM, `payload_type` is always \u201Cbinary\u201D." payload: type: string nullable: true - description: The payload of the IP Command sent to or from the Super SIM + 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." date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 IP Command resource + description: The absolute URL of the IP Command resource. ip_command_enum_status: type: string enum: @@ -341,25 +387,27 @@ components: maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Network resource. friendly_name: type: string nullable: true - description: A human readable identifier of this resource + description: A human readable identifier of this resource. url: type: string format: uri nullable: true - description: The absolute URL of the Network resource + description: The absolute URL of the Network resource. iso_country: type: string nullable: true - description: The ISO country code of the Network resource + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + of the Network resource. identifiers: type: array items: {} nullable: true - description: The MCC/MNCs included in the Network resource + description: Array of objects identifying the [MCC-MNCs](https://en.wikipedia.org/wiki/Mobile_country_code) + that are included in the Network resource. supersim.v1.network_access_profile: type: object properties: @@ -369,36 +417,39 @@ components: maxLength: 34 pattern: ^HA[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that identifies the Network Access Profile + resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that the Network Access Profile belongs - to + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that the Network Access Profile belongs to. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the Network Access Profile resource. links: type: object format: uri-map @@ -412,33 +463,36 @@ components: maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that identifies the Network resource. network_access_profile_sid: type: string minLength: 34 maxLength: 34 pattern: ^HA[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Network Access Profile - resource + description: The unique string that identifies the Network resource's Network + Access Profile resource. friendly_name: type: string nullable: true - description: A human readable identifier of this resource + description: A human readable identifier of the Network this resource refers + to. iso_country: type: string nullable: true - description: The ISO country code of the Network resource + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + of the Network resource. identifiers: type: array items: {} nullable: true - description: The MCC/MNCs included in the resource + description: Array of objects identifying the [MCC-MNCs](https://en.wikipedia.org/wiki/Mobile_country_code) + that are included in the Network resource. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the Network resource. supersim.v1.settings_update: type: object properties: @@ -448,11 +502,12 @@ components: maxLength: 34 pattern: ^OB[0-9a-fA-F]{32}$ nullable: true - description: The unique identifier of this Settings Update + description: The unique identifier of this Settings Update. iccid: type: string nullable: true - description: The ICCID associated with the SIM + description: The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated + with the SIM. sim_sid: type: string minLength: 34 @@ -460,34 +515,40 @@ components: pattern: ^HS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Super SIM to which this Settings Update was - applied + applied. status: type: string $ref: '#/components/schemas/settings_update_enum_status' nullable: true - description: The Status of this Settings Update + description: The Status of this Settings Update. One of `scheduled`, `in-progress`, + `successful` or `failed`. packages: type: array items: {} nullable: true description: Array containing the different Settings Packages that will - be applied to the SIM after the update completes + be applied to the SIM after the update completes. Each object within the + array indicates the name and the version of the Settings Package that + will be on the SIM if the update is successful. date_completed: type: string format: date-time nullable: true - description: The time when the update successfully completed and the new - settings were applied to the SIM + description: The time, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format, when the update successfully completed and the new settings were + applied to the SIM. date_created: type: string format: date-time nullable: true - description: The date this Settings Update was created + description: The date that this Settings Update was created, given in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true - description: The date this Settings Update was last updated + description: The date that this Settings Update was updated, given in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format. settings_update_enum_status: type: string enum: @@ -504,51 +565,57 @@ components: maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that identifies the Sim resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that the Super SIM belongs to + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that the Super SIM belongs to. iccid: type: string nullable: true - description: The ICCID associated with the SIM + description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) + associated with the SIM. status: type: string $ref: '#/components/schemas/sim_enum_status' nullable: true - description: The status of the Super SIM + description: The status of the Super SIM. Can be `new`, `ready`, `active`, + `inactive`, or `scheduled`. See the [Super SIM Status Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values) + for a description of each. fleet_sid: type: string minLength: 34 maxLength: 34 pattern: ^HF[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Fleet configured for this SIM + description: The unique ID of the Fleet configured for this SIM. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 Sim Resource + description: The absolute URL of the Sim Resource. links: type: object format: uri-map @@ -578,7 +645,7 @@ components: type: string $ref: '#/components/schemas/sim_ip_address_enum_ip_address_version' nullable: true - description: IP address version + description: IP address version of the corresponding IP address sim_ip_address_enum_ip_address_version: type: string enum: @@ -593,51 +660,60 @@ components: maxLength: 34 pattern: ^HC[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the SMS Command + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the SMS Command resource. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the SIM that this SMS Command was sent to or from + description: The SID of the [SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) + that this SMS Command was sent to or from. payload: type: string nullable: true - description: The message body of the SMS Command sent to or from the SIM + 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. status: type: string $ref: '#/components/schemas/sms_command_enum_status' nullable: true - description: The status of the SMS Command + description: 'The status of the SMS Command. Can be: `queued`, `sent`, `delivered`, + `received` or `failed`. See the [SMS Command Status Values](https://www.twilio.com/docs/wireless/api/smscommand-resource#status-values) + for a description of each.' direction: type: string $ref: '#/components/schemas/sms_command_enum_direction' nullable: true - description: The direction of the SMS Command + description: The direction of the SMS Command. Can be `to_sim` or `from_sim`. + The value of `to_sim` is synonymous with the term `mobile terminated`, + and `from_sim` is synonymous with the term `mobile originated`. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 SMS Command resource + description: The absolute URL of the SMS Command resource. sms_command_enum_status: type: string enum: @@ -660,37 +736,51 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that incurred the usage. + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that incurred the usage. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true - description: SID of a Sim resource to which the UsageRecord belongs. + description: SID of a Sim resource to which the UsageRecord belongs. Value + will only be present when either a value for the `Sim` query parameter + is provided or when UsageRecords are grouped by `sim`. Otherwise, the + value will be `null`. network_sid: type: string minLength: 34 maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ nullable: true - description: SID of the Network resource on which the usage occurred. + description: SID of the Network resource the usage occurred on. Value will + only be present when either a value for the `Network` query parameter + is provided or when UsageRecords are grouped by `network`. Otherwise, + the value will be `null`. fleet_sid: type: string minLength: 34 maxLength: 34 pattern: ^HF[0-9a-fA-F]{32}$ nullable: true - description: SID of the Fleet resource on which the usage occurred. + description: SID of the Fleet resource the usage occurred on. Value will + only be present when either a value for the `Fleet` query parameter is + provided or when UsageRecords are grouped by `fleet`. Otherwise, the value + will be `null`. iso_country: type: string format: iso-country-code nullable: true - description: Alpha-2 ISO Country Code of the country the usage occurred - in. + description: Alpha-2 ISO Country Code that the usage occurred in. Value + will only be present when either a value for the `IsoCountry` query parameter + is provided or when UsageRecords are grouped by `isoCountry`. Otherwise, + the value will be `null`. period: nullable: true - description: The time period for which the usage is reported. + description: The time period for which the usage is reported. The period + is represented as a pair of `start_time` and `end_time` timestamps specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. data_upload: type: integer format: int64 @@ -710,13 +800,20 @@ components: type: number nullable: true description: Total amount in the `billed_unit` that was charged for the - data uploaded or downloaded. + data uploaded or downloaded. Will return 0 for usage prior to February + 1, 2022. Value may be 0 despite `data_total` being greater than 0 if the + data usage is still being processed by Twilio's billing system. Refer + to [Data Usage Processing](https://www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) + for more details. billed_unit: type: string format: currency nullable: true description: The currency in which the billed amounts are measured, specified - in the 3 letter ISO 4127 format (e.g. `USD`, `EUR`, `JPY`). + in the 3 letter ISO 4127 format (e.g. `USD`, `EUR`, `JPY`). This can be + null when data_toal_billed is 0 and we do not yet have billing information + for the corresponding data usage. Refer to [Data Usage Processing](https://www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) + for more details. usage_record_enum_granularity: type: string enum: diff --git a/spec/yaml/twilio_sync_v1.yaml b/spec/yaml/twilio_sync_v1.yaml index 273873fa..0d597d58 100644 --- a/spec/yaml/twilio_sync_v1.yaml +++ b/spec/yaml/twilio_sync_v1.yaml @@ -9,65 +9,77 @@ components: maxLength: 34 pattern: ^ET[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Document + resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + 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. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Document resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync Service that the resource is associated - with + description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) + the resource is associated with. url: type: string format: uri nullable: true - description: The absolute URL of the Document resource + description: The absolute URL of the Document resource. links: type: object format: uri-map nullable: true - description: The URLs of resources related to the Sync Document + description: The URLs of resources related to the Sync Document. revision: type: string nullable: true - description: The current revision of the Sync Document, represented by a - string identifier + description: The current revision of the Sync Document, represented as a + string. The `revision` property is used with conditional updates to ensure + data consistency. data: nullable: true - description: An arbitrary, schema-less object that the Sync Document stores + description: An arbitrary, schema-less object that the Sync Document stores. + Can be up to 16 KiB in length. date_expires: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Sync Document expires + description: The date and time in GMT when the Sync Document expires and + will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. If the Sync Document does not expire, this value is `null`. The + Document resource might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. created_by: type: string nullable: true - description: The identity of the Sync Document's creator + 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`. sync.v1.service.document.document_permission: type: object properties: @@ -77,44 +89,46 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Document Permission resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync Service that the resource is associated - with + description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) + the resource is associated with. document_sid: type: string minLength: 34 maxLength: 34 pattern: ^ET[0-9a-fA-F]{32}$ nullable: true - description: The Sync Document SID + description: The SID of the Sync Document to which the Document Permission + applies. identity: type: string nullable: true - description: The identity of the user to whom the Sync Document Permission - applies + description: The application-defined string that uniquely identifies the + resource's User within the Service to an FPA token. read: type: boolean nullable: true - description: Read access + description: Whether the identity can read the Sync Document. write: type: boolean nullable: true - description: Write access + description: Whether the identity can update the Sync Document. manage: type: boolean nullable: true - description: Manage access + description: Whether the identity can delete the Sync Document. url: type: string format: uri nullable: true - description: The absolute URL of the Sync Document Permission resource + description: The absolute URL of the Sync Document Permission resource. sync.v1.service: type: object properties: @@ -124,73 +138,86 @@ components: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Service resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. It is a read-only property, it cannot be assigned + using REST API. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Service resource. 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. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 Service resource + description: The absolute URL of the Service resource. webhook_url: type: string format: uri nullable: true - description: The URL we call when Sync objects are manipulated + description: The URL we call when Sync objects are manipulated. webhooks_from_rest_enabled: type: boolean nullable: true - description: Whether the Service instance should call webhook_url when the - REST API is used to update Sync objects + description: Whether the Service instance should call `webhook_url` when + the REST API is used to update Sync objects. The default is `false`. reachability_webhooks_enabled: type: boolean nullable: true - description: Whether the service instance calls webhook_url when client - endpoints connect to Sync + description: Whether the service instance calls `webhook_url` when client + endpoints connect to Sync. The default is `false`. acl_enabled: type: boolean nullable: true description: Whether token identities in the Service must be granted access - to Sync objects by using the Permissions resource + to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) + resource. It is disabled (false) by default. reachability_debouncing_enabled: type: boolean nullable: true - description: Whether every endpoint_disconnected event occurs after a configurable - delay + description: Whether every `endpoint_disconnected` event should occur after + a configurable delay. The default is `false`, where the `endpoint_disconnected` + event occurs immediately after disconnection. When `true`, intervening + reconnections can prevent the `endpoint_disconnected` event. reachability_debouncing_window: type: integer nullable: true - description: The reachability event delay in milliseconds + description: The reachability event delay in milliseconds if `reachability_debouncing_enabled` + = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This + is the number of milliseconds after the last running client disconnects, + and a Sync identity is declared offline, before `webhook_url` is called, + if all endpoints remain offline. A reconnection from the same identity + by any endpoint during this interval prevents the reachability event from + occurring. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. sync.v1.service.sync_stream.stream_message: type: object properties: @@ -200,10 +227,12 @@ components: maxLength: 34 pattern: ^TZ[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Stream Message + resource. data: nullable: true - description: Stream Message body + description: An arbitrary, schema-less object that contains the Stream Message + body. Can be up to 4 KiB in length. sync.v1.service.sync_list: type: object properties: @@ -213,122 +242,140 @@ components: maxLength: 34 pattern: ^ES[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Sync List + resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Sync List resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync Service that the resource is associated - with + description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) + the resource is associated with. url: type: string format: uri nullable: true - description: The absolute URL of the Sync List resource + description: The absolute URL of the Sync List resource. links: type: object format: uri-map nullable: true - description: The URLs of the Sync List's nested resources + description: The URLs of the Sync List's nested resources. revision: type: string nullable: true - description: The current revision of the Sync List, represented as a string + description: The current revision of the Sync List, represented as a string. date_expires: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Sync List expires + description: The date and time in GMT when the Sync List expires and will + be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. If the Sync List does not expire, this value is `null`. The Sync + List might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. created_by: type: string nullable: true - description: The identity of the Sync List's creator + 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`. sync.v1.service.sync_list.sync_list_item: type: object properties: index: type: integer nullable: true - description: The automatically generated index of the List Item + description: The automatically generated index of the List Item. The `index` + values of the List Items in a Sync List can have gaps in their sequence. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the List Item resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync Service that the resource is associated - with + description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) + the resource is associated with. list_sid: type: string minLength: 34 maxLength: 34 pattern: ^ES[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync List that contains the List Item + description: The SID of the Sync List that contains the List Item. url: type: string format: uri nullable: true - description: The absolute URL of the List Item resource + description: The absolute URL of the List Item resource. revision: type: string nullable: true - description: The current revision of the item, represented as a string + description: The current revision of the item, represented as a string. data: nullable: true - description: An arbitrary, schema-less object that the List Item stores + description: An arbitrary, schema-less object that the List Item stores. + Can be up to 16 KiB in length. date_expires: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the List Item expires + description: The date and time in GMT when the List Item expires and will + be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. If the List Item does not expire, this value is `null`. The List + Item resource might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. created_by: type: string nullable: true - description: The identity of the List Item's creator + 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`. sync_list_item_enum_query_result_order: type: string enum: @@ -348,43 +395,46 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Sync List Permission resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync Service that the resource is associated - with + description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) + the resource is associated with. list_sid: type: string minLength: 34 maxLength: 34 pattern: ^ES[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync List to which the Permission applies + description: The SID of the Sync List to which the Permission applies. identity: type: string nullable: true - description: The identity of the user to whom the Sync List Permission applies + description: The application-defined string that uniquely identifies the + resource's User within the Service to an FPA token. read: type: boolean nullable: true - description: Read access + description: Whether the identity can read the Sync List and its Items. write: type: boolean nullable: true - description: Write access + description: Whether the identity can create, update, and delete Items in + the Sync List. manage: type: boolean nullable: true - description: Manage access + description: Whether the identity can delete the Sync List. url: type: string format: uri nullable: true - description: The absolute URL of the Sync List Permission resource + description: The absolute URL of the Sync List Permission resource. sync.v1.service.sync_map: type: object properties: @@ -394,122 +444,139 @@ components: maxLength: 34 pattern: ^MP[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Sync Map + resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Sync Map resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync Service that the resource is associated - with + description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) + the resource is associated with. url: type: string format: uri nullable: true - description: The absolute URL of the Sync Map resource + description: The absolute URL of the Sync Map resource. links: type: object format: uri-map nullable: true - description: The URLs of the Sync Map's nested resources + description: The URLs of the Sync Map's nested resources. revision: type: string nullable: true - description: The current revision of the Sync Map, represented as a string + description: The current revision of the Sync Map, represented as a string. date_expires: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Sync Map expires + description: The date and time in GMT when the Sync Map expires and will + be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. If the Sync Map does not expire, this value is `null`. The Sync + Map might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. created_by: type: string nullable: true - description: The identity of the Sync Map's creator + 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`. sync.v1.service.sync_map.sync_map_item: type: object properties: 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. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Map Item resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync Service that the resource is associated - with + description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) + the resource is associated with. map_sid: type: string minLength: 34 maxLength: 34 pattern: ^MP[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync Map that contains the Map Item + description: The SID of the Sync Map that contains the Map Item. url: type: string format: uri nullable: true - description: The absolute URL of the Map Item resource + description: The absolute URL of the Map Item resource. revision: type: string nullable: true - description: The current revision of the Map Item, represented as a string + description: The current revision of the Map Item, represented as a string. data: nullable: true - description: An arbitrary, schema-less object that the Map Item stores + description: An arbitrary, schema-less object that the Map Item stores. + Can be up to 16 KiB in length. date_expires: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Map Item expires + description: The date and time in GMT when the Map Item expires and will + be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. If the Map Item does not expire, this value is `null`. The Map + Item might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. created_by: type: string nullable: true - description: The identity of the Map Item's creator + 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`. sync_map_item_enum_query_result_order: type: string enum: @@ -529,44 +596,46 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Sync Map Permission resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync Service that the resource is associated - with + description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) + the resource is associated with. map_sid: type: string minLength: 34 maxLength: 34 pattern: ^MP[0-9a-fA-F]{32}$ nullable: true - description: Sync Map SID + description: The SID of the Sync Map to which the Permission applies. identity: type: string nullable: true - description: The identity of the user to whom the Sync Document Permission - applies + description: The application-defined string that uniquely identifies the + resource's User within the Service to an FPA token. read: type: boolean nullable: true - description: Read access + description: Whether the identity can read the Sync Map and its Items. write: type: boolean nullable: true - description: Write access + description: Whether the identity can create, update, and delete Items in + the Sync Map. manage: type: boolean nullable: true - description: Manage access + description: Whether the identity can delete the Sync Map. url: type: string format: uri nullable: true - description: The absolute URL of the Sync Map Permission resource + description: The absolute URL of the Sync Map Permission resource. sync.v1.service.sync_stream: type: object properties: @@ -576,57 +645,66 @@ components: maxLength: 34 pattern: ^TO[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Sync Stream + resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Sync Stream resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sync Service that the resource is associated - with + description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) + the resource is associated with. url: type: string format: uri nullable: true - description: The absolute URL of the Message Stream resource + description: The absolute URL of the Message Stream resource. links: type: object format: uri-map nullable: true - description: The URLs of the Stream's nested resources + description: The URLs of the Stream's nested resources. date_expires: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Message Stream expires + description: The date and time in GMT when the Message Stream expires and + will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. If the Message Stream does not expire, this value is `null`. The + Stream might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. created_by: type: string nullable: true - description: The Identity of the Stream's creator + 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 diff --git a/spec/yaml/twilio_taskrouter_v1.yaml b/spec/yaml/twilio_taskrouter_v1.yaml index 19873158..46cfd834 100644 --- a/spec/yaml/twilio_taskrouter_v1.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -9,46 +9,51 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Activity resource. available: type: boolean nullable: true - description: Whether the Worker should be eligible to receive a Task when - it occupies the Activity + description: Whether the Worker is eligible to receive a Task when it occupies + the Activity. A value of `true`, `1`, or `yes` indicates the Activity + is available. All other values indicate that it is not. The value cannot + be changed after the Activity is created. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. friendly_name: type: string nullable: true - description: The string that you assigned to describe the Activity resource + description: The string that you assigned to describe the Activity resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^WA[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Activity + 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 Activity + description: The SID of the Workspace that contains the Activity. url: type: string format: uri nullable: true - description: The absolute URL of the Activity resource + description: The absolute URL of the Activity resource. links: type: object format: uri-map @@ -62,87 +67,91 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Event resource. actor_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the resource that triggered the event + description: The SID of the resource that triggered the event. actor_type: type: string nullable: true - description: The type of resource that triggered the event + description: The type of resource that triggered the event. actor_url: type: string format: uri nullable: true - description: The absolute URL of the resource that triggered the event + description: The absolute URL of the resource that triggered the event. description: type: string nullable: true - description: A description of the event + description: A description of the event. event_data: nullable: true - description: Data about the event + description: Data about the event. For more information, see [Event types](https://www.twilio.com/docs/taskrouter/api/event#event-types). event_date: type: string format: date-time nullable: true - description: The time the event was sent + description: The time the event was sent, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. event_date_ms: type: integer format: int64 nullable: true - description: The time the event was sent in milliseconds + description: The time the event was sent in milliseconds. event_type: type: string nullable: true - description: The identifier for the event + description: The identifier for the event. resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the object the event is most relevant to + description: The SID of the object the event is most relevant to, such as + a TaskSid, ReservationSid, or a WorkerSid. resource_type: type: string nullable: true - description: The type of object the event is most relevant to + description: The type of object the event is most relevant to, such as a + Task, Reservation, or a Worker). resource_url: type: string format: uri nullable: true - description: The URL of the resource the event is most relevant to + description: The URL of the resource the event is most relevant to. sid: type: string minLength: 34 maxLength: 34 pattern: ^EV[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Event resource. source: type: string nullable: true - description: Where the Event originated + description: Where the Event originated. source_ip_address: type: string nullable: true - description: The IP from which the Event originated + description: The IP from which the Event originated. url: type: string format: uri nullable: true - description: The absolute URL of the Event resource + description: The absolute URL of the Event 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 Event + description: The SID of the Workspace that contains the Event. taskrouter.v1.workspace.task: type: object properties: @@ -152,112 +161,120 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Task resource. age: type: integer nullable: true - description: The number of seconds since the Task was created + description: The number of seconds since the Task was created. assignment_status: type: string $ref: '#/components/schemas/task_enum_status' nullable: true - description: The current status of the Task's assignment + description: 'The current status of the Task''s assignment. Can be: `pending`, + `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`.' attributes: type: string nullable: true - description: The JSON string with custom attributes of the work + 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. addons: type: string nullable: true - description: An object that contains the addon data for all installed addons + description: An object that contains the [addon](https://www.twilio.com/docs/taskrouter/marketplace) + data for all installed addons. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. task_queue_entered_date: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Task entered the - TaskQueue. + description: The date and time in GMT when the Task entered the TaskQueue, + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. priority: type: integer nullable: true - description: Retrieve the list of all Tasks in the Workspace with the specified - priority + description: The current priority score of the Task as assigned to a Worker + by the workflow. Tasks with higher priority values will be assigned before + Tasks with lower values. reason: type: string nullable: true - description: The reason the Task was canceled or completed + description: The reason the Task was canceled or completed, if applicable. sid: type: string minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Task resource. task_queue_sid: type: string minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ nullable: true - description: The SID of the TaskQueue + description: The SID of the TaskQueue. task_queue_friendly_name: type: string nullable: true - description: The friendly name of the TaskQueue + description: The friendly name of the TaskQueue. task_channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^TC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the TaskChannel + description: The SID of the TaskChannel. task_channel_unique_name: type: string nullable: true - description: The unique name of the TaskChannel + description: The unique name of the TaskChannel. timeout: type: integer nullable: true description: The amount of time in seconds that the Task can live before - being assigned + being assigned. workflow_sid: type: string minLength: 34 maxLength: 34 pattern: ^WW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Workflow that is controlling the Task + description: The SID of the Workflow that is controlling the Task. workflow_friendly_name: type: string nullable: true - description: The friendly name of the Workflow that is controlling the Task + description: The friendly name of the Workflow that is controlling the Task. 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 Task + description: The SID of the Workspace that contains the Task. url: type: string format: uri nullable: true - description: The absolute URL of the Task resource + description: The absolute URL of the Task resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. task_enum_status: type: string enum: @@ -276,56 +293,59 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Task Channel resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. 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. sid: type: string minLength: 34 maxLength: 34 pattern: ^TC[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Task Channel + resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - Task Channel + Task Channel, such as `voice` or `sms`. 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 Task Channel + description: The SID of the Workspace that contains the Task Channel. channel_optimized_routing: type: boolean nullable: true description: Whether the Task Channel will prioritize Workers that have - been idle + been idle. When `true`, Workers that have been idle the longest are prioritized. url: type: string format: uri nullable: true - description: The absolute URL of the Task Channel resource + description: The absolute URL of the Task Channel resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. taskrouter.v1.workspace.task_queue: type: object properties: @@ -335,7 +355,8 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the TaskQueue resource. assignment_activity_sid: type: string minLength: 34 @@ -343,31 +364,34 @@ components: pattern: ^WA[0-9a-fA-F]{32}$ nullable: true description: The SID of the Activity to assign Workers when a task is assigned - for them + for them. assignment_activity_name: type: string nullable: true description: The name of the Activity to assign Workers when a task is assigned - for them + for them. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 + description: The string that you assigned to describe the resource. max_reserved_workers: type: integer nullable: true - description: The maximum number of Workers to reserve + description: The maximum number of Workers to reserve for the assignment + of a task in the queue. Can be an integer between 1 and 50, inclusive + and defaults to 1. reservation_activity_sid: type: string minLength: 34 @@ -375,46 +399,54 @@ components: pattern: ^WA[0-9a-fA-F]{32}$ nullable: true description: The SID of the Activity to assign Workers once a task is reserved - for them + for them. reservation_activity_name: type: string nullable: true description: The name of the Activity to assign Workers once a task is reserved - for them + for them. sid: type: string minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the TaskQueue + resource. target_workers: type: string nullable: true description: A string describing the Worker selection criteria for any Tasks - that enter the TaskQueue + that enter the TaskQueue. For example `'"language" == "spanish"'` If no + TargetWorkers parameter is provided, Tasks will wait in the TaskQueue + until they are either deleted or moved to another TaskQueue. Additional + examples on how to describing Worker selection criteria below. Defaults + to 1==1. task_order: type: string $ref: '#/components/schemas/task_queue_enum_task_order' nullable: true - description: How Tasks will be assigned to Workers + description: How Tasks will be assigned to Workers. Set this parameter to + `LIFO` to assign most recently created Task first or `FIFO` to assign + the oldest Task. Default is FIFO. [Click here](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo) + to learn more. url: type: string format: uri nullable: true - description: The absolute URL of the TaskQueue resource + description: The absolute URL of 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 + description: The SID of the Workspace that contains the TaskQueue. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. task_queue_enum_task_order: type: string enum: @@ -429,107 +461,114 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the TaskQueue resource. avg_task_acceptance_time: type: integer nullable: true - description: The average time in seconds between Task creation and acceptance + description: The average time in seconds between Task creation and acceptance. start_time: type: string format: date-time nullable: true description: The beginning of the interval during which these statistics - were calculated + were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. end_time: type: string format: date-time nullable: true description: The end of the interval during which these statistics were - calculated + calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. reservations_created: type: integer nullable: true - description: The total number of Reservations created for Tasks in the TaskQueue + description: The total number of Reservations created for Tasks in the TaskQueue. reservations_accepted: type: integer nullable: true description: The total number of Reservations accepted for Tasks in the - TaskQueue + TaskQueue. reservations_rejected: type: integer nullable: true description: The total number of Reservations rejected for Tasks in the - TaskQueue + TaskQueue. reservations_timed_out: type: integer nullable: true description: The total number of Reservations that timed out for Tasks in - the TaskQueue + the TaskQueue. reservations_canceled: type: integer nullable: true description: The total number of Reservations canceled for Tasks in the - TaskQueue + TaskQueue. reservations_rescinded: type: integer nullable: true - description: The total number of Reservations rescinded + description: The total number of Reservations rescinded. split_by_wait_time: nullable: true - description: A list of objects that describe the Tasks canceled and reservations - accepted above and below the specified thresholds + description: A list of objects that describe the number of Tasks canceled + and reservations accepted above and below the thresholds specified in + seconds. task_queue_sid: type: string minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ nullable: true - description: The SID of the TaskQueue from which these statistics were calculated + description: The SID of the TaskQueue from which these statistics were calculated. wait_duration_until_accepted: nullable: true - description: The wait duration statistics for Tasks accepted while in the - TaskQueue + description: The wait duration statistics (`avg`, `min`, `max`, `total`) + for Tasks accepted while in the TaskQueue. Calculation is based on the + time when the Tasks were created. For transfers, the wait duration is + counted from the moment ***the Task was created***, and not from when + the transfer was initiated. wait_duration_until_canceled: nullable: true - description: The wait duration statistics for Tasks canceled while in the - TaskQueue + description: The wait duration statistics (`avg`, `min`, `max`, `total`) + for Tasks canceled while in the TaskQueue. wait_duration_in_queue_until_accepted: nullable: true - description: The relative wait duration statistics for Tasks accepted while - in the TaskQueue + description: The relative wait duration statistics (`avg`, `min`, `max`, + `total`) for Tasks accepted while in the TaskQueue. Calculation is based + on the time when the Tasks entered the TaskQueue. tasks_canceled: type: integer nullable: true - description: The total number of Tasks canceled in the TaskQueue + description: The total number of Tasks canceled in the TaskQueue. tasks_completed: type: integer nullable: true - description: The total number of Tasks completed in the TaskQueue + description: The total number of Tasks completed in the TaskQueue. tasks_deleted: type: integer nullable: true - description: The total number of Tasks deleted in the TaskQueue + description: The total number of Tasks deleted in the TaskQueue. tasks_entered: type: integer nullable: true - description: The total number of Tasks entered into the TaskQueue + description: The total number of Tasks entered into the TaskQueue. tasks_moved: type: integer nullable: true description: The total number of Tasks that were moved from one queue to - another + another. 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 + description: The SID of the Workspace that contains the TaskQueue. url: type: string format: uri nullable: true - description: The absolute URL of the TaskQueue statistics resource + description: The absolute URL of the TaskQueue statistics resource. taskrouter.v1.workspace.task_queue.task_queue_real_time_statistics: type: object properties: @@ -539,72 +578,77 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the TaskQueue resource. activity_statistics: type: array items: {} nullable: true - description: The number of current Workers by Activity + description: The number of current Workers by Activity. longest_task_waiting_age: type: integer nullable: true - description: The age of the longest waiting Task + description: The age of the longest waiting Task. longest_task_waiting_sid: type: string minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ nullable: true - description: The SID of the longest waiting Task + description: The SID of the longest waiting Task. longest_relative_task_age_in_queue: type: integer nullable: true description: The relative age in the TaskQueue for the longest waiting Task. + Calculation is based on the time when the Task entered the TaskQueue. longest_relative_task_sid_in_queue: type: string minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Task waiting in the TaskQueue the longest. + description: The Task SID of the Task waiting in the TaskQueue the longest. + Calculation is based on the time when the Task entered the TaskQueue. task_queue_sid: type: string minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ nullable: true - description: The SID of the TaskQueue from which these statistics were calculated + description: The SID of the TaskQueue from which these statistics were calculated. tasks_by_priority: nullable: true - description: The number of Tasks by priority + description: 'The number of Tasks by priority. For example: `{"0": "10", + "99": "5"}` shows 10 Tasks at priority 0 and 5 at priority 99.' tasks_by_status: nullable: true - description: The number of Tasks by their current status + description: 'The number of Tasks by their current status. For example: + `{"pending": "1", "reserved": "3", "assigned": "2", "completed": "5"}`.' total_available_workers: type: integer nullable: true - description: The total number of Workers available for Tasks in the TaskQueue + description: The total number of Workers available for Tasks in the TaskQueue. total_eligible_workers: type: integer nullable: true description: The total number of Workers eligible for Tasks in the TaskQueue, - independent of their Activity state + independent of their Activity state. total_tasks: type: integer nullable: true - description: The total number of Tasks + description: The total number of Tasks. 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 + description: The SID of the Workspace that contains the TaskQueue. url: type: string format: uri nullable: true - description: The absolute URL of the TaskQueue statistics resource + description: The absolute URL of the TaskQueue statistics resource. taskrouter.v1.workspace.task_queue.task_queue_statistics: type: object properties: @@ -614,32 +658,33 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the TaskQueue resource. cumulative: nullable: true - description: An object that contains the cumulative statistics for the TaskQueue + description: An object that contains the cumulative statistics for the TaskQueue. realtime: nullable: true - description: An object that contains the real-time statistics for the TaskQueue + description: An object that contains the real-time statistics for the TaskQueue. task_queue_sid: type: string minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ nullable: true - description: The SID of the TaskQueue from which these statistics were calculated + description: The SID of the TaskQueue from which these statistics were calculated. 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 + description: The SID of the Workspace that contains the TaskQueue. url: type: string format: uri nullable: true - description: The absolute URL of the TaskQueue statistics resource + description: The absolute URL of the TaskQueue statistics resource. taskrouter.v1.workspace.task_queue.task_queues_statistics: type: object properties: @@ -649,27 +694,28 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the TaskQueue resource. cumulative: nullable: true - description: An object that contains the cumulative statistics for the TaskQueues + description: An object that contains the cumulative statistics for the TaskQueues. realtime: nullable: true - description: An object that contains the real-time statistics for the TaskQueues + description: An object that contains the real-time statistics for the TaskQueues. task_queue_sid: type: string minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ nullable: true - description: The SID of the TaskQueue from which these statistics were calculated + description: The SID of the TaskQueue from which these statistics were calculated. 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 TaskQueues + description: The SID of the Workspace that contains the TaskQueues. taskrouter.v1.workspace.task.task_reservation: type: object properties: @@ -679,48 +725,52 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the TaskReservation resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. reservation_status: type: string $ref: '#/components/schemas/task_reservation_enum_status' nullable: true - description: The current status of the reservation + description: 'The current status of the reservation. Can be: `pending`, + `accepted`, `rejected`, or `timeout`.' sid: type: string minLength: 34 maxLength: 34 pattern: ^WR[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the TaskReservation + resource. task_sid: type: string minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ nullable: true - description: The SID of the reserved Task resource + description: The SID of the reserved Task resource. worker_name: type: string nullable: true - description: The friendly_name of the Worker that is reserved + description: The `friendly_name` of the Worker that is reserved. worker_sid: type: string minLength: 34 maxLength: 34 pattern: ^WK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the reserved Worker resource + description: The SID of the reserved Worker resource. workspace_sid: type: string minLength: 34 @@ -732,12 +782,12 @@ components: type: string format: uri nullable: true - description: The absolute URL of the TaskReservation reservation + description: The absolute URL of the TaskReservation reservation. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. task_reservation_enum_status: type: string enum: @@ -781,71 +831,80 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Worker resource. activity_name: type: string nullable: true - description: The friendly_name of the Worker's current Activity + description: The `friendly_name` of the Worker's current Activity. activity_sid: type: string minLength: 34 maxLength: 34 pattern: ^WA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Worker's current Activity + description: The SID of the Worker's current Activity. attributes: type: string nullable: true - description: The JSON string that describes 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.' available: type: boolean nullable: true - description: Whether the Worker is available to perform tasks + description: Whether the Worker is available to perform tasks. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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_status_changed: type: string format: date-time nullable: true description: The date and time in GMT of the last change to the Worker's - activity + activity specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. Used to calculate Workflow statistics. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated + 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. 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. Friendly + names are case insensitive, and unique within the TaskRouter Workspace. sid: type: string minLength: 34 maxLength: 34 pattern: ^WK[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Worker 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 Worker + description: The SID of the Workspace that contains the Worker. url: type: string format: uri nullable: true - description: The absolute URL of the Worker resource + description: The absolute URL of the Worker resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. taskrouter.v1.workspace.worker.worker_channel: type: object properties: @@ -855,73 +914,81 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Worker resource. assigned_tasks: type: integer nullable: true description: The total number of Tasks assigned to Worker for the TaskChannel - type + type. available: type: boolean nullable: true description: Whether the Worker should receive Tasks of the TaskChannel - type + type. available_capacity_percentage: type: integer nullable: true - description: The current available capacity between 0 to 100 for the TaskChannel + description: The current percentage of capacity the TaskChannel has available. + Can be a number between `0` and `100`. A value of `0` indicates that TaskChannel + has no capacity available and a value of `100` means the Worker is available + to receive any Tasks of this TaskChannel type. configured_capacity: type: integer nullable: true - description: The current configured capacity for the WorkerChannel + description: The current configured capacity for the WorkerChannel. TaskRouter + will not create any reservations after the assigned Tasks for the Worker + reaches the value. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. sid: type: string minLength: 34 maxLength: 34 pattern: ^WC[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the WorkerChannel + resource. task_channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^TC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the TaskChannel + description: The SID of the TaskChannel. task_channel_unique_name: type: string nullable: true - description: The unique name of the TaskChannel, such as 'voice' or 'sms' + description: The unique name of the TaskChannel, such as `voice` or `sms`. worker_sid: type: string minLength: 34 maxLength: 34 pattern: ^WK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Worker that contains the WorkerChannel + description: The SID of the Worker that contains the WorkerChannel. 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 WorkerChannel + description: The SID of the Workspace that contains the WorkerChannel. url: type: string format: uri nullable: true - description: The absolute URL of the WorkerChannel resource + description: The absolute URL of the WorkerChannel resource. taskrouter.v1.workspace.worker.worker_instance_statistics: type: object properties: @@ -931,29 +998,30 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Worker resource. cumulative: nullable: true - description: An object that contains the cumulative statistics for the Worker + description: An object that contains the cumulative statistics for the Worker. worker_sid: type: string minLength: 34 maxLength: 34 pattern: ^WK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Worker that contains the WorkerChannel + description: The SID of the Worker that contains the WorkerChannel. 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 WorkerChannel + description: The SID of the Workspace that contains the WorkerChannel. url: type: string format: uri nullable: true - description: The absolute URL of the WorkerChannel statistics resource + description: The absolute URL of the WorkerChannel statistics resource. taskrouter.v1.workspace.worker.worker_reservation: type: object properties: @@ -963,48 +1031,52 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the WorkerReservation resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. reservation_status: type: string $ref: '#/components/schemas/worker_reservation_enum_status' nullable: true - description: The current status of the reservation + description: 'The current status of the reservation. Can be: `pending`, + `accepted`, `rejected`, `timeout`, `canceled`, or `rescinded`.' sid: type: string minLength: 34 maxLength: 34 pattern: ^WR[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the WorkerReservation + resource. task_sid: type: string minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ nullable: true - description: The SID of the reserved Task resource + description: The SID of the reserved Task resource. worker_name: type: string nullable: true - description: The friendly_name of the Worker that is reserved + description: The `friendly_name` of the Worker that is reserved. worker_sid: type: string minLength: 34 maxLength: 34 pattern: ^WK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the reserved Worker resource + description: The SID of the reserved Worker resource. workspace_sid: type: string minLength: 34 @@ -1016,12 +1088,12 @@ components: type: string format: uri nullable: true - description: The absolute URL of the WorkerReservation resource + description: The absolute URL of the WorkerReservation resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. worker_reservation_enum_status: type: string enum: @@ -1055,29 +1127,30 @@ components: properties: realtime: nullable: true - description: An object that contains the real-time statistics for the Worker + description: An object that contains the real-time statistics for the Worker. cumulative: nullable: true - description: An object that contains the cumulative statistics for the Worker + description: An object that contains the cumulative statistics for the Worker. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Worker 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 Worker + description: The SID of the Workspace that contains the Worker. url: type: string format: uri nullable: true - description: The absolute URL of the Worker statistics resource + description: The absolute URL of the Worker statistics resource. taskrouter.v1.workspace.worker.workers_cumulative_statistics: type: object properties: @@ -1087,61 +1160,63 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Worker resource. start_time: type: string format: date-time nullable: true description: The beginning of the interval during which these statistics - were calculated + were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. end_time: type: string format: date-time nullable: true description: The end of the interval during which these statistics were - calculated + calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. activity_durations: type: array items: {} nullable: true - description: The minimum, average, maximum, and total time that Workers - spent in each Activity + description: The minimum, average, maximum, and total time (in seconds) + that Workers spent in each Activity. reservations_created: type: integer nullable: true - description: The total number of Reservations that were created + description: The total number of Reservations that were created. reservations_accepted: type: integer nullable: true - description: The total number of Reservations that were accepted + description: The total number of Reservations that were accepted. reservations_rejected: type: integer nullable: true - description: The total number of Reservations that were rejected + description: The total number of Reservations that were rejected. reservations_timed_out: type: integer nullable: true - description: The total number of Reservations that were timed out + description: The total number of Reservations that were timed out. reservations_canceled: type: integer nullable: true - description: The total number of Reservations that were canceled + description: The total number of Reservations that were canceled. reservations_rescinded: type: integer nullable: true - description: The total number of Reservations that were rescinded + description: The total number of Reservations that were rescinded. 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 Workers + description: The SID of the Workspace that contains the Workers. url: type: string format: uri nullable: true - description: The absolute URL of the Workers statistics resource + description: The absolute URL of the Workers statistics resource. taskrouter.v1.workspace.worker.workers_real_time_statistics: type: object properties: @@ -1151,28 +1226,29 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Worker resource. activity_statistics: type: array items: {} nullable: true - description: The number of current Workers by Activity + description: The number of current Workers by Activity. total_workers: type: integer nullable: true - description: The total number of Workers + description: The total number of Workers. 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 Workers + description: The SID of the Workspace that contains the Workers. url: type: string format: uri nullable: true - description: The absolute URL of the Workers statistics resource + description: The absolute URL of the Workers statistics resource. taskrouter.v1.workspace.workflow: type: object properties: @@ -1182,71 +1258,78 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Workflow resource. assignment_callback_url: type: string format: uri nullable: true description: The URL that we call when a task managed by the Workflow is - assigned to a Worker + assigned to a Worker. See Assignment Callback URL for more information. configuration: type: string nullable: true - description: A JSON string that contains the Workflow's configuration + description: A JSON string that contains the Workflow's configuration. See + [Configuring Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) + for more information. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. document_content_type: type: string nullable: true - description: The MIME type of the document + description: The MIME type of the document. fallback_assignment_callback_url: type: string format: uri nullable: true description: The URL that we call when a call to the `assignment_callback_url` - fails + fails. friendly_name: type: string nullable: true - description: The string that you assigned to describe the Workflow resource + description: The string that you assigned to describe the Workflow resource. + For example, `Customer Support` or `2014 Election Campaign`. sid: type: string minLength: 34 maxLength: 34 pattern: ^WW[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Workflow + resource. task_reservation_timeout: type: integer nullable: true description: How long TaskRouter will wait for a confirmation response from - your application after it assigns a Task to a Worker + your application after it assigns a Task to a Worker. Can be up to `86,400` + (24 hours) and the default is `120`. 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 Workflow + description: The SID of the Workspace that contains the Workflow. url: type: string format: uri nullable: true - description: The absolute URL of the Workflow resource + description: The absolute URL of the Workflow resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. taskrouter.v1.workspace.workflow.workflow_cumulative_statistics: type: object properties: @@ -1256,82 +1339,88 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Workflow resource. avg_task_acceptance_time: type: integer nullable: true - description: The average time in seconds between Task creation and acceptance + description: The average time in seconds between Task creation and acceptance. start_time: type: string format: date-time nullable: true description: The beginning of the interval during which these statistics - were calculated + were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. end_time: type: string format: date-time nullable: true description: The end of the interval during which these statistics were - calculated + calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. reservations_created: type: integer nullable: true - description: The total number of Reservations that were created for Workers + description: The total number of Reservations that were created for Workers. reservations_accepted: type: integer nullable: true - description: The total number of Reservations accepted by Workers + description: The total number of Reservations accepted by Workers. reservations_rejected: type: integer nullable: true - description: The total number of Reservations that were rejected + description: The total number of Reservations that were rejected. reservations_timed_out: type: integer nullable: true - description: The total number of Reservations that were timed out + description: The total number of Reservations that were timed out. reservations_canceled: type: integer nullable: true - description: The total number of Reservations that were canceled + description: The total number of Reservations that were canceled. reservations_rescinded: type: integer nullable: true - description: The total number of Reservations that were rescinded + description: The total number of Reservations that were rescinded. split_by_wait_time: nullable: true - description: A list of objects that describe the Tasks canceled and reservations - accepted above and below the specified thresholds + description: A list of objects that describe the number of Tasks canceled + and reservations accepted above and below the thresholds specified in + seconds. wait_duration_until_accepted: nullable: true - description: The wait duration statistics for Tasks that were accepted + description: The wait duration statistics (`avg`, `min`, `max`, `total`) + for Tasks that were accepted. wait_duration_until_canceled: nullable: true - description: The wait duration statistics for Tasks that were canceled + description: The wait duration statistics (`avg`, `min`, `max`, `total`) + for Tasks that were canceled. tasks_canceled: type: integer nullable: true - description: The total number of Tasks that were canceled + description: The total number of Tasks that were canceled. tasks_completed: type: integer nullable: true - description: The total number of Tasks that were completed + description: The total number of Tasks that were completed. tasks_entered: type: integer nullable: true - description: The total number of Tasks that entered the Workflow + description: The total number of Tasks that entered the Workflow. tasks_deleted: type: integer nullable: true - description: The total number of Tasks that were deleted + description: The total number of Tasks that were deleted. tasks_moved: type: integer nullable: true description: The total number of Tasks that were moved from one queue to - another + another. tasks_timed_out_in_workflow: type: integer nullable: true description: The total number of Tasks that were timed out of their Workflows + (and deleted). workflow_sid: type: string minLength: 34 @@ -1339,7 +1428,7 @@ components: pattern: ^WW[0-9a-fA-F]{32}$ nullable: true description: Returns the list of Tasks that are being controlled by the - Workflow with the specified Sid value + Workflow with the specified Sid value. workspace_sid: type: string minLength: 34 @@ -1351,7 +1440,7 @@ components: type: string format: uri nullable: true - description: The absolute URL of the Workflow statistics resource + description: The absolute URL of the Workflow statistics resource. taskrouter.v1.workspace.workflow.workflow_real_time_statistics: type: object properties: @@ -1361,28 +1450,31 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Workflow resource. longest_task_waiting_age: type: integer nullable: true - description: The age of the longest waiting Task + description: The age of the longest waiting Task. longest_task_waiting_sid: type: string minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ nullable: true - description: The SID of the longest waiting Task + description: The SID of the longest waiting Task. tasks_by_priority: nullable: true - description: The number of Tasks by priority + description: 'The number of Tasks by priority. For example: `{"0": "10", + "99": "5"}` shows 10 Tasks at priority 0 and 5 at priority 99.' tasks_by_status: nullable: true - description: The number of Tasks by their current status + description: 'The number of Tasks by their current status. For example: + `{"pending": "1", "reserved": "3", "assigned": "2", "completed": "5"}`.' total_tasks: type: integer nullable: true - description: The total number of Tasks + description: The total number of Tasks. workflow_sid: type: string minLength: 34 @@ -1390,7 +1482,7 @@ components: pattern: ^WW[0-9a-fA-F]{32}$ nullable: true description: Returns the list of Tasks that are being controlled by the - Workflow with the specified SID value + Workflow with the specified SID value. workspace_sid: type: string minLength: 34 @@ -1402,7 +1494,7 @@ components: type: string format: uri nullable: true - description: The absolute URL of the Workflow statistics resource + description: The absolute URL of the Workflow statistics resource. taskrouter.v1.workspace.workflow.workflow_statistics: type: object properties: @@ -1412,13 +1504,14 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Workflow resource. cumulative: nullable: true - description: An object that contains the cumulative statistics for the Workflow + description: An object that contains the cumulative statistics for the Workflow. realtime: nullable: true - description: An object that contains the real-time statistics for the Workflow + description: An object that contains the real-time statistics for the Workflow. workflow_sid: type: string minLength: 34 @@ -1426,19 +1519,19 @@ components: pattern: ^WW[0-9a-fA-F]{32}$ nullable: true description: Returns the list of Tasks that are being controlled by the - Workflow with the specified SID value + Workflow with the specified SID value. 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 Workflow + description: The SID of the Workspace that contains the Workflow. url: type: string format: uri nullable: true - description: The absolute URL of the Workflow statistics resource + description: The absolute URL of the Workflow statistics resource. taskrouter.v1.workspace: type: object properties: @@ -1448,22 +1541,24 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Workspace resource. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. default_activity_name: type: string nullable: true - description: The name of the default activity + description: The name of the default activity. default_activity_sid: type: string minLength: 34 @@ -1471,35 +1566,49 @@ components: pattern: ^WA[0-9a-fA-F]{32}$ nullable: true description: The SID of the Activity that will be used when new Workers - are created in the Workspace + are created in the Workspace. event_callback_url: type: string format: uri nullable: true - description: The URL we call when an event occurs + description: The URL we call when an event occurs. If provided, the Workspace + will publish events to this URL, for example, to collect data for reporting. + See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) + for more information. This parameter supports Twilio's [Webhooks (HTTP + callbacks) Connection Overrides](https://www.twilio.com/docs/usage/webhooks/webhooks-connection-overrides). events_filter: type: string nullable: true - description: The list of Workspace events for which to call event_callback_url + description: The list of Workspace events for which to call `event_callback_url`. + For example, if `EventsFilter=task.created, task.canceled, worker.activity.update`, + then TaskRouter will call event_callback_url only when a task is created, + canceled, or a Worker activity is updated. friendly_name: type: string nullable: true - description: The string that you assigned to describe the Workspace resource + description: The string that you assigned to describe the Workspace resource. + For example `Customer Support` or `2014 Election Campaign`. multi_task_enabled: type: boolean nullable: true - description: Whether multi-tasking is enabled + description: Whether multi-tasking is enabled. The default is `true`, which + enables multi-tasking. Multi-tasking allows Workers to handle multiple + Tasks simultaneously. When enabled (`true`), each Worker can receive parallel + reservations up to the per-channel maximums defined in the Workers section. + In single-tasking each Worker would only receive a new reservation when + the previous task is completed. Learn more at [Multitasking](https://www.twilio.com/docs/taskrouter/multitasking). sid: type: string minLength: 34 maxLength: 34 pattern: ^WS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Workspace + resource. timeout_activity_name: type: string nullable: true - description: The name of the timeout activity + description: The name of the timeout activity. timeout_activity_sid: type: string minLength: 34 @@ -1507,23 +1616,24 @@ components: pattern: ^WA[0-9a-fA-F]{32}$ nullable: true description: The SID of the Activity that will be assigned to a Worker when - a Task reservation times out without a response + a Task reservation times out without a response. prioritize_queue_order: type: string $ref: '#/components/schemas/workspace_enum_queue_order' nullable: true - description: The type of TaskQueue to prioritize when Workers are receiving - Tasks from both types of TaskQueues + description: 'The type of TaskQueue to prioritize when Workers are receiving + Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO` and the + default is `FIFO`. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).' url: type: string format: uri nullable: true - description: The absolute URL of the Workspace resource + description: The absolute URL of the Workspace resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. workspace_enum_queue_order: type: string enum: @@ -1538,94 +1648,100 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Workspace resource. avg_task_acceptance_time: type: integer nullable: true - description: The average time in seconds between Task creation and acceptance + description: The average time in seconds between Task creation and acceptance. start_time: type: string format: date-time nullable: true description: The beginning of the interval during which these statistics - were calculated + were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. end_time: type: string format: date-time nullable: true description: The end of the interval during which these statistics were - calculated + calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. reservations_created: type: integer nullable: true - description: The total number of Reservations that were created for Workers + description: The total number of Reservations that were created for Workers. reservations_accepted: type: integer nullable: true - description: The total number of Reservations accepted by Workers + description: The total number of Reservations accepted by Workers. reservations_rejected: type: integer nullable: true - description: The total number of Reservations that were rejected + description: The total number of Reservations that were rejected. reservations_timed_out: type: integer nullable: true - description: The total number of Reservations that were timed out + description: The total number of Reservations that were timed out. reservations_canceled: type: integer nullable: true - description: The total number of Reservations that were canceled + description: The total number of Reservations that were canceled. reservations_rescinded: type: integer nullable: true - description: The total number of Reservations that were rescinded + description: The total number of Reservations that were rescinded. split_by_wait_time: nullable: true - description: A list of objects that describe the Tasks canceled and reservations - accepted above and below the specified thresholds + description: A list of objects that describe the number of Tasks canceled + and reservations accepted above and below the thresholds specified in + seconds. wait_duration_until_accepted: nullable: true - description: The wait duration statistics for Tasks that were accepted + description: The wait duration statistics (`avg`, `min`, `max`, `total`) + for Tasks that were accepted. wait_duration_until_canceled: nullable: true - description: The wait duration statistics for Tasks that were canceled + description: The wait duration statistics (`avg`, `min`, `max`, `total`) + for Tasks that were canceled. tasks_canceled: type: integer nullable: true - description: The total number of Tasks that were canceled + description: The total number of Tasks that were canceled. tasks_completed: type: integer nullable: true - description: The total number of Tasks that were completed + description: The total number of Tasks that were completed. tasks_created: type: integer nullable: true - description: The total number of Tasks created + description: The total number of Tasks created. tasks_deleted: type: integer nullable: true - description: The total number of Tasks that were deleted + description: The total number of Tasks that were deleted. tasks_moved: type: integer nullable: true description: The total number of Tasks that were moved from one queue to - another + another. tasks_timed_out_in_workflow: type: integer nullable: true description: The total number of Tasks that were timed out of their Workflows + (and deleted). workspace_sid: type: string minLength: 34 maxLength: 34 pattern: ^WS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Workspace + description: The SID of the Workspace. url: type: string format: uri nullable: true - description: The absolute URL of the Workspace statistics resource + description: The absolute URL of the Workspace statistics resource. taskrouter.v1.workspace.workspace_real_time_statistics: type: object properties: @@ -1635,77 +1751,81 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Workspace resource. activity_statistics: type: array items: {} nullable: true - description: The number of current Workers by Activity + description: The number of current Workers by Activity. longest_task_waiting_age: type: integer nullable: true - description: The age of the longest waiting Task + description: The age of the longest waiting Task. longest_task_waiting_sid: type: string minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ nullable: true - description: The SID of the longest waiting Task + description: The SID of the longest waiting Task. tasks_by_priority: nullable: true - description: The number of Tasks by priority + description: 'The number of Tasks by priority. For example: `{"0": "10", + "99": "5"}` shows 10 Tasks at priority 0 and 5 at priority 99.' tasks_by_status: nullable: true - description: The number of Tasks by their current status + description: 'The number of Tasks by their current status. For example: + `{"pending": "1", "reserved": "3", "assigned": "2", "completed": "5"}`.' total_tasks: type: integer nullable: true - description: The total number of Tasks + description: The total number of Tasks. total_workers: type: integer nullable: true - description: The total number of Workers in the Workspace + description: The total number of Workers in the Workspace. workspace_sid: type: string minLength: 34 maxLength: 34 pattern: ^WS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Workspace + description: The SID of the Workspace. url: type: string format: uri nullable: true - description: The absolute URL of the Workspace statistics resource + description: The absolute URL of the Workspace statistics resource. taskrouter.v1.workspace.workspace_statistics: type: object properties: realtime: nullable: true - description: n object that contains the real-time statistics for the Workspace + description: An object that contains the real-time statistics for the Workspace. cumulative: nullable: true - description: An object that contains the cumulative statistics for the Workspace + description: An object that contains the cumulative statistics for the Workspace. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Workspace resource. workspace_sid: type: string minLength: 34 maxLength: 34 pattern: ^WS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Workspace + description: The SID of the Workspace. url: type: string format: uri nullable: true - description: The absolute URL of the Workspace statistics resource + description: The absolute URL of the Workspace statistics resource. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index e753962b..580a7ad8 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -9,41 +9,44 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the CredentialList resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the CredentialList + resource. trunk_sid: type: string minLength: 34 maxLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Trunk the credential list in associated with + description: The SID of the Trunk the credential list in associated with. 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. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. trunking.v1.trunk.ip_access_control_list: type: object properties: @@ -53,41 +56,44 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the IpAccessControlList resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the IpAccessControlList + resource. trunk_sid: type: string minLength: 34 maxLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Trunk the resource is associated with + description: The SID of the Trunk the resource is associated with. 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. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. trunking.v1.trunk.origination_url: type: object properties: @@ -97,60 +103,68 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the OriginationUrl resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^OU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the OriginationUrl + resource. trunk_sid: type: string minLength: 34 maxLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Trunk that owns the Origination URL + description: The SID of the Trunk that owns the Origination URL. weight: type: integer nullable: true - description: The value that determines the relative load the URI should - receive compared to others with the same priority + description: The value that determines the relative share of the load the + URI should receive compared to other URIs with the same priority. Can + be an integer from 1 to 65535, inclusive, and the default is 10. URLs + with higher values receive more load than those with lower ones with the + same priority. enabled: type: boolean nullable: true - description: Whether the URL is enabled + description: Whether the URL is enabled. The default is `true`. sip_url: type: string format: uri nullable: true description: The SIP address you want Twilio to route your Origination calls - to + to. This must be a `sip:` schema. 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. priority: type: integer nullable: true - description: The relative importance of the URI + description: The relative importance of the URI. Can be an integer from + 0 to 65535, inclusive, and the default is 10. The lowest number represents + the most important URI. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. trunking.v1.trunk.phone_number: type: object properties: @@ -160,58 +174,67 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the PhoneNumber resource. address_requirements: type: string $ref: '#/components/schemas/phone_number_enum_address_requirement' nullable: true - description: Whether the phone number requires an Address registered with - Twilio + description: 'Whether the phone number requires an [Address](https://www.twilio.com/docs/usage/api/address) + registered with Twilio and, if so, what type. Can be: `none`, `any`, `local`, + or `foreign`.' api_version: type: string nullable: true - description: The API version used to start a new TwiML session + description: The API version used to start a new TwiML session. beta: type: boolean nullable: true - description: Whether the phone number is new to the Twilio platform + description: 'Whether the phone number is new to the Twilio platform. Can + be: `true` or `false`.' capabilities: type: object format: string-map nullable: true - description: Indicate if a phone can receive calls or messages + 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`.' date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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 + description: The string that you assigned to describe the resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. phone_number: type: string format: phone-number nullable: true - description: The phone number in E.164 format + 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. sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the PhoneNumber + resource. sms_application_sid: type: string minLength: 34 @@ -219,7 +242,8 @@ components: pattern: ^AP[0-9a-fA-F]{32}$ nullable: true description: The SID of the application that handles SMS messages sent to - the phone number + the phone number. If an `sms_application_sid` is present, we ignore all + `sms_*_url` values and use those of the application. sms_fallback_method: type: string format: http-method @@ -231,13 +255,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with sms_fallback_url + description: 'The HTTP method we use to call `sms_fallback_url`. Can be: + `GET` or `POST`.' sms_fallback_url: type: string format: uri nullable: true - description: The URL that we call when an error occurs while retrieving - or executing the TwiML + description: The URL that we call using the `sms_fallback_method` when an + error occurs while retrieving or executing the TwiML from `sms_url`. sms_method: type: string format: http-method @@ -249,18 +274,20 @@ components: - PUT - DELETE nullable: true - description: The HTTP method to use with sms_url + description: 'The HTTP method we use to call `sms_url`. Can be: `GET` or + `POST`.' sms_url: type: string format: uri nullable: true - description: The URL we call when the phone number receives an incoming - SMS message + description: The URL we call using the `sms_method` when the phone number + receives an incoming SMS message. status_callback: type: string format: uri nullable: true - description: The URL to send status information to your application + description: The URL we call using the `status_callback_method` to send + status information to your application. status_callback_method: type: string format: http-method @@ -272,19 +299,23 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call status_callback + description: 'The HTTP method we use to call `status_callback`. Can be: + `GET` or `POST`.' trunk_sid: type: string minLength: 34 maxLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Trunk that handles calls to the phone number + description: The SID of the Trunk that handles calls to the phone number. + If a `trunk_sid` is present, we ignore all of the voice URLs and voice + applications and use those set on the Trunk. Setting a `trunk_sid` will + automatically delete your `voice_application_sid` and vice versa. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. voice_application_sid: type: string minLength: 34 @@ -292,11 +323,14 @@ components: pattern: ^AP[0-9a-fA-F]{32}$ nullable: true description: The SID of the application that handles calls to the phone - number + number. If a `voice_application_sid` is present, we ignore all of the + voice URLs and use those set on the application. Setting a `voice_application_sid` + will automatically delete your `trunk_sid` and vice versa. voice_caller_id_lookup: type: boolean nullable: true - description: Whether to lookup the caller's name + description: 'Whether we look up the caller''s caller-ID name from the CNAM + database ($0.01 per look up). Can be: `true` or `false`.' voice_fallback_method: type: string format: http-method @@ -308,12 +342,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method that we use to call voice_fallback_url + description: 'The HTTP method that we use to call `voice_fallback_url`. + Can be: `GET` or `POST`.' voice_fallback_url: type: string format: uri nullable: true - description: The URL we call when an error occurs in TwiML + description: The URL that we call using the `voice_fallback_method` when + an error occurs retrieving or executing the TwiML requested by `url`. voice_method: type: string format: http-method @@ -325,12 +361,15 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with the voice_url + description: 'The HTTP method we use to call `voice_url`. Can be: `GET` + or `POST`.' voice_url: type: string format: uri nullable: true - description: The URL we call when the phone number receives a call + description: The URL we call using the `voice_method` when the phone number + receives a call. The `voice_url` is not be used if a `voice_application_sid` + or a `trunk_sid` is set. phone_number_enum_address_requirement: type: string enum: @@ -345,12 +384,15 @@ components: type: string $ref: '#/components/schemas/recording_enum_recording_mode' nullable: true - description: The recording mode for the trunk. + description: The recording mode for the trunk. Can be do-not-record (default), + record-from-ringing, record-from-answer, record-from-ringing-dual, or + record-from-answer-dual. trim: type: string $ref: '#/components/schemas/recording_enum_recording_trim' nullable: true - description: The recording trim setting for the trunk. + description: The recording trim setting for the trunk. Can be do-not-trim + (default) or trim-silence. recording_enum_recording_mode: type: string enum: @@ -373,12 +415,15 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Trunk resource. domain_name: type: string nullable: true description: The unique address you reserve on Twilio to which you route - your SIP traffic + your SIP traffic. Domain names can contain letters, digits, and `-` and + must end with `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) + for more information. disaster_recovery_method: type: string format: http-method @@ -390,76 +435,100 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call the disaster_recovery_url + description: 'The HTTP method we use to call the `disaster_recovery_url`. + Can be: `GET` or `POST`.' disaster_recovery_url: type: string format: uri nullable: true - description: The HTTP URL that we call if an error occurs while sending - SIP traffic towards your configured Origination URL + 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. 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. secure: type: boolean nullable: true - description: Whether Secure Trunking is enabled for the trunk + description: Whether Secure Trunking is enabled for the trunk. If enabled, + all calls going through the trunk will be secure using SRTP for media + and TLS for signaling. If disabled, then RTP will be used for media. See + [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) + for more information. recording: nullable: true - description: The recording settings for the trunk + description: 'The recording settings for the trunk. Can be: `do-not-record`, + `record-from-ringing`, `record-from-answer`. If set to `record-from-ringing` + or `record-from-answer`, all calls going through the trunk will be recorded. + The only way to change recording parameters is on a sub-resource of a + Trunk after it has been created. e.g.`/Trunks/[Trunk_SID]/Recording -XPOST + -d''Mode=record-from-answer''`. See [Recording](https://www.twilio.com/docs/sip-trunking#recording) + for more information.' transfer_mode: type: string $ref: '#/components/schemas/trunk_enum_transfer_setting' nullable: true - description: The call transfer settings for the trunk + description: 'The call transfer settings for the trunk. Can be: `enable-all`, + `sip-only` and `disable-all`. See [Transfer](https://www.twilio.com/docs/sip-trunking/call-transfer) + for more information.' transfer_caller_id: type: string $ref: '#/components/schemas/trunk_enum_transfer_caller_id' nullable: true - description: Caller Id for transfer target + description: 'Caller Id for transfer target. Can be: `from-transferee` (default) + or `from-transferor`.' cnam_lookup_enabled: type: boolean nullable: true - description: Whether Caller ID Name (CNAM) lookup is enabled for the trunk + description: Whether Caller ID Name (CNAM) lookup is enabled for the trunk. + If enabled, all inbound calls to the SIP Trunk from the United States + and Canada automatically perform a CNAM Lookup and display Caller ID data + on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) + for more information. auth_type: type: string nullable: true - description: The types of authentication mapped to the domain + description: 'The types of authentication mapped to the domain. Can be: + `IP_ACL` and `CREDENTIAL_LIST`. If both are mapped, the values are returned + in a comma delimited list. If empty, the domain will not receive any traffic.' auth_type_set: type: array items: type: string nullable: true - description: Reserved + description: Reserved. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. sid: type: string minLength: 34 maxLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Trunk resource. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. trunk_enum_transfer_setting: type: string enum: diff --git a/spec/yaml/twilio_trusthub_v1.yaml b/spec/yaml/twilio_trusthub_v1.yaml index 89493135..e478e07b 100644 --- a/spec/yaml/twilio_trusthub_v1.yaml +++ b/spec/yaml/twilio_trusthub_v1.yaml @@ -9,40 +9,44 @@ components: maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource. + description: The unique string that we created to identify the Customer-Profile + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Customer-Profile resource. policy_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true - description: The unique string of a policy. + description: The unique string of a policy that is associated to the Customer-Profile + resource. 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. status: type: string $ref: '#/components/schemas/customer_profile_enum_status' nullable: true - description: The verification status of the Customer-Profile resource + description: The verification status of the Customer-Profile resource. valid_until: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource will be - valid until. + description: The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format when the resource will be valid until. email: type: string nullable: true - description: The email address + description: The email address that will receive updates when the Customer-Profile + resource changes status. status_callback: type: string format: uri @@ -52,23 +56,24 @@ components: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 Customer-Profile resource + description: The absolute URL of the Customer-Profile resource. links: type: object format: uri-map nullable: true - description: The URLs of the Assigned Items of the Customer-Profile resource + description: The URLs of the Assigned Items of the Customer-Profile resource. customer_profile_enum_status: type: string enum: @@ -91,42 +96,46 @@ components: maxLength: 34 pattern: ^RA[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Item Assignment + resource. customer_profile_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the CustomerProfile resource. + description: The unique string that we created to identify the CustomerProfile + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Item Assignment resource. channel_endpoint_type: type: string nullable: true - description: The type of channel endpoint + description: 'The type of channel endpoint. eg: phone-number' channel_endpoint_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The sid of an channel endpoint + description: The SID of an channel endpoint date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 + description: The absolute URL of the Identity resource. trusthub.v1.customer_profile.customer_profile_entity_assignment: type: object properties: @@ -136,38 +145,43 @@ components: maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Item Assignment + resource. customer_profile_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the CustomerProfile resource. + description: The unique string that we created to identify the CustomerProfile + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 + 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 ISO 8601 date and time in GMT when the resource was created + 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 + description: The absolute URL of the Identity resource. trusthub.v1.customer_profile.customer_profile_evaluation: type: object properties: @@ -177,38 +191,42 @@ components: maxLength: 34 pattern: ^EL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Evaluation resource + description: The unique string that identifies the Evaluation resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the customer_profile resource. policy_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true - description: The unique string of a policy + description: The unique string of a policy that is associated to the customer_profile + resource. customer_profile_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the customer_profile + resource. status: type: string $ref: '#/components/schemas/customer_profile_evaluation_enum_status' nullable: true - description: The compliance status of the Evaluation resource + description: The compliance status of the Evaluation resource. results: type: array items: {} nullable: true - description: The results of the Evaluation resource + description: The results of the Evaluation which includes the valid and + invalid attributes. date_created: type: string format: date-time @@ -231,41 +249,46 @@ components: maxLength: 34 pattern: ^IT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string created by Twilio to identify the End User + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the End User resource. 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. type: type: string nullable: true - description: The type of end user of the Bundle resource + description: The type of end user of the Bundle resource - can be `individual` + or `business`. attributes: nullable: true - description: The set of parameters that compose the End Users resource + description: The set of parameters that are the attributes of the End Users + resource which are listed in the End User Types. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 End User resource + description: The absolute URL of the End User resource. trusthub.v1.end_user_type: type: object properties: @@ -275,25 +298,30 @@ components: maxLength: 34 pattern: ^OY[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the End-User Type resource + description: The unique string that identifies the End-User Type resource. friendly_name: type: string nullable: true - description: A human-readable description of the End-User Type resource + description: A human-readable description that is assigned to describe the + End-User Type resource. Examples can include first name, last name, email, + business name, etc machine_name: type: string nullable: true - description: A machine-readable description of the End-User Type resource + description: A machine-readable description of the End-User Type resource. + Examples can include first_name, last_name, email, business_name, etc. fields: type: array items: {} nullable: true - description: The required information for creating an End-User. + description: The required information for creating an End-User. The required + fields will change as regulatory needs change and will differ for businesses + and individuals. url: type: string format: uri nullable: true - description: The absolute URL of the End-User Type resource + description: The absolute URL of the End-User Type resource. trusthub.v1.policies: type: object properties: @@ -303,19 +331,20 @@ components: maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Policy resource + description: The unique string that identifies the Policy resource. friendly_name: type: string nullable: true - description: A human-readable description of the Policy resource + description: A human-readable description that is assigned to describe the + Policy resource. Examples can include Primary Customer profile policy requirements: nullable: true - description: The sid of a Policy object that dictates requirements + description: The SID of an object that holds the policy information url: type: string format: uri nullable: true - description: The absolute URL of the Policy resource + description: The absolute URL of the Policy resource. policies_enum_end_user_type: type: string enum: @@ -330,51 +359,54 @@ components: maxLength: 34 pattern: ^RD[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string created by Twilio to identify the Supporting + Document resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Document resource. 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. mime_type: type: string nullable: true - description: The image type of the file + description: The image type uploaded in the Supporting Document container. status: type: string $ref: '#/components/schemas/supporting_document_enum_status' nullable: true - description: The verification status of the Supporting Document resource + description: The verification status of the Supporting Document resource. type: type: string nullable: true - description: The type of the Supporting Document + description: The type of the Supporting Document. attributes: nullable: true - description: The set of parameters that compose the Supporting Documents - resource + description: The set of parameters that are the attributes of the Supporting + Documents resource which are listed in the Supporting Document Types. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 Supporting Document resource + description: The absolute URL of the Supporting Document resource. supporting_document_enum_status: type: string enum: @@ -394,27 +426,29 @@ components: pattern: ^OY[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Supporting Document Type - resource + resource. friendly_name: type: string nullable: true description: A human-readable description of the Supporting Document Type - resource + resource. machine_name: type: string nullable: true description: The machine-readable description of the Supporting Document - Type resource + Type resource. fields: type: array items: {} nullable: true - description: The required information for creating a Supporting Document + description: The required information for creating a Supporting Document. + The required fields will change as regulatory needs change and will differ + for businesses and individuals. url: type: string format: uri nullable: true - description: The absolute URL of the Supporting Document Type resource + description: The absolute URL of the Supporting Document Type resource. trusthub.v1.trust_product: type: object properties: @@ -424,40 +458,44 @@ components: maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource. + description: The unique string that we created to identify the Customer-Profile + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Customer-Profile resource. policy_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true - description: The unique string of a policy. + description: The unique string of a policy that is associated to the Customer-Profile + resource. 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. status: type: string $ref: '#/components/schemas/trust_product_enum_status' nullable: true - description: The verification status of the Customer-Profile resource + description: The verification status of the Customer-Profile resource. valid_until: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource will be - valid until. + description: The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format when the resource will be valid until. email: type: string nullable: true - description: The email address + description: The email address that will receive updates when the Customer-Profile + resource changes status. status_callback: type: string format: uri @@ -467,23 +505,24 @@ components: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 Customer-Profile resource + description: The absolute URL of the Customer-Profile resource. links: type: object format: uri-map nullable: true - description: The URLs of the Assigned Items of the Customer-Profile resource + description: The URLs of the Assigned Items of the Customer-Profile resource. trust_product_enum_status: type: string enum: @@ -506,42 +545,46 @@ components: maxLength: 34 pattern: ^RA[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Item Assignment + resource. trust_product_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the CustomerProfile resource. + description: The unique string that we created to identify the CustomerProfile + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Item Assignment resource. channel_endpoint_type: type: string nullable: true - description: The type of channel endpoint + description: 'The type of channel endpoint. eg: phone-number' channel_endpoint_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The sid of an channel endpoint + description: The SID of an channel endpoint date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 + description: The absolute URL of the Identity resource. trusthub.v1.trust_product.trust_product_entity_assignment: type: object properties: @@ -551,38 +594,43 @@ components: maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Item Assignment + resource. trust_product_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the TrustProduct resource. + description: The unique string that we created to identify the TrustProduct + resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + 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 + 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 ISO 8601 date and time in GMT when the resource was created + 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 + description: The absolute URL of the Identity resource. trusthub.v1.trust_product.trust_product_evaluation: type: object properties: @@ -592,38 +640,42 @@ components: maxLength: 34 pattern: ^EL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Evaluation resource + description: The unique string that identifies the Evaluation resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the trust_product resource. policy_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true - description: The unique string of a policy + description: The unique string of a policy that is associated to the trust_product + resource. trust_product_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the trust_product + resource. status: type: string $ref: '#/components/schemas/trust_product_evaluation_enum_status' nullable: true - description: The compliance status of the Evaluation resource + description: The compliance status of the Evaluation resource. results: type: array items: {} nullable: true - description: The results of the Evaluation resource + description: The results of the Evaluation which includes the valid and + invalid attributes. date_created: type: string format: date-time diff --git a/spec/yaml/twilio_verify_v2.yaml b/spec/yaml/twilio_verify_v2.yaml index ae203562..65a005c8 100644 --- a/spec/yaml/twilio_verify_v2.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -9,38 +9,41 @@ components: maxLength: 34 pattern: ^YK[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Access Token. + description: A 34 character string that uniquely identifies this Access + Token. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account Sid. + description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: Verify Service Sid. + description: The unique SID identifier of the Verify Service. entity_identity: type: string nullable: true - description: Unique external identifier of the Entity + description: The unique external identifier for the Entity of the Service. factor_type: type: string $ref: '#/components/schemas/access_token_enum_factor_types' nullable: true - description: The Type of the Factor + description: The Type of the Factor. Currently only `push` is supported. factor_friendly_name: type: string nullable: true - description: A human readable description of this factor. + description: A human readable description of this factor, up to 64 characters. + For a push factor, this can be the device's name. token: type: string nullable: true - description: Generated access token. + description: The access token generated for enrollment, this is an encrypted + json web token. url: type: string format: uri @@ -49,12 +52,13 @@ components: ttl: type: integer nullable: true - description: How long, in seconds, the access token is valid. + description: 'How long, in seconds, the access token is valid. Max: 5 minutes' date_created: type: string format: date-time nullable: true - description: The date this access token was created + description: The date that this access token was created, given in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format. access_token_enum_factor_types: type: string enum: @@ -68,32 +72,35 @@ components: maxLength: 34 pattern: ^BL[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Bucket. + description: A 34 character string that uniquely identifies this Bucket. rate_limit_sid: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ nullable: true - description: Rate Limit Sid. + description: The Twilio-provided string that uniquely identifies the Rate + Limit resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) + the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Rate Limit resource. max: type: integer nullable: true - description: Max number of requests. + description: Maximum number of requests permitted in during the interval. interval: type: integer nullable: true @@ -102,13 +109,14 @@ components: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri @@ -123,83 +131,101 @@ components: maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Challenge. + description: A 34 character string that uniquely identifies this Challenge. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account Sid. + description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: Service Sid. + description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true - description: Entity Sid. + description: The unique SID identifier of the Entity. identity: type: string nullable: true - description: Unique external identifier of the Entity + 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. factor_sid: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ nullable: true - description: Factor Sid. + description: The unique SID identifier of the Factor. date_created: type: string format: date-time nullable: true - description: The date this Challenge was created + description: The date that this Challenge was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. date_updated: type: string format: date-time nullable: true - description: The date this Challenge was updated + description: The date that this Challenge was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. date_responded: type: string format: date-time nullable: true - description: The date this Challenge was responded + description: The date that this Challenge was responded, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. expiration_date: type: string format: date-time nullable: true - description: The date-time when this Challenge expires + description: The date-time when this Challenge expires, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. The default value is five (5) minutes after Challenge creation. + The max value is sixty (60) minutes after creation. status: type: string $ref: '#/components/schemas/challenge_enum_challenge_statuses' nullable: true - description: The Status of this Challenge + description: The Status of this Challenge. One of `pending`, `expired`, + `approved` or `denied`. responded_reason: type: string $ref: '#/components/schemas/challenge_enum_challenge_reasons' nullable: true - description: The Reason of this Challenge `status` + description: Reason for the Challenge to be in certain `status`. One of + `none`, `not_needed` or `not_requested`. details: nullable: true - description: Details about the Challenge. + description: Details provided to give context about the Challenge. Intended + to be shown to the end user. hidden_details: nullable: true - description: Hidden details about the Challenge + 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"}`' metadata: nullable: true - description: Metadata of the challenge. + 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.' factor_type: type: string $ref: '#/components/schemas/challenge_enum_factor_types' nullable: true - description: The Factor Type of this Challenge + description: The Factor Type of this Challenge. Currently `push` and `totp` + are supported. url: type: string format: uri @@ -209,7 +235,8 @@ components: type: object format: uri-map nullable: true - description: Nested resource URLs. + description: Contains a dictionary of URL links to nested resources of this + Challenge. challenge_enum_challenge_statuses: type: string enum: @@ -242,35 +269,41 @@ components: maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Entity. + description: A 34 character string that uniquely identifies this Entity. identity: type: string nullable: true - description: Unique external identifier of the Entity + 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. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account Sid. + description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: Service Sid. + description: The unique SID identifier of the Service. date_created: type: string format: date-time nullable: true - description: The date this Entity was created + description: The date that this Entity was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. date_updated: type: string format: date-time nullable: true - description: The date this Entity was updated + description: The date that this Entity was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. url: type: string format: uri @@ -280,7 +313,8 @@ components: type: object format: uri-map nullable: true - description: Nested resource URLs. + description: Contains a dictionary of URL links to nested resources of this + Entity. verify.v2.service.entity.factor: type: object properties: @@ -290,62 +324,72 @@ components: maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Factor. + description: A 34 character string that uniquely identifies this Factor. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account Sid. + description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: Service Sid. + description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true - description: Entity Sid. + description: The unique SID identifier of the Entity. identity: type: string nullable: true - description: Unique external identifier of the Entity + 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. date_created: type: string format: date-time nullable: true - description: The date this Factor was created + description: The date that this Factor was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. date_updated: type: string format: date-time nullable: true - description: The date this Factor was updated + description: The date that this Factor was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. friendly_name: type: string nullable: true - description: A human readable description of this resource. + description: A human readable description of this resource, up to 64 characters. + For a push factor, this can be the device's name. status: type: string $ref: '#/components/schemas/factor_enum_factor_statuses' nullable: true - description: The Status of this Factor + description: The Status of this Factor. One of `unverified` or `verified`. factor_type: type: string $ref: '#/components/schemas/factor_enum_factor_types' nullable: true - description: The Type of this Factor + description: The Type of this Factor. Currently `push` and `totp` are supported. config: nullable: true - description: Configurations for a `factor_type`. + description: An object that contains configurations specific to a `factor_type`. metadata: nullable: true - description: Metadata of the factor. + 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.' url: type: string format: uri @@ -380,13 +424,16 @@ components: type: string $ref: '#/components/schemas/form_enum_form_types' nullable: true - description: The Type of this Form + description: The Type of this Form. Currently only `form-push` is supported. forms: nullable: true - description: Object that contains the available forms for this type. + description: Object that contains the available forms for this type. This + available forms are given in the standard [JSON Schema](https://json-schema.org/) + format form_meta: nullable: true description: Additional information for the available forms for this type. + E.g. The separator string used for `binding` in a Factor push. url: type: string format: uri @@ -405,36 +452,42 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Service resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) + that the resource is associated with. country: type: string nullable: true - description: The ISO-3166-1 country code of the country or `all`. + description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + country code of the country this configuration will be applied to. If + this is a global configuration, Country will take the value `all`. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Messaging Service used for this configuration. + 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. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri @@ -449,65 +502,86 @@ components: maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Factor. + description: A 34 character string that uniquely identifies this Factor. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account Sid. + description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: Service Sid. + description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true - description: Entity Sid. + description: The unique SID identifier of the Entity. identity: type: string nullable: true - description: Unique external identifier of the Entity + 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. binding: nullable: true - description: Binding of the factor + description: "Contains the `factor_type` specific secret and metadata.\n\ + For push, this is `binding.public_key` and `binding.alg`.\nFor totp, this\ + \ is `binding.secret` and `binding.uri`. The `binding.uri` property is\ + \ generated following the [google authenticator key URI format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format),\ + \ and `Factor.friendly_name` is used for the \u201Caccountname\u201D value\ + \ and `Service.friendly_name` or `Service.totp.issuer` is used for the\ + \ `issuer` value.\n\n\nThe Binding property is ONLY returned upon Factor\ + \ creation." date_created: type: string format: date-time nullable: true - description: The date this Factor was created + description: The date that this Factor was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. date_updated: type: string format: date-time nullable: true - description: The date this Factor was updated + description: The date that this Factor was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. friendly_name: type: string nullable: true - description: A human readable description of this resource. + description: "The friendly name of this Factor. This can be any string up\ + \ to 64 characters, meant for humans to distinguish between Factors.\n\ + For `factor_type` `push`, this could be a device name.\nFor `factor_type`\ + \ `totp`, this value is used as the \u201Caccount name\u201D in constructing\ + \ the `binding.uri` property.\nAt the same time, we recommend avoiding\ + \ providing PII." status: type: string $ref: '#/components/schemas/new_factor_enum_factor_statuses' nullable: true - description: The Status of this Factor + description: The Status of this Factor. One of `unverified` or `verified`. factor_type: type: string $ref: '#/components/schemas/new_factor_enum_factor_types' nullable: true - description: The Type of this Factor + description: The Type of this Factor. Currently `push` and `totp` are supported. config: nullable: true - description: Configurations for a `factor_type`. + description: An object that contains configurations specific to a `factor_type`. metadata: nullable: true - description: Metadata of the factor. + 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.' url: type: string format: uri @@ -544,52 +618,59 @@ components: maxLength: 34 pattern: ^NT[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Notification. + description: A 34 character string that uniquely identifies this Notification. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account Sid. + description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: Service Sid. + description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true - description: Entity Sid. + description: The unique SID identifier of the Entity. identity: type: string nullable: true - description: Unique external identifier of the Entity + 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. challenge_sid: type: string minLength: 34 maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ nullable: true - description: Challenge Sid. + description: The unique SID identifier of the Challenge. priority: type: string nullable: true - description: The priority of the notification. + description: The priority of the notification. For `push` Challenges it's + always `high` which sends the notification immediately, and can wake up + a sleeping device. ttl: type: integer nullable: true - description: How long, in seconds, the notification is valid. + description: 'How long, in seconds, the notification is valid. Max: 5 minutes' date_created: type: string format: date-time nullable: true - description: The date this Notification was created + description: The date that this Notification was created, given in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format. verify.v2.service.rate_limit: type: object properties: @@ -599,25 +680,29 @@ components: maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Rate Limit. + description: A 34 character string that uniquely identifies this Rate Limit. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) + the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Rate Limit resource. unique_name: type: string nullable: true - description: A unique, developer assigned name of this Rate Limit. + description: Provides a unique and addressable name to be assigned to this + Rate Limit, assigned by the developer, to be optionally used in addition + to SID. **This value should not contain PII.** description: type: string nullable: true @@ -626,13 +711,14 @@ components: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri @@ -642,7 +728,7 @@ components: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. verify.v2.safelist: type: object properties: @@ -652,7 +738,8 @@ components: maxLength: 34 pattern: ^GN[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource. + description: The unique string that we created to identify the SafeList + resource. phone_number: type: string nullable: true @@ -671,59 +758,69 @@ components: maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Service resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Service resource. friendly_name: type: string nullable: true - description: The string that you assigned to describe the verification service + description: The string that you assigned to describe the verification service. + **This value should not contain PII.** code_length: type: integer nullable: true - description: The length of the verification code + description: The length of the verification code to generate. lookup_enabled: type: boolean nullable: true - description: Whether to perform a lookup with each verification + description: Whether to perform a lookup with each verification started + and return info about the phone number. psd2_enabled: type: boolean nullable: true description: Whether to pass PSD2 transaction parameters when starting a - verification + verification. skip_sms_to_landlines: type: boolean nullable: true - description: Whether to skip sending SMS verifications to landlines + description: Whether to skip sending SMS verifications to landlines. Requires + `lookup_enabled`. dtmf_input_required: type: boolean nullable: true description: Whether to ask the user to press a number before delivering - the verify code in a phone call + the verify code in a phone call. tts_name: type: string nullable: true description: The name of an alternative text-to-speech service to use in - phone calls + phone calls. Applies only to TTS languages. do_not_share_warning_enabled: type: boolean nullable: true - description: Whether to add a security warning at the end of an SMS. + description: "Whether to add a security warning at the end of an SMS verification\ + \ body. Disabled by default and applies only to SMS. Example SMS body:\ + \ `Your AppName verification code is: 1234. Don\u2019t share this code\ + \ with anyone; our employees will never ask for the code`" custom_code_enabled: type: boolean nullable: true - description: Whether to allow sending verifications with a custom code. + description: Whether to allow sending verifications with a custom code instead + of a randomly generated one. Not available for all customers. push: nullable: true - description: The service level configuration of factor push type. + description: Configurations for the Push factors (channel) created under + this Service. totp: nullable: true - description: The service level configuration of factor TOTP type. + description: Configurations for the TOTP factors (channel) created under + this Service. default_template_sid: type: string minLength: 34 @@ -734,23 +831,24 @@ components: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. verify.v2.service.verification: type: object properties: @@ -760,73 +858,86 @@ components: maxLength: 34 pattern: ^VE[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Verification + resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) + the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Verification resource. to: type: string nullable: true - description: The phone number or email being verified + 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). channel: type: string $ref: '#/components/schemas/verification_enum_channel' nullable: true - description: The verification method used. + description: 'The verification method used. One of: [`email`](https://www.twilio.com/docs/verify/email), + `sms`, `whatsapp`, `call`, or `sna`.' status: type: string nullable: true - description: The status of the verification resource + description: 'The status of the verification. One of: `pending`, `approved`, + or `canceled`' valid: type: boolean nullable: true - description: Whether the verification was successful + description: Use "status" instead. Legacy property indicating whether the + verification was successful. lookup: nullable: true - description: Information about the phone number being verified + description: Information about the phone number being verified. amount: type: string nullable: true - description: The amount of the associated PSD2 compliant transaction. + description: The amount of the associated PSD2 compliant transaction. Requires + the PSD2 Service flag enabled. payee: type: string nullable: true - description: The payee of the associated PSD2 compliant transaction + description: The payee of the associated PSD2 compliant transaction. Requires + the PSD2 Service flag enabled. send_code_attempts: type: array items: {} nullable: true - description: An array of verification attempt objects. + description: An array of verification attempt objects containing the channel + attempted and the channel-specific transaction SID. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. sna: nullable: true - description: The set of fields used for a silent network auth (`sna`) verification + description: The set of fields used for a silent network auth (`sna`) verification. + Contains a single field with the URL to be invoked to verify the phone + number. url: type: string format: uri nullable: true - description: The absolute URL of the Verification resource + description: The absolute URL of the Verification resource. verification_enum_channel: type: string enum: @@ -849,51 +960,62 @@ components: maxLength: 34 pattern: ^VL[0-9a-fA-F]{32}$ nullable: true - description: The SID that uniquely identifies the verification attempt. + description: The SID that uniquely identifies the verification attempt resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the verification. + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Verification resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the verify service that generated this attempt. + description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) + used to generate the attempt. verification_sid: type: string minLength: 34 maxLength: 34 pattern: ^VE[0-9a-fA-F]{32}$ nullable: true - description: The SID of the verification that generated this attempt. + description: The SID of the [Verification](https://www.twilio.com/docs/verify/api/verification) + that generated the attempt. date_created: type: string format: date-time nullable: true - description: The date this Attempt was created + description: The date that this Attempt was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. date_updated: type: string format: date-time nullable: true - description: The date this Attempt was updated + description: The date that this Attempt was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. conversion_status: type: string $ref: '#/components/schemas/verification_attempt_enum_conversion_status' nullable: true - description: Status of the conversion for the verification. + description: A string specifying the conversion status of the verification. + A conversion happens when the user is able to provide the correct code. + Possible values are `CONVERTED` and `UNCONVERTED`. channel: type: string $ref: '#/components/schemas/verification_attempt_enum_channels' nullable: true - description: Communication channel used for the attempt. + description: A string specifying the communication channel used for the + verification attempt. i.e SMS, CALL, etc. price: nullable: true - description: An object containing the charge for this verification attempt. + 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). channel_data: nullable: true description: An object containing the channel specific information for an @@ -953,19 +1075,22 @@ components: total_attempts: type: integer nullable: true - description: Total of attempts made. + description: Total of attempts made according to the provided filters total_converted: type: integer nullable: true - description: Total of attempts confirmed by the end user. + description: Total of attempts made that were confirmed by the end user, + according to the provided filters. total_unconverted: type: integer nullable: true - description: Total of attempts made that were not confirmed by the end user. + description: Total of attempts made that were not confirmed by the end user, + according to the provided filters. conversion_rate_percentage: type: number nullable: true - description: Percentage of the confirmed messages over the total. + description: 'Percentage of the confirmed messages over the total, defined + by (total_converted/total_attempts)*100. ' url: type: string format: uri @@ -986,64 +1111,75 @@ components: maxLength: 34 pattern: ^VE[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the VerificationCheck + resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Service that the resource is associated with + description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) + the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the VerificationCheck resource. to: type: string nullable: true - description: The phone number or email being verified + 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). channel: type: string $ref: '#/components/schemas/verification_check_enum_channel' nullable: true - description: The verification method to use + description: 'The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), + `sms`, `whatsapp`, `call`, or `sna`.' status: type: string nullable: true - description: The status of the verification resource + description: 'The status of the verification. Can be: `pending`, `approved`, + or `canceled`.' valid: type: boolean nullable: true - description: Whether the verification was successful + description: Use "status" instead. Legacy property indicating whether the + verification was successful. amount: type: string nullable: true - description: The amount of the associated PSD2 compliant transaction. + description: The amount of the associated PSD2 compliant transaction. Requires + the PSD2 Service flag enabled. payee: type: string nullable: true - description: The payee of the associated PSD2 compliant transaction + description: The payee of the associated PSD2 compliant transaction. Requires + the PSD2 Service flag enabled. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Verification Check - resource was created + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the Verification Check resource was created. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Verification Check - resource was last updated + description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date + and time in GMT when the Verification Check resource was last updated. sna_attempts_error_codes: type: array items: {} nullable: true description: List of error codes as a result of attempting a verification - using the `sna` channel. + using the `sna` channel. The error codes are chronologically ordered, + from the first attempt to the latest attempt. This will be an empty list + if no errors occured or `null` if the last channel used wasn't `sna`. verification_check_enum_channel: type: string enum: @@ -1061,27 +1197,32 @@ components: maxLength: 34 pattern: ^HJ[0-9a-fA-F]{32}$ nullable: true - description: A string that uniquely identifies this Template + description: A 34 character string that uniquely identifies a Verification + Template. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: Account Sid + description: The unique SID identifier of the Account. friendly_name: type: string nullable: true - description: A string to describe the verification template + description: A descriptive string that you create to describe a Template. channels: type: array items: type: string nullable: true - description: A list of channels that support the Template + description: 'A list of channels that support the Template. Can include: + sms, voice' translations: nullable: true - description: Object with the template translations. + description: An object that contains the different translations of the template. + Every translation is identified by the language short name and contains + its respective information as the approval status, text and created/modified + date. verify.v2.service.webhook: type: object properties: @@ -1091,41 +1232,47 @@ components: maxLength: 34 pattern: ^YW[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Webhook resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true - description: Service Sid. + description: The unique SID identifier of the Service. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Service resource. friendly_name: type: string nullable: true - description: The string that you assigned to describe the webhook + description: The string that you assigned to describe the webhook. **This + value should not contain PII.** event_types: type: array items: type: string nullable: true - description: The array of events that this Webhook is subscribed to. + description: 'The array of events that this Webhook is subscribed to. Possible + event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, + challenge.denied`' status: type: string $ref: '#/components/schemas/webhook_enum_status' nullable: true - description: The webhook status + description: 'The webhook status. Default value is `enabled`. One of: `enabled` + or `disabled`' version: type: string $ref: '#/components/schemas/webhook_enum_version' nullable: true - description: The webhook version + 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. webhook_url: type: string format: uri @@ -1135,23 +1282,24 @@ components: type: string $ref: '#/components/schemas/webhook_enum_methods' nullable: true - description: The method used when calling the webhook's URL. + description: The method to be used when calling the webhook's URL. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 Webhook resource + description: The absolute URL of the Webhook resource. webhook_enum_status: type: string enum: diff --git a/spec/yaml/twilio_video_v1.yaml b/spec/yaml/twilio_video_v1.yaml index 7ee1d22b..80453689 100644 --- a/spec/yaml/twilio_video_v1.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -9,35 +9,48 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Composition resource. status: type: string $ref: '#/components/schemas/composition_enum_status' nullable: true - description: The status of the composition + description: 'The status of the composition. Can be: `enqueued`, `processing`, + `completed`, `deleted` or `failed`. `enqueued` is the initial state and + indicates that the composition request has been received and is scheduled + for processing; `processing` indicates the composition is being processed; + `completed` indicates the composition has been completed and is available + for download; `deleted` means the composition media has been deleted from + the system, but its metadata is still available for 30 days; `failed` + indicates the composition failed to execute the media processing task.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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_completed: type: string format: date-time nullable: true - description: Date when the media processing task finished + description: The date and time in GMT when the composition's media processing + task finished, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. date_deleted: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the composition generated - media was deleted + description: The date and time in GMT when the composition generated media + was deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. sid: type: string minLength: 34 maxLength: 34 pattern: ^CJ[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Composition + resource. room_sid: type: string minLength: 34 @@ -45,62 +58,83 @@ components: pattern: ^RM[0-9a-fA-F]{32}$ nullable: true description: The SID of the Group Room that generated the audio and video - tracks used in the composition + tracks used in the composition. All media sources included in a composition + must belong to the same Group Room. audio_sources: type: array items: type: string nullable: true - description: The array of track names to include in the composition + 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`. audio_sources_excluded: type: array items: type: string nullable: true - description: The array of track names to exclude from the composition + 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. 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. resolution: type: string nullable: true description: The dimensions of the video image in pixels expressed as columns - (width) and rows (height) + (width) and rows (height). The string's format is `{width}x{height}`, + such as `640x480`. trim: type: boolean nullable: true - description: Whether to remove intervals with no media + description: Whether to remove intervals with no media, as specified in + the POST request that created the composition. Compositions with `trim` + enabled are shorter when the Room is created and no Participant joins + for a while as well as if all the Participants leave the room and join + later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + for more info. format: type: string $ref: '#/components/schemas/composition_enum_format' nullable: true description: The container format of the composition's media files as specified - in the POST request that created the Composition resource + in the POST request that created the Composition resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) + for more information. bitrate: type: integer nullable: true - description: The average bit rate of the composition's media + description: The average bit rate of the composition's media. size: type: integer format: int64 nullable: true - description: The size of the composed media file in bytes + description: The size of the composed media file in bytes. duration: type: integer nullable: true - description: The duration of the composition's media file in seconds + description: The duration of the composition's media file in seconds. media_external_location: type: string format: uri nullable: true description: The URL of the media file associated with the composition when - stored externally + stored externally. See [External S3 Compositions](/docs/video/api/external-s3-compositions) + for more details. status_callback: type: string format: uri nullable: true - description: The URL called to send status information on every composition - event. + description: The URL called using the `status_callback_method` to send status + information on every composition event. status_callback_method: type: string format: http-method @@ -112,17 +146,18 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used to call `status_callback` + description: 'The HTTP method used to call `status_callback`. Can be: `POST` + or `GET`, defaults to `POST`.' url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URL of the media file associated with the composition + description: The URL of the media file associated with the composition. composition_enum_status: type: string enum: @@ -145,70 +180,101 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the CompositionHook resource. 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. Can + be up to 100 characters long and must be unique within the account. enabled: type: boolean nullable: true - description: Whether the CompositionHook is active + description: Whether the CompositionHook is active. When `true`, the CompositionHook + is triggered for every completed Group Room on the account. When `false`, + the CompositionHook is never triggered. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. sid: type: string minLength: 34 maxLength: 34 pattern: ^HK[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the CompositionHook + resource. audio_sources: type: array items: type: string nullable: true description: The array of track names to include in the compositions created - by the composition hook + 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 audio_sources_excluded: type: array items: type: string nullable: true description: The array of track names to exclude from the compositions created - by the composition hook + 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. video_layout: nullable: true - description: A JSON object that describes the video layout of the Composition + 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 resolution: type: string nullable: true description: The dimensions of the video image in pixels expressed as columns - (width) and rows (height) + (width) and rows (height). The string's format is `{width}x{height}`, + such as `640x480`. trim: type: boolean nullable: true - description: Whether intervals with no media are clipped + description: Whether intervals with no media are clipped, as specified in + the POST request that created the CompositionHook resource. Compositions + with `trim` enabled are shorter when the Room is created and no Participant + joins for a while as well as if all the Participants leave the room and + join later, because those gaps will be removed. See [Specifying Video + Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + for more info. format: type: string $ref: '#/components/schemas/composition_hook_enum_format' nullable: true description: The container format of the media files used by the compositions - created by the composition hook + created by the composition hook. If `mp4` or `webm`, `audio_sources` must + have one or more tracks and/or a `video_layout` element must contain a + valid `video_sources` list, otherwise an error occurs. status_callback: type: string format: uri nullable: true - description: The URL to send status information to your application + description: The URL we call using the `status_callback_method` to send + status information to your application. status_callback_method: type: string format: http-method @@ -220,12 +286,13 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we should use to call status_callback + description: The HTTP method we should use to call `status_callback`. Can + be `POST` or `GET` and defaults to `POST`. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. composition_hook_enum_format: type: string enum: @@ -240,43 +307,51 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the CompositionSettings resource. 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 and that + will be shown in the console aws_credentials_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the stored Credential resource + description: The SID of the stored Credential resource. aws_s3_url: type: string format: uri nullable: true - description: The URL of the AWS S3 bucket where the compositions are stored + 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. aws_storage_enabled: type: boolean nullable: true - description: Whether all compositions are written to the aws_s3_url + description: Whether all compositions are written to the `aws_s3_url`. When + `false`, all compositions are stored in our cloud. encryption_key_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Public Key resource used for encryption + description: The SID of the Public Key resource used for encryption. encryption_enabled: type: boolean nullable: true - description: Whether all compositions are stored in an encrypted form + description: Whether all compositions are stored in an encrypted form. The + default is `false`. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. video.v1.recording: type: object properties: @@ -286,86 +361,102 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Recording resource. status: type: string $ref: '#/components/schemas/recording_enum_status' nullable: true - description: The status of the recording + description: 'The status of the recording. Can be: `processing`, `completed`, + or `deleted`. `processing` indicates the recording is still being captured; + `completed` indicates the recording has been captured and is now available + for download. `deleted` means the recording media has been deleted from + the system, but its metadata is still available.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. sid: type: string minLength: 34 maxLength: 34 pattern: ^RT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Recording + resource. source_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the recording source + description: The SID of the recording source. For a Room Recording, this + value is a `track_sid`. size: type: integer format: int64 nullable: true - description: The size of the recorded track, in bytes + description: The size of the recorded track, in bytes. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. type: type: string $ref: '#/components/schemas/recording_enum_type' nullable: true - description: The recording's media type + description: 'The recording''s media type. Can be: `audio` or `video`.' duration: type: integer nullable: true - description: The duration of the recording in seconds + description: The duration of the recording in seconds rounded to the nearest + second. Sub-second tracks have a `Duration` property of 1 second container_format: type: string $ref: '#/components/schemas/recording_enum_format' nullable: true - description: The file format for the recording + description: 'The file format for the recording. Can be: `mka` or `mkv`. + Video Room recordings are captured in [Matroska container format](https://matroska.org/), + `mka` is for audio files and `mkv` for video files.' codec: type: string $ref: '#/components/schemas/recording_enum_codec' nullable: true - description: The codec used to encode the track + description: 'The codec used to encode the track. Can be: `VP8`, `H264`, + `OPUS`, and `PCMU`.' grouping_sids: nullable: true - description: A list of SIDs related to the recording + description: A list of SIDs related to the recording. Includes the `room_sid` + and `participant_sid`. track_name: type: string nullable: true - description: The name that was given to the source track of the recording + description: The name that was given to the source track of the recording. + If no name is given, the `source_sid` is used. offset: type: integer format: int64 nullable: true - description: The number of milliseconds between a point in time that is - common to all rooms in a group and when the source room of the recording - started + description: The time in milliseconds elapsed between an arbitrary point + in time, common to all group rooms, and the moment when the source room + of this track started. This information provides a synchronization mechanism + for recordings belonging to the same room. media_external_location: type: string format: uri nullable: true description: The URL of the media file associated with the recording when - stored externally + stored externally. See [External S3 Recordings](/docs/video/api/external-s3-recordings) + for more details. status_callback: type: string format: uri nullable: true - description: The URL called to send status information on every recording - event. + description: The URL called using the `status_callback_method` to send status + information on every recording event. status_callback_method: type: string format: http-method @@ -377,12 +468,13 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used to call `status_callback` + description: 'The HTTP method used to call `status_callback`. Can be: `POST` + or `GET`, defaults to `POST`.' links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. recording_enum_status: type: string enum: @@ -417,43 +509,51 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the RecordingSettings resource. 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 and show + the user in the console aws_credentials_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the stored Credential resource + description: The SID of the stored Credential resource. aws_s3_url: type: string format: uri nullable: true - description: The URL of the AWS S3 bucket where the recordings are stored + 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. aws_storage_enabled: type: boolean nullable: true - description: Whether all recordings are written to the aws_s3_url + description: Whether all recordings are written to the `aws_s3_url`. When + `false`, all recordings are stored in our cloud. encryption_key_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Public Key resource used for encryption + description: The SID of the Public Key resource used for encryption. encryption_enabled: type: boolean nullable: true - description: Whether all recordings are stored in an encrypted form + description: Whether all recordings are stored in an encrypted form. The + default is `false`. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. video.v1.room: type: object properties: @@ -463,44 +563,56 @@ components: maxLength: 34 pattern: ^RM[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Room resource. status: type: string $ref: '#/components/schemas/room_enum_room_status' nullable: true - description: The status of the room + description: 'The status of the room. Can be: `in-progress`, `failed`, or + `completed`.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Room resource. enable_turn: type: boolean nullable: true - description: Enable Twilio's Network Traversal TURN service + description: Deprecated, now always considered to be true. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used as a `room_sid` in place of the resource's `sid` + in the URL to address the resource, assuming it does not contain any [reserved + characters](https://tools.ietf.org/html/rfc3986#section-2.2) that would + need to be URL encoded. This value is unique for `in-progress` rooms. + SDK clients can use this name to connect to the room. REST API clients + can use this name in place of the Room SID to interact with the room as + long as the room is `in-progress`. status_callback: type: string format: uri nullable: true - description: The URL to send status information to your application + description: The URL we call using the `status_callback_method` to send + status information to your application on every room event. See [Status + Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for + more info. status_callback_method: type: string format: http-method @@ -512,65 +624,80 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call status_callback + description: The HTTP method we use to call `status_callback`. Can be `POST` + or `GET` and defaults to `POST`. end_time: type: string format: date-time nullable: true - description: The UTC end time of the room in UTC ISO 8601 format + description: The UTC end time of the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) + format. duration: type: integer nullable: true - description: The duration of the room in seconds + description: The duration of the room in seconds. type: type: string $ref: '#/components/schemas/room_enum_room_type' nullable: true - description: The type of room + description: 'The type of room. Can be: `go`, `peer-to-peer`, `group-small`, + or `group`. The default value is `group`.' max_participants: type: integer nullable: true - description: The maximum number of concurrent Participants allowed in the - room + description: 'The maximum number of concurrent Participants allowed in the + room. ' max_participant_duration: type: integer nullable: true description: The maximum number of seconds a Participant can be connected - to the room + to the room. The maximum possible value is 86400 seconds (24 hours). The + default is 14400 seconds (4 hours). max_concurrent_published_tracks: type: integer nullable: true - description: The maximum number of published tracks allowed in the room - at the same time + description: The maximum number of published audio, video, and data tracks + all participants combined are allowed to publish in the room at the same + time. Check [Programmable Video Limits](https://www.twilio.com/docs/video/programmable-video-limits) + for more details. If it is set to 0 it means unconstrained. record_participants_on_connect: type: boolean nullable: true - description: Whether to start recording when Participants connect + description: Whether to start recording when Participants connect. ***This + feature is not available in `peer-to-peer` rooms.*** video_codecs: type: array items: type: string $ref: '#/components/schemas/room_enum_video_codec' nullable: true - description: An array of the video codecs that are supported when publishing - a track in the room + description: 'An array of the video codecs that are supported when publishing + a track in the room. Can be: `VP8` and `H264`. ***This feature is not + available in `peer-to-peer` rooms***' media_region: type: string nullable: true - description: The region for the media server in Group 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-address-whitelisting#media-servers). + ***This feature is not available in `peer-to-peer` rooms.***' audio_only: type: boolean nullable: true - description: Indicates whether the room will only contain audio track participants - for group rooms. + description: When set to true, indicates that the participants in the room + will only publish audio. No video tracks will be allowed. Group rooms + only. empty_room_timeout: type: integer nullable: true - description: The time a room will remain active after last participant leaves. + description: Specifies how long (in minutes) a room will remain active after + last participant leaves. Can be configured when creating a room via REST + API. For Ad-Hoc rooms this value cannot be changed. unused_room_timeout: type: integer nullable: true - description: The time a room will remain active when no one joins. + description: Specifies how long (in minutes) a room will remain active if + no one joins. Can be configured when creating a room via REST API. For + Ad-Hoc rooms this value cannot be changed. large_room: type: boolean nullable: true @@ -579,12 +706,12 @@ components: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. room_enum_room_status: type: string enum: @@ -612,66 +739,75 @@ components: maxLength: 34 pattern: ^PA[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the RoomParticipant + resource. room_sid: type: string minLength: 34 maxLength: 34 pattern: ^RM[0-9a-fA-F]{32}$ nullable: true - description: The SID of the participant's room + description: The SID of the participant's room. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the RoomParticipant resource. status: type: string $ref: '#/components/schemas/room_participant_enum_status' nullable: true - description: The status of the Participant + description: 'The status of the Participant. Can be: `connected` or `disconnected`.' identity: type: string nullable: true - description: The string that identifies the resource's User + description: 'The application-defined string that uniquely identifies the + resource''s User within a Room. If a client joins with an existing Identity, + the existing client is disconnected. See [access tokens](https://www.twilio.com/docs/video/tutorials/user-identity-access-tokens) + and [limits](https://www.twilio.com/docs/video/programmable-video-limits) + for more info. ' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. start_time: type: string format: date-time nullable: true - description: The time of participant connected to the room in ISO 8601 format + description: The time of participant connected to the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) + format. end_time: type: string format: date-time nullable: true description: The time when the participant disconnected from the room in - ISO 8601 format + [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. duration: type: integer nullable: true - description: Duration of time in seconds the participant was connected + description: The duration in seconds that the participant was `connected`. + Populated only after the participant is `disconnected`. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. room_participant_enum_status: type: string enum: @@ -686,64 +822,69 @@ components: maxLength: 34 pattern: ^PA[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the RoomParticipant + resource. room_sid: type: string minLength: 34 maxLength: 34 pattern: ^RM[0-9a-fA-F]{32}$ nullable: true - description: The SID of the participant's room + description: The SID of the participant's room. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the RoomParticipant resource. status: type: string $ref: '#/components/schemas/room_participant_anonymize_enum_status' nullable: true - description: The status of the Participant + description: 'The status of the Participant. Can be: `connected` or `disconnected`.' identity: type: string minLength: 34 maxLength: 34 pattern: ^PA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the participant + description: The SID of the participant. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. start_time: type: string format: date-time nullable: true - description: The time of participant connected to the room in ISO 8601 format + description: The time of participant connected to the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) + format. end_time: type: string format: date-time nullable: true description: The time when the participant disconnected from the room in - ISO 8601 format + [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format. duration: type: integer nullable: true - description: Duration of time in seconds the participant was connected + description: The duration in seconds that the participant was `connected`. + Populated only after the participant is `disconnected`. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. room_participant_anonymize_enum_status: type: string enum: @@ -758,50 +899,53 @@ components: maxLength: 34 pattern: ^MT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the RoomParticipantPublishedTrack + resource. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^PA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Participant resource with the published track + description: The SID of the Participant resource with the published track. room_sid: type: string minLength: 34 maxLength: 34 pattern: ^RM[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Room resource where the track is published + description: The SID of the Room resource where the track is published. name: type: string nullable: true - description: The track name + description: The track name. Must be no more than 128 characters, and be + unique among the participant's published tracks. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. enabled: type: boolean nullable: true - description: Whether the track is enabled + description: Whether the track is enabled. kind: type: string $ref: '#/components/schemas/room_participant_published_track_enum_kind' nullable: true - description: The track type + description: 'The track type. Can be: `audio`, `video` or `data`.' url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. room_participant_published_track_enum_kind: type: string enum: @@ -817,7 +961,7 @@ components: maxLength: 34 pattern: ^PA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Participant resource for the Subscribe Rules + description: The SID of the Participant resource for the Subscribe Rules. room_sid: type: string minLength: 34 @@ -845,18 +989,20 @@ components: type: string nullable: true description: A collection of Subscribe Rules that describe how to include - or exclude matching tracks + or exclude matching tracks. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) + section for further information. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. video.v1.room.room_participant.room_participant_subscribed_track: type: object properties: @@ -866,57 +1012,60 @@ components: maxLength: 34 pattern: ^MT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the RoomParticipantSubscribedTrack + resource. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^PA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the participant that subscribes to the track + description: The SID of the participant that subscribes to the track. publisher_sid: type: string minLength: 34 maxLength: 34 pattern: ^PA[0-9a-fA-F]{32}$ nullable: true - description: The SID of the participant that publishes the track + description: The SID of the participant that publishes the track. room_sid: type: string minLength: 34 maxLength: 34 pattern: ^RM[0-9a-fA-F]{32}$ nullable: true - description: The SID of the room where the track is published + description: The SID of the room where the track is published. name: type: string nullable: true - description: The track name + description: The track name. Must have no more than 128 characters and be + unique among the participant's published tracks. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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. enabled: type: boolean nullable: true - description: Whether the track is enabled + description: Whether the track is enabled. kind: type: string $ref: '#/components/schemas/room_participant_subscribed_track_enum_kind' nullable: true - description: The track type + description: 'The track type. Can be: `audio`, `video` or `data`.' url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. room_participant_subscribed_track_enum_kind: type: string enum: @@ -932,92 +1081,107 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the RoomRecording resource. status: type: string $ref: '#/components/schemas/room_recording_enum_status' nullable: true - description: The status of the recording + description: 'The status of the recording. Can be: `processing`, `completed`, + or `deleted`. `processing` indicates the Recording is still being captured. + `completed` indicates the Recording has been captured and is now available + for download. `deleted` means the recording media has been deleted from + the system, but its metadata is still available for historical purposes.' date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. sid: type: string minLength: 34 maxLength: 34 pattern: ^RT[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the RoomRecording + resource. source_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true - description: The SID of the recording source + description: The SID of the recording source. For a Room Recording, this + value is a `track_sid`. size: type: integer format: int64 nullable: true - description: The size of the recorded track in bytes + description: The size of the recorded track in bytes. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. type: type: string $ref: '#/components/schemas/room_recording_enum_type' nullable: true - description: The recording's media type + description: 'The recording''s media type. Can be: `audio` or `video`.' duration: type: integer nullable: true - description: The duration of the recording in seconds + description: The duration of the recording rounded to the nearest second. + Sub-second duration tracks have a `duration` of 1 second container_format: type: string $ref: '#/components/schemas/room_recording_enum_format' nullable: true - description: The file format for the recording + description: 'The file format for the recording. Can be: `mka` or `mkv`. + Video Room recordings are captured in [Matroska container format](https://matroska.org/), + `mka` is for audio files and `mkv` for video files.' codec: type: string $ref: '#/components/schemas/room_recording_enum_codec' nullable: true - description: The codec used for the recording + description: 'The codec used for the recording. Can be: `VP8` or `H264`.' grouping_sids: nullable: true - description: A list of SIDs related to the Recording + description: A list of SIDs related to the Recording. Includes the `room_sid` + and `participant_sid`. track_name: type: string nullable: true - description: The name that was given to the source track of the recording + description: The name that was given to the source track of the recording. + If no name is given, the `source_sid` is used. offset: type: integer format: int64 nullable: true - description: The number of milliseconds between a point in time that is - common to all rooms in a group and when the source room of the recording - started + description: The time in milliseconds elapsed between an arbitrary point + in time, common to all group rooms, and the moment when the source room + of this track started. This information provides a synchronization mechanism + for recordings belonging to the same room. media_external_location: type: string format: uri nullable: true description: The URL of the media file associated with the recording when - stored externally + stored externally. See [External S3 Recordings](/docs/video/api/external-s3-recordings) + for more details. room_sid: type: string minLength: 34 maxLength: 34 pattern: ^RM[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Room resource the recording is associated with + description: The SID of the Room resource the recording is associated with. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. room_recording_enum_status: type: string enum: @@ -1070,19 +1234,20 @@ components: kind: type: string nullable: true - description: A collection of recording Rules that describe how to include + description: A collection of Recording Rules that describe how to include or exclude matching tracks for recording date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + 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 ISO 8601 date and time in GMT when the resource was last - updated + 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 diff --git a/spec/yaml/twilio_voice_v1.yaml b/spec/yaml/twilio_voice_v1.yaml index 57dc377c..db9fdebc 100644 --- a/spec/yaml/twilio_voice_v1.yaml +++ b/spec/yaml/twilio_voice_v1.yaml @@ -7,19 +7,19 @@ components: type: string format: date nullable: true - description: date + description: The date sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true - description: sid + description: The call sid url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. voice.v1.byoc_trunk: type: object properties: @@ -29,23 +29,26 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the BYOC Trunk resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^BY[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that that we created to identify the BYOC + Trunk resource. 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. voice_url: type: string format: uri nullable: true - description: The URL we call when receiving a call + description: The URL we call using the `voice_method` when the BYOC Trunk + receives a call. voice_method: type: string format: http-method @@ -57,12 +60,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method to use with voice_url + description: 'The HTTP method we use to call `voice_url`. Can be: `GET` + or `POST`.' voice_fallback_url: type: string format: uri nullable: true - description: The URL we call when an error occurs while executing TwiML + description: The URL that we call when an error occurs while retrieving + or executing the TwiML requested from `voice_url`. voice_fallback_method: type: string format: http-method @@ -74,12 +79,14 @@ components: - PUT - DELETE nullable: true - description: The HTTP method used with voice_fallback_url + description: 'The HTTP method we use to call `voice_fallback_url`. Can be: + `GET` or `POST`.' status_callback_url: type: string format: uri nullable: true - description: The URL that we call with status updates + description: The URL that we call to pass status parameters (such as call + ended) to your application. status_callback_method: type: string format: http-method @@ -91,18 +98,24 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call status_callback_url + description: The HTTP method we use to call `status_callback_url`. Either + `GET` or `POST`. cnam_lookup_enabled: type: boolean nullable: true - description: Whether Caller ID Name (CNAM) lookup is enabled for the trunk + description: Whether Caller ID Name (CNAM) lookup is enabled for the trunk. + If enabled, all inbound calls to the BYOC Trunk from the United States + and Canada automatically perform a CNAM Lookup and display Caller ID data + on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) + for more information. connection_policy_sid: type: string minLength: 34 maxLength: 34 pattern: ^NY[0-9a-fA-F]{32}$ nullable: true - description: Origination Connection Policy (to your Carrier) + description: The SID of the Connection Policy that Twilio will use when + routing traffic to your communications infrastructure. from_domain_sid: type: string minLength: 34 @@ -110,23 +123,28 @@ components: pattern: ^SD[0-9a-fA-F]{32}$ nullable: true description: The SID of the SIP Domain that should be used in the `From` - header of originating calls + 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". date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. voice.v1.connection_policy: type: object properties: @@ -136,39 +154,42 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Connection Policy resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^NY[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Connection + Policy resource. 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. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of related resources + description: The URLs of related resources. voice.v1.connection_policy.connection_policy_target: type: object properties: @@ -178,59 +199,67 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Target resource. connection_policy_sid: type: string minLength: 34 maxLength: 34 pattern: ^NY[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Connection Policy that owns the Target + description: The SID of the Connection Policy that owns the Target. sid: type: string minLength: 34 maxLength: 34 pattern: ^NE[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Target resource. 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. target: type: string format: uri nullable: true - description: The SIP address you want Twilio to route your calls to + description: The SIP address you want Twilio to route your calls to. This + must be a `sip:` schema. `sips` is NOT supported. priority: type: integer nullable: true - description: The relative importance of the target + description: The relative importance of the target. Can be an integer from + 0 to 65535, inclusive, and the default is 10. The lowest number represents + the most important target. weight: type: integer nullable: true - description: The value that determines the relative load the Target should - receive compared to others with the same priority + description: The value that determines the relative share of the load the + Target should receive compared to other Targets with the same priority. + Can be an integer from 1 to 65535, inclusive, and the default is 10. Targets + with higher values receive more load than those with lower ones with the + same priority. enabled: type: boolean nullable: true - description: Whether the target is enabled + description: Whether the target is enabled. The default is `true`. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT when the resource was created + 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 RFC 2822 date and time in GMT when the resource was last - updated + 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. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. voice.v1.dialing_permissions: type: object properties: {} @@ -241,44 +270,51 @@ components: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). name: type: string nullable: true - description: The name of the country + description: The name of the country. continent: type: string nullable: true - description: The name of the continent in which the country is located + description: The name of the continent in which the country is located. country_codes: type: array items: type: string nullable: true - description: The E.164 assigned country codes(s) + description: The E.164 assigned [country codes(s)](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html) low_risk_numbers_enabled: type: boolean nullable: true - description: Whether dialing to low-risk numbers is enabled + description: Whether dialing to low-risk numbers is enabled. high_risk_special_numbers_enabled: type: boolean nullable: true - description: Whether dialing to high-risk special services numbers is enabled + description: Whether dialing to high-risk special services numbers is enabled. + These prefixes include number ranges allocated by the country and include + premium numbers, special services, shared cost, and others high_risk_tollfraud_numbers_enabled: type: boolean nullable: true - description: Whether dialing to high-risk toll fraud numbers is enabled, - else `false` + 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 url: type: string format: uri nullable: true - description: The absolute URL of this resource + description: The absolute URL of this resource. links: type: object format: uri-map nullable: true - description: A list of URLs related to this resource + description: A list of URLs related to this resource. voice.v1.dialing_permissions.dialing_permissions_country-instance: type: object properties: @@ -286,44 +322,51 @@ components: type: string format: iso-country-code nullable: true - description: The ISO country code + description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). name: type: string nullable: true - description: The name of the country + description: The name of the country. continent: type: string nullable: true - description: The name of the continent in which the country is located + description: The name of the continent in which the country is located. country_codes: type: array items: type: string nullable: true - description: The E.164 assigned country codes(s) + description: The E.164 assigned [country codes(s)](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html) low_risk_numbers_enabled: type: boolean nullable: true - description: Whether dialing to low-risk numbers is enabled + description: Whether dialing to low-risk numbers is enabled. high_risk_special_numbers_enabled: type: boolean nullable: true - description: Whether dialing to high-risk special services numbers is enabled + description: Whether dialing to high-risk special services numbers is enabled. + These prefixes include number ranges allocated by the country and include + premium numbers, special services, shared cost, and others high_risk_tollfraud_numbers_enabled: type: boolean nullable: true - description: Whether dialing to high-risk toll fraud numbers is enabled, - else `false` + 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 url: type: string format: uri nullable: true - description: The absolute URL of this resource + description: The absolute URL of this resource. links: type: object format: uri-map nullable: true - description: A list of URLs related to this resource + description: A list of URLs related to this resource. voice.v1.dialing_permissions.dialing_permissions_country_bulk_update: type: object properties: @@ -334,14 +377,21 @@ components: update_request: type: string nullable: true - description: A URL encoded JSON array of update objects + description: 'A bulk update request to change voice dialing country permissions + stored as a URL-encoded, JSON array of update objects. For example : `[ + { "iso_code": "GB", "low_risk_numbers_enabled": "true", "high_risk_special_numbers_enabled":"true", + "high_risk_tollfraud_numbers_enabled": "false" } ]`' voice.v1.dialing_permissions.dialing_permissions_country.dialing_permissions_hrs_prefixes: type: object properties: prefix: type: string nullable: true - description: A prefix that includes the E.164 assigned country code + description: A prefix is a contiguous number range for a block of E.164 + numbers that includes the E.164 assigned country code. For example, a + North American Numbering Plan prefix like `+1510720` written like `+1(510) + 720` matches all numbers inclusive from `+1(510) 720-0000` to `+1(510) + 720-9999`. voice.v1.dialing_permissions.dialing_permissions_settings: type: object properties: @@ -349,12 +399,12 @@ components: type: boolean nullable: true description: '`true` if the sub-account will inherit voice dialing permissions - from the Master Project; otherwise `false`' + from the Master Project; otherwise `false`.' url: type: string format: uri nullable: true - description: The absolute URL of this resource + description: The absolute URL of this resource. voice.v1.ip_record: type: object properties: @@ -364,18 +414,20 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the IP Record resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^IL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the IP Record + resource. 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. ip_address: type: string nullable: true @@ -390,18 +442,19 @@ components: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. voice.v1.source_ip_mapping: type: object properties: @@ -411,37 +464,40 @@ components: maxLength: 34 pattern: ^IB[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the IP Record + resource. ip_record_sid: type: string minLength: 34 maxLength: 34 pattern: ^IL[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies an IP Record + description: The Twilio-provided string that uniquely identifies the IP + Record resource to map from. sip_domain_sid: type: string minLength: 34 maxLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies a SIP Domain + description: The SID of the SIP Domain that the IP Record is mapped to. date_created: type: string format: date-time nullable: true - description: The RFC 2822 date and time in GMT that the resource was created + 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 RFC 2822 date and time in GMT that the resource was last - updated + 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. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. securitySchemes: accountSid_authToken: type: http diff --git a/spec/yaml/twilio_wireless_v1.yaml b/spec/yaml/twilio_wireless_v1.yaml index 7d432e2e..0689d585 100644 --- a/spec/yaml/twilio_wireless_v1.yaml +++ b/spec/yaml/twilio_wireless_v1.yaml @@ -9,18 +9,22 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the AccountUsageRecord resource. period: nullable: true - description: The time period for which usage is reported + description: The time period for which usage is reported. Contains `start` + and `end` properties that describe the period using GMT date-time values + specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) + format. commands: nullable: true description: An object that describes the aggregated Commands usage for - all SIMs during the specified period + all SIMs during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/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 + SIMs over the period. See [Data Usage Object](https://www.twilio.com/docs/wireless/api/account-usagerecord-resource#data-usage-object). account_usage_record_enum_granularity: type: string enum: @@ -36,66 +40,77 @@ components: maxLength: 34 pattern: ^DC[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the Command resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Command resource. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Sim resource that the Command was sent to or - from + description: The SID of the [Sim resource](https://www.twilio.com/docs/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 + 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. command_mode: type: string $ref: '#/components/schemas/command_enum_command_mode' nullable: true - description: The mode used to send the SMS message + description: 'The mode used to send the SMS message. Can be: `text` or `binary`. + The default SMS mode is `text`.' transport: type: string $ref: '#/components/schemas/command_enum_transport' nullable: true - description: The type of transport used + description: 'The type of transport used. Can be: `sms` or `ip`.' delivery_receipt_requested: type: boolean nullable: true - description: Whether to request a delivery receipt + description: Whether to request a delivery receipt. status: type: string $ref: '#/components/schemas/command_enum_status' nullable: true - description: The status of the Command + 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.' direction: type: string $ref: '#/components/schemas/command_enum_direction' nullable: true - description: The direction of the Command + description: The direction of the Command. Can be `to_sim` or `from_sim`. + The value of `to_sim` is synonymous with the term `mobile terminated`, + and `from_sim` is synonymous with the term `mobile originated`. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) + format. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was last - updated format + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) + format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. command_enum_direction: type: string enum: @@ -125,82 +140,91 @@ components: sid: type: string nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the DataSession + resource. sim_sid: type: string nullable: true - description: The SID of the Sim resource that the Data Session is for + description: The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) + that the Data Session is for. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the DataSession resource. radio_link: type: string nullable: true - description: The generation of wireless technology that the device was using + description: The generation of wireless technology that the device was using. operator_mcc: type: string nullable: true - description: The 'mobile country code' is the unique ID of the home country - where the Data Session took place + description: 'The ''mobile country code'' is the unique ID of the home country + where the Data Session took place. See: [MCC/MNC lookup](http://mcc-mnc.com/).' operator_mnc: type: string nullable: true description: The 'mobile network code' is the unique ID specific to the - mobile operator network where the Data Session took place + mobile operator network where the Data Session took place. operator_country: type: string nullable: true description: The three letter country code representing where the device's - Data Session took place + Data Session took place. This is determined by looking up the `operator_mcc`. operator_name: type: string nullable: true - description: The friendly name of the mobile operator network that the SIM-connected - device is attached to + 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`. cell_id: type: string nullable: true description: The unique ID of the cellular tower that the device was attached - to at the moment when the Data Session was last updated + to at the moment when the Data Session was last updated. cell_location_estimate: nullable: true - description: An object with the estimated location where the device's Data - Session took place + 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). ' packets_uploaded: type: integer nullable: true - description: The number of packets uploaded by the device between the start - time and when the Data Session was last updated + description: The number of packets uploaded by the device between the `start` + time and when the Data Session was last updated. packets_downloaded: type: integer nullable: true description: The number of packets downloaded by the device between the - start time and when the Data Session was last updated + `start` time and when the Data Session was last updated. last_updated: type: string format: date-time nullable: true description: The date that the resource was last updated, given as GMT in - ISO 8601 format + [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. start: type: string format: date-time nullable: true - description: The date that the Data Session started, given as GMT in ISO - 8601 format + description: The date that the Data Session started, given as GMT in [ISO + 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. end: type: string format: date-time nullable: true - description: The date that the record ended, given as GMT in ISO 8601 format + description: The date that the record ended, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) + format. imei: type: string nullable: true - description: The unique ID of the device using the SIM to connect + description: 'The ''international mobile equipment identity'' is the unique + ID of the device using the SIM to connect. An IMEI is a 15-digit string: + 14 digits for the device identifier plus a check digit calculated using + the Luhn formula.' wireless.v1.rate_plan: type: object properties: @@ -210,84 +234,96 @@ components: maxLength: 34 pattern: ^WP[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the resource + description: The unique string that we created to identify the RatePlan + resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the RatePlan resource. 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. data_enabled: type: boolean nullable: true - description: Whether SIMs can use GPRS/3G/4G/LTE data connectivity + description: Whether SIMs can use GPRS/3G/4G/LTE data connectivity. data_metering: type: string nullable: true - description: The model used to meter data usage + 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).' data_limit: type: integer nullable: true - description: The total data usage in Megabytes that the Network allows during - one month on the home network + description: The total data usage (download and upload combined) in Megabytes + that the Network allows during one month on the home network (T-Mobile + USA). The metering period begins the day of activation and ends on the + same day in the following month. Can be up to 2TB. messaging_enabled: type: boolean nullable: true - description: Whether SIMs can make, send, and receive SMS using Commands + description: Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/wireless/api/command-resource). voice_enabled: type: boolean nullable: true - description: Deprecated. Whether SIMs can make and receive voice calls + description: Deprecated. Whether SIMs can make and receive voice calls. national_roaming_enabled: type: boolean nullable: true description: Whether SIMs can roam on networks other than the home network - in the United States + (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming). national_roaming_data_limit: type: integer nullable: true - description: The total data usage in Megabytes that the Network allows during - one month on non-home networks in the United States + 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. international_roaming: type: array items: type: string nullable: true - description: The services that SIMs capable of using GPRS/3G/4G/LTE data - connectivity can use outside of the United States + description: 'The list of services that SIMs capable of using GPRS/3G/4G/LTE + data connectivity can use outside of the United States. Can contain: `data` + and `messaging`.' international_roaming_data_limit: type: integer nullable: true description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United - States + States. Can be up to 2TB. date_created: type: string format: date-time nullable: true - description: The date when the resource was created, given as GMT in ISO - 8601 format + description: The date and time in GMT when the resource was created specified + in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) + format. date_updated: type: string format: date-time nullable: true - description: The date when the resource was last updated, given as GMT in - ISO 8601 format + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) + format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. rate_plan_enum_data_limit_strategy: type: string enum: @@ -302,55 +338,65 @@ components: maxLength: 34 pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - description: The unique string that identifies the Sim resource + description: The unique string that we created to identify the Sim resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the - resource + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account to which the Sim resource belongs + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + to which the Sim resource belongs. rate_plan_sid: type: string minLength: 34 maxLength: 34 pattern: ^WP[0-9a-fA-F]{32}$ nullable: true - description: The SID of the RatePlan resource to which the Sim resource - is assigned. + description: The SID of the [RatePlan resource](https://www.twilio.com/docs/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. iccid: type: string nullable: true - description: The ICCID associated with the SIM + description: The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated + with the SIM. e_id: type: string nullable: true - description: Deprecated + description: Deprecated. status: type: string $ref: '#/components/schemas/sim_enum_status' nullable: true - description: The status of the Sim resource + 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.' reset_status: type: string $ref: '#/components/schemas/sim_enum_reset_status' nullable: true - description: The connectivity reset status of the SIM + description: 'The connectivity reset status of the SIM. Can be: null or + `resetting`. When a connectivity reset is initiated on a SIM, this property + is `resetting`. After the reset completes, it is null.' commands_callback_url: type: string format: uri nullable: true - description: The URL we call when the SIM originates a machine-to-machine - Command + 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. commands_callback_method: type: string format: http-method @@ -362,7 +408,8 @@ components: - PUT - DELETE nullable: true - description: The HTTP method we use to call commands_callback_url + description: 'The HTTP method we use to call `commands_callback_url`. Can + be: `POST` or `GET`. Default is `POST`.' sms_fallback_method: type: string format: http-method @@ -374,12 +421,12 @@ components: - PUT - DELETE nullable: true - description: Deprecated + description: Deprecated. sms_fallback_url: type: string format: uri nullable: true - description: Deprecated + description: Deprecated. sms_method: type: string format: http-method @@ -391,12 +438,12 @@ components: - PUT - DELETE nullable: true - description: Deprecated + description: Deprecated. sms_url: type: string format: uri nullable: true - description: Deprecated + description: Deprecated. voice_fallback_method: type: string format: http-method @@ -408,13 +455,15 @@ components: - PUT - DELETE nullable: true - description: Deprecated. The HTTP method we use to call voice_fallback_url + description: 'Deprecated. The HTTP method we use to call `voice_fallback_url`. + Can be: `GET` or `POST`. Default is `POST`.' voice_fallback_url: type: string format: uri nullable: true - description: Deprecated. The URL we call when an error occurs while retrieving - or executing the TwiML requested from voice_url + description: Deprecated. The URL we call using the `voice_fallback_method` + when an error occurs while retrieving or executing the TwiML requested + from `voice_url`. voice_method: type: string format: http-method @@ -426,38 +475,42 @@ components: - PUT - DELETE nullable: true - description: Deprecated. The HTTP method we use to call voice_url + description: 'Deprecated. The HTTP method we use to call `voice_url`. Can + be: `GET` or `POST`. Default is `POST`.' voice_url: type: string format: uri nullable: true - description: Deprecated. The URL we call when the SIM-connected device makes - a voice call + description: Deprecated. The URL we call using the `voice_method` when the + SIM-connected device makes a voice call. date_created: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the resource was created + description: The date and time in GMT when the resource was created specified + in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) + format. date_updated: type: string format: date-time nullable: true - description: The ISO 8601 date and time in GMT when the Sim resource was - last updated + description: The date and time in GMT when the Sim resource was last updated + specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) + format. url: type: string format: uri nullable: true - description: The absolute URL of the resource + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - description: The URLs of related subresources + description: The URLs of related subresources. ip_address: type: string nullable: true - description: Deprecated + description: Deprecated. sim_enum_status: type: string enum: @@ -479,25 +532,29 @@ components: sim_sid: type: string nullable: true - description: The SID of the Sim resource that this Usage Record is for + description: The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) + that this Usage Record is for. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Account that created the resource + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the UsageRecord resource. period: nullable: true - description: The time period for which the usage is reported + description: The time period for which the usage is reported. Contains `start` + and `end` datetime values given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) + format. commands: nullable: true description: An object that describes the SIM's usage of Commands during - the specified period + the specified period. See [Commands Usage Object](https://www.twilio.com/docs/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 + period. See [Data Usage Object](https://www.twilio.com/docs/wireless/api/sim-usagerecord-resource#data-usage-object). usage_record_enum_granularity: type: string enum: